| blob | 46588f07630cccb3a6da085ce71a3f66e3634688 |
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.
43 ;;;###tramp-autoload
45 "The minimum size of compressing where inline transfer.
46 When inline transfer, compress transferred data of file
47 whose size is this value or above (up to `tramp-copy-size-limit').
48 If it is nil, no compression at all will be applied."
52 ;;;###tramp-autoload
54 "The maximum file size where inline copying is preferred over an \
55 out-of-the-band copy.
56 If it is nil, out-of-the-band copy will be used without a check."
60 ;;;###tramp-autoload
62 "Value of TERM environment variable for logging in to remote host.
63 Because Tramp wants to parse the output of the remote shell, it is easily
64 confused by ANSI color escape sequences and suchlike. Often, shell init
65 files conditionalize this setup based on the TERM environment variable."
69 ;;;###tramp-autoload
71 "When invoking a shell, override the HISTFILE with this value.
72 When setting to a string, it redirects the shell history to that
76 The value t, the default value, unsets any setting of HISTFILE,
77 and sets both HISTFILESIZE and HISTSIZE to 0. If you set this
78 variable to nil, however, the *override* is disabled, so the
79 history will go to the default storage location,
87 ;;;###tramp-autoload
91 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
92 ;; root users. It uses the `$' character for other users. In order
93 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
97 "///%s#$"
99 "String used to recognize end of output.
100 The '$' character at the end is quoted; the string cannot be
103 ;;;###tramp-autoload
110 ;;;###tramp-autoload
112 "Whether to use `tramp-ssh-controlmaster-options'."
118 "Which ssh Control* arguments to use.
120 If it is a string, it should have the form
123 spec must be doubled, because the string is used as format string.
125 Otherwise, it will be auto-detected by Tramp, if
126 `tramp-use-ssh-controlmaster-options' is non-nil. The value
127 depends on the installed local ssh version.
131 ;; Initialize `tramp-methods' with the supported methods.
132 ;;;###tramp-autoload
143 ;;;###tramp-autoload
153 ;;;###tramp-autoload
170 ;;;###tramp-autoload
188 ;;;###tramp-autoload
203 ;;;###tramp-autoload
210 ;;;###tramp-autoload
217 ;;;###tramp-autoload
230 ;;;###tramp-autoload
243 ;;;###tramp-autoload
251 ;;;###tramp-autoload
259 ;; We use "-v" for better error tracking.
262 ;; We use "-p" as required for newer busyboxes. For older
263 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
264 ;; can be achieved by tweaking `tramp-connection-properties'.
267 ;;;###tramp-autoload
275 ;;;###tramp-autoload
280 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
285 ;;;###tramp-autoload
293 ;;;###tramp-autoload
300 ;;;###tramp-autoload
304 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
308 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
309 tramp-terminal-type
310 tramp-initial-end-of-output))
315 ;;;###tramp-autoload
321 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
322 tramp-terminal-type
323 tramp-initial-end-of-output))
327 ;;;###tramp-autoload
334 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
335 tramp-terminal-type
336 tramp-initial-end-of-output))
346 ;;;###tramp-autoload
353 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
354 tramp-terminal-type
355 tramp-initial-end-of-output))
364 ;;;###tramp-autoload
375 ;;;###tramp-autoload
379 ;;;###tramp-autoload
383 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
384 ;; Do not add "plink" based methods, they ask interactively for the user.
385 ;;;###tramp-autoload
394 ;;;###tramp-autoload
400 ;;;###tramp-autoload
416 ;;;###tramp-autoload
421 ;;;###tramp-autoload
426 ;;;###tramp-autoload
434 ;;;###tramp-autoload
461 ;; "getconf PATH" yields:
462 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
463 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
464 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
465 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
466 ;; IRIX64: /usr/bin
467 ;;;###tramp-autoload
473 "List of directories to search for executables on remote host.
474 For every remote host, this variable will be set buffer local,
475 keeping the list of existing directories on that host.
477 You can use `~' in this list, but when searching for a shell which groks
478 tilde expansion, all directory names starting with `~' will be ignored.
480 `Default Directories' represent the list of directories given by
482 entry on top of this list, because these are the default
483 directories for POSIX compatible commands. On remote hosts which
484 do not offer the getconf command (like cygwin), the value
487 `Private Directories' are the settings of the $PATH environment,
488 as given in your `~/.profile'."
495 ;;;###tramp-autoload
502 "List of environment variables to be set on the remote host.
504 Each element should be a string of the form ENVVARNAME=VALUE. An
505 entry ENVVARNAME= disables the corresponding environment variable,
506 which might have been set in the init files like ~/.profile.
508 Special handling is applied to the PATH environment, which should
509 not be set here. Instead, it should be set via `tramp-remote-path'."
514 ;;;###tramp-autoload
516 "Alist specifying extra arguments to pass to the remote shell.
517 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
518 matching the shell file name and ARGS is a string specifying the
519 arguments.
521 This variable is only used when Tramp needs to start up another shell
522 for tilde expansion. The extra arguments should typically prevent the
523 shell from reading its init file."
525 ;; This might be the wrong way to test whether the widget type
526 ;; `alist' is available. Who knows the right way to test it?
541 "List of pattern/action pairs.
542 Whenever a pattern matches, the corresponding action is performed.
543 Each item looks like (PATTERN ACTION).
545 The PATTERN should be a symbol, a variable. The value of this
546 variable gives the regular expression to search for. Note that the
548 appended to it.
550 The ACTION should also be a symbol, but a function. When the
558 "List of pattern/action pairs.
559 This list is used for copying/renaming with out-of-band methods.
564 "(echo begin 600 %t; tail -n +2) | uudecode
565 cat %t
566 rm -f %t"
567 "Shell function to implement `uudecode' to standard output.
568 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
569 for this or `uudecode -p', but some systems don't, and for them
573 "%s -e '
574 use File::Spec;
577 sub recursive {
578 my ($volume, @dirs) = @_;
579 my $real = realpath(File::Spec->catpath(
581 if ($real) {
582 my ($vol, $dir) = File::Spec->splitpath($real, 1);
583 return ($vol, File::Spec->splitdir($dir));
584 }
585 else {
586 my $last = pop(@dirs);
587 ($volume, @dirs) = recursive($volume, @dirs);
588 push(@dirs, $last);
589 return ($volume, @dirs);
590 }
591 }
593 $result = realpath($ARGV[0]);
594 if (!$result) {
595 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
596 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
599 }
603 }
607 "Perl script to produce output suitable for use with `file-truename'
608 on the remote file system.
609 Escape sequence %s is replaced with name of Perl binary.
613 "%s -e 'sub case {
614 my $str = shift;
615 if ($ARGV[2]) {
616 return lc($str);
617 }
618 else {
619 return $str;
620 }
621 }
623 @files = readdir(d); closedir(d);
624 foreach $f (@files) {
625 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
628 }
629 else {
631 }
632 }
633 }
636 "Perl script to produce output suitable for use with
637 `file-name-all-completions' on the remote file system. Escape
638 sequence %s is replaced with name of Perl binary. This string is
641 ;; Perl script to implement `file-attributes' in a Lisp `read'able
642 ;; output. If you are hacking on this, note that you get *no* output
643 ;; unless this spits out a complete line, including the '\n' at the
644 ;; end.
645 ;; The device number is returned as "-1", because there will be a virtual
646 ;; device number set in `tramp-sh-handle-file-attributes'.
648 "%s -e '
649 @stat = lstat($ARGV[0]);
650 if (!@stat) {
652 exit 0;
653 }
654 if (($stat[2] & 0170000) == 0120000)
655 {
656 $type = readlink($ARGV[0]);
659 }
660 elsif (($stat[2] & 0170000) == 040000)
661 {
663 }
664 else
665 {
667 };
670 printf(
672 $type,
673 $stat[3],
674 $uid,
675 $gid,
676 $stat[8] >> 16 & 0xffff,
677 $stat[8] & 0xffff,
678 $stat[9] >> 16 & 0xffff,
679 $stat[9] & 0xffff,
680 $stat[10] >> 16 & 0xffff,
681 $stat[10] & 0xffff,
682 $stat[7],
683 $stat[2],
684 $stat[1] >> 16 & 0xffff,
685 $stat[1] & 0xffff
687 "Perl script to produce output suitable for use with `file-attributes'
688 on the remote file system.
689 Escape sequence %s is replaced with name of Perl binary.
693 "%s -e '
696 @list = readdir(DIR);
697 closedir(DIR);
698 $n = scalar(@list);
700 for($i = 0; $i < $n; $i++)
701 {
702 $filename = $list[$i];
703 @stat = lstat($filename);
704 if (($stat[2] & 0170000) == 0120000)
705 {
706 $type = readlink($filename);
709 }
710 elsif (($stat[2] & 0170000) == 040000)
711 {
713 }
714 else
715 {
717 };
721 printf(
722 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
723 $filename,
724 $type,
725 $stat[3],
726 $uid,
727 $gid,
728 $stat[8] >> 16 & 0xffff,
729 $stat[8] & 0xffff,
730 $stat[9] >> 16 & 0xffff,
731 $stat[9] & 0xffff,
732 $stat[10] >> 16 & 0xffff,
733 $stat[10] & 0xffff,
734 $stat[7],
735 $stat[2],
736 $stat[1] >> 16 & 0xffff,
737 $stat[1] & 0xffff,
738 $stat[0] >> 16 & 0xffff,
739 $stat[0] & 0xffff);
740 }
742 "Perl script implementing `directory-files-attributes' as Lisp `read'able
743 output.
744 Escape sequence %s is replaced with name of Perl binary.
747 ;; These two use base64 encoding.
749 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
750 "Perl program to use for encoding a file.
751 Escape sequence %s is replaced with name of Perl binary.
752 This string is passed to `format', so percent characters need to be doubled.
753 This implementation requires the MIME::Base64 Perl module to be installed
757 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
758 "Perl program to use for decoding a file.
759 Escape sequence %s is replaced with name of Perl binary.
760 This string is passed to `format', so percent characters need to be doubled.
761 This implementation requires the MIME::Base64 Perl module to be installed
765 "%s -e '
766 # This script contributed by Juanma Barranquero <lektu@terra.es>.
767 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
768 use strict;
770 my %%trans = do {
771 my $i = 0;
772 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
773 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
774 };
775 my $data;
777 # We read in chunks of 54 bytes, to generate output lines
778 # of 72 chars (plus end of line)
779 while (read STDIN, $data, 54) {
780 my $pad = q();
782 # Only for the last chunk, and only if did not fill the last three-byte packet
783 if (eof) {
784 my $mod = length($data) %% 3;
785 $pad = q(=) x (3 - $mod) if $mod;
786 }
788 # Not the fastest method, but it is simple: unpack to binary string, split
789 # by groups of 6 bits and convert back from binary to byte; then map into
790 # the translation table
791 print
792 join q(),
793 map($trans{$_},
794 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
795 $pad,
797 }' 2>/dev/null"
798 "Perl program to use for encoding a file.
799 Escape sequence %s is replaced with name of Perl binary.
803 "%s -e '
804 # This script contributed by Juanma Barranquero <lektu@terra.es>.
805 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
806 use strict;
808 my %%trans = do {
809 my $i = 0;
810 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
811 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
812 };
814 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
818 # We are going to accumulate into $pending to accept any line length
819 # (we do not check they are <= 76 chars as the RFC says)
820 my $pending = q();
822 while (my $data = <STDIN>) {
823 chomp $data;
825 # If we find one or two =, we have reached the end and
826 # any following data is to be discarded
827 my $finished = $data =~ s/(==?).*/$1/;
828 $pending .= $data;
830 my $len = length($pending);
831 my $chunk = substr($pending, 0, $len & ~3);
832 $pending = substr($pending, $len & ~3 + 1);
834 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
835 # split in 8-bit chunks and convert back to char.
836 print join q(),
837 map $bytes{$_},
838 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
840 last if $finished;
841 }' 2>/dev/null"
842 "Perl program to use for decoding a file.
843 Escape sequence %s is replaced with name of Perl binary.
847 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
848 "Perl program to use for encoding a file.
852 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
853 "Perl program to use for decoding a file.
858 while read file; do
861 else
863 fi
866 else
868 fi
869 done
871 "Script to check existence of VC related files.
872 It must be send formatted with two strings; the tests for file
873 existence, and file readability. Input shall be read via
874 here-document, otherwise the command could exceed maximum length
877 ;; New handlers should be added here.
881 ;; `byte-compiler-base-file-name' performed by default handler.
886 ;; `diff-latest-backup-file' performed by default handler.
890 . tramp-sh-handle-directory-files-and-attributes)
891 ;; `dired-call-process' performed by default handler.
894 . tramp-sh-handle-dired-recursive-delete-directory)
901 ;; `file-equal-p' performed by default handler.
904 ;; `file-in-directory-p' performed by default handler.
912 ;; `file-name-sans-versions' performed by default handler.
925 ;; `find-file-noselect' performed by default handler.
926 ;; `get-file-buffer' performed by default handler.
930 . tramp-sh-handle-insert-file-contents-literally)
949 "Alist of handler functions.
952 ;; This must be the last entry, because `identity' always matches.
953 ;;;###tramp-autoload
957 ;;; File Name Handler Functions:
961 "Like `make-symbolic-link' for Tramp files.
962 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
963 the symlink. If LINKNAME is a Tramp file, only the localname component is
964 used as the target of the symlink.
966 If LINKNAME is a Tramp file and the localname component is relative, then
967 it is expanded first, before the localname component is taken. Note that
968 this can give surprising results if the user/host for the source and
969 target of the symlink differ."
976 l 'file-error
979 ;; Do the 'confirm if exists' thing.
981 ;; What to do?
986 "File %s already exists; make it a link anyway? "
987 l-localname)))))
992 ;; If FILENAME is a Tramp name, use just the localname component.
1001 ;; Right, they are on the same host, regardless of user, method,
1002 ;; etc. We now make the link on the remote machine. This will
1003 ;; occur as the user that FILENAME belongs to.
1005 l
1007 "cd %s && %s -sf %s %s"
1009 ln
1012 t))))
1015 "Like `file-truename' for Tramp files."
1017 "%s%s"
1020 method user host
1025 ;; Use GNU readlink --canonicalize-missing where available.
1028 v
1036 ;; Use Perl implementation.
1044 v
1048 ;; Do it yourself. We bind `directory-sep-char' here for
1049 ;; XEmacs on Windows, which would otherwise use backslash.
1057 ;; Don't make the following value larger than
1058 ;; necessary. People expect an error message in
1059 ;; a timely fashion when something is wrong;
1060 ;; otherwise they might think that Emacs is hung.
1061 ;; Of course, correctness has to come first.
1063 symlink-target)
1074 method user host
1086 ;; It's a symlink, follow it.
1092 ;; If the symlink was absolute, we'll get a
1093 ;; string like "/user@host:/some/target";
1094 ;; extract the "/some/target" part from it.
1098 v 'file-error
1099 "Symlink target `%s' on wrong host"
1100 symlink-target))
1105 steps)))
1107 ;; It's a file.
1111 v 'file-error
1114 ;; Combine list to form string.
1125 result))))
1127 ;; Preserve trailing "/".
1130 ;; Basic functions.
1133 "Like `file-exists-p' for Tramp files."
1141 v
1143 "%s %s"
1148 "Like `file-attributes' for Tramp files."
1151 ;; Don't modify `last-coding-system-used' by accident.
1158 v
1166 ;; The scripts could fail, for example with huge file size.
1170 "Implement `file-attributes' for Tramp files using the ls(1) command."
1172 res-inode res-filemodes res-numlinks
1173 res-uid res-gid res-size res-symlink-target)
1176 vec
1183 ;; On systems which have no quoting style, file names
1184 ;; with special characters could fail.
1189 ;; Parse `ls -l' output ...
1193 ;; ... inode
1209 ;; ... file mode flags
1211 ;; ... number links
1213 ;; ... uid and gid
1223 ;; ... size
1225 ;; From the file modes, figure out other stuff.
1228 ;; If symlink, find out file name pointed to.
1235 ;; Return data gathered.
1237 ;; 0. t for directory, string (name linked to) for symbolic
1238 ;; link, or nil.
1240 ;; 1. Number of links to file.
1241 res-numlinks
1242 ;; 2. File uid.
1243 res-uid
1244 ;; 3. File gid.
1245 res-gid
1246 ;; 4. Last access time, as a list of integers. Normally this
1247 ;; would be in the same format as `current-time', but the
1248 ;; subseconds part is not currently implemented, and (0 0)
1249 ;; denotes an unknown time.
1250 ;; 5. Last modification time, likewise.
1251 ;; 6. Last status change time, likewise.
1253 ;; 7. Size in bytes (-1, if number is out of range).
1254 res-size
1255 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1256 res-filemodes
1257 ;; 9. t if file's gid would change if file were deleted and
1258 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1259 t
1260 ;; 10. Inode number.
1261 res-inode
1262 ;; 11. Device number. Will be replaced by a virtual device number.
1263 -1
1264 )))))
1268 "Implement `file-attributes' for Tramp files using a Perl script."
1273 vec
1279 "Implement `file-attributes' for Tramp files using stat(1) command."
1282 vec
1285 ;; On Opsware, pdksh (which is the true name of ksh there)
1286 ;; doesn't parse correctly the sequence "((". Therefore, we add
1287 ;; a space. Apostrophes in the stat output are masked as "//",
1288 ;; in order to make a proper shell escape of them in file names.
1289 "( (%s %s || %s -h %s) && (%s -c "
1290 "'((//%%N//) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 //%%A// t %%ie0 -1)' "
1302 "Like `set-visited-file-modtime' for Tramp files."
1309 coding-system-used)
1313 ;; '(-1 65535) means file doesn't exists yet.
1317 ;; We use '(0 0) as a don't-know value. See also
1318 ;; `tramp-do-file-attributes-with-ls'.
1323 v
1332 nil)))))
1334 ;; This function makes the same assumption as
1335 ;; `tramp-sh-handle-set-visited-file-modtime'.
1337 "Like `verify-visited-file-modtime' for Tramp files.
1338 At the time `verify-visited-file-modtime' calls this function, we
1339 already know that the buffer is visiting a file and that
1340 `visited-file-modtime' does not return 0. Do not call this
1341 function directly, unless those two cases are already taken care
1342 of."
1345 ;; There is no file visiting the buffer, or the buffer has no
1346 ;; recorded last modification time, or there is no established
1347 ;; connection.
1351 t
1359 ;; File exists, and has a known modtime.
1362 modtime
1363 ;; For compatibility, deal with both the old
1364 ;; (HIGH . LOW) and the new (HIGH LOW) return
1365 ;; values of `visited-file-modtime'.
1368 mt)))
1370 ;; Modtime has the don't know value.
1373 v
1380 attr
1383 ;; If file does not exist, say it is not modified if and
1384 ;; only if that agrees with the buffer's record.
1388 "Like `set-file-modes' for Tramp files."
1391 ;; FIXME: extract the proper text from chmod's stderr.
1393 v
1400 "Like `set-file-times' for Tramp files."
1407 time))
1408 ;; With GNU Emacs, `format-time-string' has an
1409 ;; optional parameter UNIVERSAL. This is preferred,
1410 ;; because we could handle the case when the remote
1411 ;; host is located in a different time zone as the
1412 ;; local host.
1416 "%s %s %s %s"
1427 ;; We handle also the local part, because in older Emacsen,
1428 ;; without `set-file-times', this function is an alias for this.
1429 ;; We are local, so we don't need the UTC settings.
1437 "Set the ownership for FILENAME.
1438 If UID and GID are provided, these values are used; otherwise uid
1439 and gid of the corresponding user is taken. Both parameters must
1440 be non-negative integers."
1441 ;; Modern Unices allow chown only for root. So we might need
1442 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1443 ;; working with su(do)? when it is needed, so it shall succeed in
1444 ;; the majority of cases.
1445 ;; Don't modify `last-coding-system-used' by accident.
1450 ;; If we are root on the local host, we can do it directly.
1458 "chown %d:%d %s" uid gid
1461 ;; We handle also the local part, because there doesn't exist
1462 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1466 nil "chown" nil nil nil
1470 "Check, whether SELINUX is enabled on the remote host."
1482 "Like `file-selinux-context' for Tramp files."
1491 "%s -d -Z %s"
1499 ;; Return the context.
1500 context))))
1503 "Like `set-file-selinux-context' for Tramp files."
1520 t)
1522 nil)))
1525 "Check, whether ACL is enabled on the remote host."
1530 "Like `file-acl' for Tramp files."
1536 "getfacl -ac %s 2>/dev/null"
1546 "Like `set-file-acl' for Tramp files."
1553 tramp-end-of-heredoc
1554 acl-string
1555 tramp-end-of-heredoc))
1557 ;; Success.
1560 t)
1561 ;; In case of errors, we return nil.
1563 nil)))
1565 ;; Simple functions using the `test' command.
1568 "Like `file-executable-p' for Tramp files."
1571 ;; Examine `file-attributes' cache to see if request can be
1572 ;; satisfied without remote operation.
1577 "Like `file-readable-p' for Tramp files."
1580 ;; Examine `file-attributes' cache to see if request can be
1581 ;; satisfied without remote operation.
1585 ;; When the remote shell is started, it looks for a shell which groks
1586 ;; tilde expansion. Here, we assume that all shells which grok tilde
1587 ;; expansion will also provide a `test' command which groks `-nt' (for
1588 ;; newer than). If this breaks, tell me about it and I'll try to do
1589 ;; something smarter about it.
1591 "Like `file-newer-than-file-p' for Tramp files."
1593 nil)
1595 t)
1596 ;; We are sure both files exist at this point.
1599 ;; We try to get the mtime of both files. If they are not
1600 ;; equal to the "dont-know" value, then we subtract the times
1601 ;; and obtain the result.
1607 ;; If one of them is the dont-know value, then we can
1608 ;; still try to run a shell command on the remote host.
1609 ;; However, this only works if both files are Tramp
1610 ;; files and both have the same method, same user, same
1611 ;; host.
1616 v 'file-error
1617 "Files %s and %s must have same method, user, host"
1618 file1 file2)))
1623 ;; Functions implemented using the basic functions above.
1626 "Like `file-directory-p' for Tramp files."
1628 ;; `file-directory-p' is used as predicate for file name completion.
1629 ;; Sometimes, when a connection is not established yet, it is
1630 ;; desirable to return t immediately for "/method:foo:". It can
1631 ;; be expected that this is always a directory.
1637 "Like `file-writable-p' for Tramp files."
1641 ;; Examine `file-attributes' cache to see if request can be
1642 ;; satisfied without remote operation.
1645 ;; If file doesn't exist, check if directory is writable.
1650 "Like `file-ownership-preserved-p' for Tramp files."
1654 ;; Return t if the file doesn't exist, since it's true that no
1655 ;; information would be lost by an (attempted) delete and create.
1662 ;; Directory listings.
1666 "Like `directory-files-and-attributes' for Tramp files."
1674 v localname
1685 v localname id-format))
1688 v localname id-format))
1690 result item)
1700 result
1702 ;; The scripts could fail, for example with huge file size.
1704 directory full match nosort id-format)))))
1708 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1711 vec tramp-perl-directory-files-and-attributes
1715 vec
1719 object))
1723 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1726 vec
1729 ;; We must care about file names with spaces, or starting with
1730 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1731 ;; but it does not work on all remote systems. Apostrophes in
1732 ;; the stat output are masked as "//", in order to make a proper
1733 ;; shell escape of them in file names.
1735 "xargs %s -c "
1736 "'(//%%n// (//%%N//) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 //%%A// t %%ie0 -1)' "
1740 ;; On systems which have no quoting style, file names with
1741 ;; special characters could fail.
1748 ;; This function should return "foo/" for directories and "bar" for
1749 ;; files.
1751 "Like `file-name-all-completions' for Tramp files."
1756 filename
1758 'list
1760 ;; Try cache entries for `filename', `filename' with last
1761 ;; character removed, `filename' with last two characters
1762 ;; removed, ..., and finally the empty string - all
1763 ;; concatenated to the local directory name.
1766 tramp-completion-reread-directory-timeout)))
1768 ;; This is inefficient for very long file names, pity
1769 ;; `reduce' is not available...
1772 'append
1777 v
1779 "file-name-all-completions"
1780 nil)))
1782 ;; We cannot use a length of 0, because file properties
1783 ;; for "foo" and "foo/" are identical.
1786 ;; Cache expired or no matching cache entry found so we need
1787 ;; to perform a remote operation.
1789 ;; Get a list of directories and files, including reliably
1790 ;; tagging the directories with a trailing '/'. Because I
1791 ;; rock. --daniel@danann.net
1793 ;; Changed to perform `cd' in the same remote op and only
1794 ;; get entries starting with `filename'. Capture any `cd'
1795 ;; error messages. Ensure any `cd' and `echo' aliases are
1796 ;; ignored.
1798 v
1802 v tramp-perl-file-name-all-completions
1808 ;; `read-file-name-completion-ignore-case'
1809 ;; is introduced with Emacs 22.1.
1812 'read-file-name-completion-ignore-case
1817 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1818 ;; `ls' with wildcard might fail with `Argument
1819 ;; list too long' error in some corner cases; if
1820 ;; `ls' fails after `cd' succeeded, chances are
1821 ;; that's the case, so let's retry without
1822 ;; wildcard. This will return "too many" entries
1823 ;; but that isn't harmful.
1824 " || %s -a 2>/dev/null)"
1825 " | while IFS= read f; do"
1831 ;; When `filename' is empty, just `ls' without
1832 ;; `filename' argument is more efficient than `ls *'
1833 ;; for very large directories and might avoid the
1834 ;; `Argument list too long' error.
1835 ;;
1836 ;; With and only with wildcard, we need to add
1837 ;; `-d' to prevent `ls' from descending into
1838 ;; sub-directories.
1840 "."
1845 ;; Now grab the output.
1849 ;; Check result code, found in last line of output.
1853 ;; Grab error message from line before last line
1854 ;; (it was put there by `cd 2>&1').
1857 v 'file-error
1858 "tramp-sh-handle-file-name-all-completions: %s"
1860 ;; For peace of mind, if buffer doesn't end in `fail'
1861 ;; then it should end in `ok'. If neither are in the
1862 ;; buffer something went seriously wrong on the remote
1863 ;; side.
1866 v 'file-error
1867 "\
1868 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1874 ;; Because the remote op went through OK we know the
1875 ;; directory we `cd'-ed to exists.
1878 ;; Because the remote op went through OK we know every
1879 ;; file listed by `ls' exists.
1883 result)
1885 ;; Store result in the cache.
1890 ;; cp, mv and ln
1894 "Like `add-name-to-file' for Tramp files."
1899 v 'file-error
1900 "add-name-to-file: %s"
1909 "File %s already exists; make it a new name anyway? "
1910 newname)))
1917 v1
1921 "error with add-name-to-file, see buffer `%s' for details"
1926 preserve-uid-gid preserve-extended-attributes)
1927 "Like `copy-file' for Tramp files."
1931 ;; At least one file a Tramp file?
1935 'copy filename newname ok-if-already-exists keep-date
1936 preserve-uid-gid preserve-extended-attributes))
1937 ;; Compat section.
1940 'copy-file
1942 preserve-uid-gid preserve-extended-attributes)))
1945 'copy-file
1953 "Like `copy-directory' for Tramp files."
1959 ;; When DIRNAME and NEWNAME are remote, they must have
1960 ;; the same method.
1966 ;; scp or rsync DTRT.
1980 ;; We must do it file-wise.
1982 'copy-directory
1987 ;; When newname did exist, we have wrong cached values.
1995 "Like `rename-file' for Tramp files."
1996 ;; Check if both files are local -- invoke normal rename-file.
1997 ;; Otherwise, use Tramp from local system.
2000 ;; At least one file a Tramp file?
2010 preserve-uid-gid preserve-extended-attributes)
2011 "Copy or rename a remote file.
2012 OP must be `copy' or `rename' and indicates the operation to perform.
2013 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2014 the new file (for copy) or the new name of the file (for rename).
2015 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2016 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2017 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2018 the uid and gid if both files are on the same host.
2019 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2021 This function is invoked by `tramp-sh-handle-copy-file' and
2022 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2023 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2024 file names."
2041 filename newname)
2044 ;; Both are Tramp files.
2049 ;; Shortcut: if method, host, user are the same for
2050 ;; both files, we invoke `cp' or `mv' on the remote
2051 ;; host directly.
2054 op filename newname
2055 ok-if-already-exists keep-date preserve-uid-gid))
2057 ;; Try out-of-band operation.
2062 op filename newname keep-date))
2064 ;; No shortcut was possible. So we copy the file
2065 ;; first. If the operation was `rename', we go back
2066 ;; and delete the original file (if the copy was
2067 ;; successful). The approach is simple-minded: we
2068 ;; create a new buffer, insert the contents of the
2069 ;; source file into it, then write out the buffer to
2070 ;; the target file. The advantage is that it doesn't
2071 ;; matter which file name handlers are used for the
2072 ;; source and target file.
2075 op filename newname keep-date))))))
2077 ;; One file is a Tramp file, the other one is local.
2080 ;; Fast track on local machine.
2083 op filename newname
2084 ok-if-already-exists keep-date preserve-uid-gid))
2086 ;; If the Tramp file has an out-of-band method, the
2087 ;; corresponding copy-program can be invoked.
2090 op filename newname keep-date))
2092 ;; Use the inline method via a Tramp buffer.
2094 op filename newname keep-date))))
2097 ;; One of them must be a Tramp file.
2100 ;; Handle `preserve-extended-attributes'. We ignore possible
2101 ;; errors, because ACL strings could be incompatible.
2106 ;; In case of `rename', we must flush the cache of the source file.
2112 ;; When newname did exist, we have wrong cached values.
2119 "Use an Emacs buffer to copy or rename a file.
2120 First arg OP is either `copy' or `rename' and indicates the operation.
2121 FILENAME is the source file, NEWNAME the target file.
2122 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2123 ;; We must disable multibyte, because binary data shall not be
2124 ;; converted. We don't want the target file to be compressed, so we
2125 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2126 ;; be called either. We remove `tramp-file-name-handler' from
2127 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2128 ;; `insert-file-contents' might be deactivated in some corner cases.
2139 ;; KEEP-DATE handling.
2141 ;; Set the mode.
2143 ;; If the operation was `rename', delete the original file.
2148 "Invokes `cp' or `mv' on the remote system.
2149 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2150 respectively. FILENAME specifies the file to copy or rename,
2151 NEWNAME is the name of the new file (for copy) or the new name of
2152 the file (for rename). Both files must reside on the same host.
2153 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2154 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2155 the uid and gid from FILENAME."
2165 v 'file-error
2166 "Unknown operation `%s', must be `copy' or `rename'"
2167 op))))
2171 filename))
2175 newname))
2177 cmd-result)
2180 ;; Both files are on a remote host, with same user.
2192 ;; Mask cp -f error.
2194 tramp-operation-not-permitted-regexp nil t))
2195 cmd-result)
2197 nil v 'file-error
2198 "Copying directly failed, see buffer `%s' for details."
2201 ;; We are on the local host.
2204 ;; We can do it directly.
2207 ;; No sticky bit when renaming.
2218 localname1 localname2 ok-if-already-exists
2219 keep-date preserve-uid-gid)
2223 ;; We can do it directly with `tramp-send-command'
2231 ok-if-already-exists keep-date t)
2232 ;; We must change the ownership to the local user.
2238 ;; We need a temporary file in between.
2240 ;; Create the temporary file.
2248 "%s %s %s" cmd
2251 "Copying directly failed, see buffer `%s' for details."
2253 ;; We must change the ownership as remote user.
2254 ;; Since this does not work reliable, we also
2255 ;; give read permissions.
2266 localname1 tmpfile t
2267 keep-date preserve-uid-gid)
2269 'rename-file
2271 ;; We must change the ownership as local user.
2272 ;; Since this does not work reliable, we also
2273 ;; give read permissions.
2277 tmpfile
2281 ;; Move the temporary file to its destination.
2286 "cp -f -p %s %s"
2289 "Copying directly failed, see buffer `%s' for details."
2293 'rename-file
2296 ;; Save exit.
2299 ;; Set the time and mode. Mask possible errors.
2306 "Invoke `scp' program to copy.
2307 The method used must be an out-of-band method."
2311 copy-program copy-args copy-env copy-keep-date port listener spec
2312 options source target remote-copy-program remote-copy-args)
2317 ;; Both are Tramp files. We shall optimize it when the
2318 ;; methods for FILENAME and NEWNAME are the same.
2328 op filename tmpfile keep-date)
2331 ;; Save exit.
2338 ;; Set variables for computing the prompt for reading
2339 ;; password.
2346 ;; Expand hops. Might be necessary for gateway methods.
2350 ;; Check which ones of source and target are Tramp files.
2359 'file-name-directory
2365 ;; Check for host and port number. We cannot use
2366 ;; `tramp-file-name-port', because this returns also
2367 ;; `tramp-default-port', which might clash with settings in
2368 ;; "~/.ssh/config".
2375 ;; Check for user. There might be an interactive setting.
2379 ;; Check for listener port.
2386 ;; Compose copy command.
2395 ?h host ?u user ?p port ?r listener ?c options
2402 copy-args
2404 ;; " " has either been a replacement of "%k" (when
2405 ;; keep-date argument is non-nil), or a replacement
2406 ;; for the whole keep-date sublist.
2407 " "
2411 copy-args)
2414 copy-args
2418 copy-env
2420 nil
2427 remote-copy-program
2437 remote-copy-args
2441 ;; Check for local copy program.
2446 ;; Install listener on the remote side. The prompt must be
2447 ;; consumed later on, when the process does not listen anymore.
2454 v 'file-error
2458 'identity
2466 v 'file-error
2467 "Listener process not running on remote host: `%s'"
2468 remote-copy-program))
2476 ;; The default directory must be remote.
2480 ;; Set the transfer process properties.
2490 copy-args
2492 copy-args
2497 ;; Use an asynchronous process. By this, password can
2498 ;; be handled. We don't set a timeout, because the
2499 ;; copying of large files can last longer than 60
2500 ;; secs.
2504 copy-program
2506 copy-args
2515 ;; We must adapt `tramp-local-end-of-line' for
2516 ;; sending the password.
2519 p v nil tramp-actions-copy-out-of-band))
2521 ;; Check the return code.
2526 orig-vec 'file-error
2527 "Couldn't find exit status of `%s'"
2533 orig-vec 'file-error
2534 "Error copying: `%s'"
2537 ;; Reset the transfer process properties.
2540 ;; Clear the remote prompt.
2543 ;; Houston, we have a problem! Likely, the listener is
2544 ;; still running, so let's clear everything (but the
2545 ;; cached password).
2548 ;; Handle KEEP-DATE argument.
2552 ;; Set the mode.
2557 ;; If the operation was `rename', delete the original file.
2564 "Like `make-directory' for Tramp files."
2576 "Like `delete-directory' for Tramp files."
2588 "Like `delete-file' for Tramp files."
2599 ;; Dired.
2601 ;; CCC: This does not seem to be enough. Something dies when
2602 ;; we try and delete two directories under Tramp :/
2604 "Recursively delete the directory given.
2605 This is like `dired-recursive-delete-directory' for Tramp files."
2607 ;; Run a shell command 'rm -r <localname>'.
2608 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2611 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2613 v
2615 ;; Don't read the output, do it explicitly.
2616 nil t)
2617 ;; Wait for the remote system to return to us...
2618 ;; This might take a while, allow it plenty of time.
2620 ;; Make sure that it worked...
2628 "Like `dired-compress-file' for Tramp files."
2629 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2630 ;; Code stolen mainly from dired-aux.el.
2636 ;; Emacs case
2638 ;; XEmacs has `dired-compression-method-alist', which is
2639 ;; transformed into `dired-compress-file-suffixes' structure.
2643 nil
2646 suffix)
2647 ;; See if any suffix rule matches this file name.
2655 nil)
2657 ;; We found an uncompression rule.
2663 ;; `dired-remove-file' is not defined in XEmacs.
2668 ;; We don't recognize the file as compressed, so compress it.
2669 ;; Try gzip.
2674 ;; `dired-remove-file' is not defined in XEmacs.
2684 "Like `insert-directory' for Tramp files."
2691 filename switches wildcard full-directory-p)
2711 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2712 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2715 v
2718 switches
2720 localname
2723 v
2727 "Couldn't `cd %s'"
2731 v
2734 switches
2739 ""
2747 ;; We cannot use `insert-buffer-substring' because the Tramp
2748 ;; buffer changes its contents before insertion due to calling
2749 ;; `expand-file' and alike.
2754 ;; Check for "--dired" output.
2761 ;; Now read the numeric positions of file names.
2767 ;; End is followed by \n or by " -> ".
2769 ;; Remove trailing lines.
2775 ;; Some busyboxes are reluctant to discard colors.
2782 ;; Decode the output, it could be multibyte.
2789 ;; The inserted file could be from somewhere else.
2796 "."
2803 ;; Canonicalization of file names.
2806 "Like `expand-file-name' for Tramp files.
2808 the result will be a local, non-Tramp, file name."
2809 ;; If DIR is not given, use `default-directory' or "/".
2811 ;; Unless NAME is absolute, concat DIR and NAME.
2814 ;; If NAME is not a Tramp file, run the real handler.
2817 ;; Dissect NAME.
2821 ;; Tilde expansion if necessary. This needs a shell which
2822 ;; groks tilde expansion! The function `tramp-find-shell' is
2823 ;; supposed to find such a shell on the remote host. Please
2824 ;; tell me about it when this doesn't work on your system.
2828 ;; We cannot simply apply "~/", because under sudo "~/" is
2829 ;; expanded to the local user home directory but to the
2830 ;; root home directory. On the other hand, using always
2831 ;; the default user name for tilde expansion is not
2832 ;; appropriate either, because ssh and companions might
2833 ;; use a user name from the config file.
2845 ;; There might be a double slash, for example when "~/"
2846 ;; expands to "/". Remove this.
2849 ;; No tilde characters in file name, do normal
2850 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2851 ;; `directory-sep-char' here for XEmacs on Windows, which would
2852 ;; otherwise use backslash. `default-directory' is bound,
2853 ;; because on Windows there would be problems with UNC shares or
2854 ;; Cygwin mounts.
2858 method user host
2862 hop)))))
2864 ;;; Remote commands:
2867 "Flush file caches."
2875 ;; We use BUFFER also as connection buffer during setup. Because of
2876 ;; this, its original contents must be saved, and restored once
2877 ;; connection has been setup.
2879 "Like `start-file-process' for Tramp files."
2882 ;; it might be that the arguments exceed the command line
2883 ;; length. Therefore, we modify the command.
2888 ;; When PROGRAM is nil, we just provide a tty.
2894 args
2898 ;; Use a human-friendly prompt, for example for `shell'.
2902 tramp-initial-end-of-output)))
2903 ;; We use as environment the difference to toplevel
2904 ;; `process-environment'.
2905 env
2910 env)
2929 ;; We do not want to raise an error when
2930 ;; `start-file-process' has been started several times in
2931 ;; `eshell' and friends.
2935 ;; BUFFER can be nil. We use a temporary buffer.
2938 ;; NAME must be unique as process name.
2942 ;; Set the new process properties.
2948 ;; We catch this event. Otherwise, `start-process' could
2949 ;; be called on the local host.
2952 ;; Activate narrowing in order to save BUFFER
2953 ;; contents. Clear also the modification time;
2954 ;; otherwise we might be interrupted by
2955 ;; `verify-visited-file-modtime'.
2961 ;; We call `tramp-maybe-open-connection', in order
2962 ;; to cleanup the prompt afterwards.
2968 ;; Now do it.
2970 ;; Send the command.
2972 ;; Check, whether a pty is associated.
2976 v 'file-error
2979 ;; Set query flag and process marker for this
2980 ;; process. We ignore errors, because the process
2981 ;; could have finished already.
2985 ;; Return process.
2986 p))))
2988 ;; Save exit.
2999 "Like `process-file' for Tramp files."
3000 ;; The implementation is not complete yet.
3006 ;; Compute command.
3009 ;; We use as environment the difference to toplevel `process-environment'.
3017 "env %s %s"
3019 ;; Determine input.
3024 ;; INFILE is on the same remote host.
3026 ;; INFILE must be copied to remote host.
3032 ;; Determine output.
3034 ;; Just a buffer.
3037 ;; A buffer name.
3040 ;; (REAL-DESTINATION ERROR-DESTINATION)
3042 ;; output.
3050 ;; stderr.
3055 ;; stderr is on the same remote host.
3058 ;; stderr must be copied to remote host. The temporary
3059 ;; file must be deleted after execution.
3062 method user host stderr))))
3063 ;; stderr to be discarded.
3066 ;; 't
3071 ;; Send the command. It might not return in time, so we protect
3072 ;; it. Call it in a subshell, in order to preserve working
3073 ;; directory.
3080 command)
3081 t t)
3083 ;; We should add the output anyway.
3090 ;; When the user did interrupt, we should do it also. We use
3091 ;; return code -1 as marker.
3095 ;; Handle errors.
3100 ;; Provide error file.
3103 ;; Cleanup. We remove all file cache values for the connection,
3104 ;; because the remote process could have changed them.
3107 ;; `process-file-side-effects' has been introduced with GNU
3108 ;; Emacs 23.2. If set to nil, no remote file will be changed
3109 ;; by `program'. If it doesn't exist, we assume its default
3110 ;; value t.
3115 ;; Return exit status.
3118 ret))))
3121 "Like `file-local-copy' for Tramp files."
3125 v 'file-error
3135 ;; `copy-file' handles direct copy and out-of-band methods.
3140 ;; Use inline encoding for file transfer.
3144 v 3
3152 tmpfile loc-dec)
3154 ;; If local decoding is a function, we call it.
3155 ;; We must disable multibyte, because
3156 ;; `uudecode-decode-region' doesn't handle it
3157 ;; correctly. Unset `file-name-handler-alist'.
3158 ;; Otherwise, epa-file gets confused.
3166 ;; If tramp-decoding-function is not defined for this
3167 ;; method, we invoke tramp-decoding-command instead.
3169 ;; Unset `file-name-handler-alist'. Otherwise,
3170 ;; epa-file gets confused.
3178 loc-dec tmpfile2 tmpfile)
3181 ;; Set proper permissions.
3183 ;; Set local user ownership.
3186 ;; Oops, I don't know what to do.
3190 ;; Error handling.
3196 tmpfile)))
3198 ;; This is needed for XEmacs only. Code stolen from files.el.
3201 "Like `insert-file-contents-literally' for Tramp files."
3209 nil))
3217 ;; Save exit.
3222 ;; CCC grok LOCKNAME
3225 "Like `write-region' for Tramp files."
3228 ;; Following part commented out because we don't know what to do about
3229 ;; file locking, and it does not appear to be a problem to ignore it.
3230 ;; Ange-ftp ignores it, too.
3231 ;; (when (and lockname (stringp lockname))
3232 ;; (setq lockname (expand-file-name lockname)))
3233 ;; (unless (or (eq lockname nil)
3234 ;; (string= lockname filename))
3235 ;; (error
3236 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3238 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3249 ;; `file-writable-p' calls `file-expand-file-name'. We
3250 ;; cannot use `tramp-run-real-handler' therefore.
3256 ;; Short track: if we are on the local host, we can run directly.
3258 'write-region
3262 ;; We use this to save the value of
3263 ;; `last-coding-system-used' after writing the tmp
3264 ;; file. At the end of the function, we set
3265 ;; `last-coding-system-used' to this saved value. This
3266 ;; way, any intermediary coding systems used while
3267 ;; talking to the remote shell or suchlike won't hose
3268 ;; this variable. This approach was snarfed from
3269 ;; ange-ftp.el.
3270 coding-system-used
3271 ;; Write region into a tmp file. This isn't really
3272 ;; needed if we use an encoding function, but currently
3273 ;; we use it always because this makes the logic
3274 ;; simpler. We must also set `temporary-file-directory',
3275 ;; because it could point to a remote directory.
3281 ;; If `append' is non-nil, we copy the file locally, and let
3282 ;; the native `write-region' implementation do the job.
3285 ;; We say `no-message' here because we don't want the
3286 ;; visited file modtime data to be clobbered from the temp
3287 ;; file. We call `set-visited-file-modtime' ourselves later
3288 ;; on. We must ensure that `file-coding-system-alist'
3289 ;; matches `tmpfile'.
3295 'write-region
3302 ;; Now, `last-coding-system-used' has the right value. Remember it.
3307 ;; The permissions of the temporary file should be set. If
3308 ;; FILENAME does not exist (eq modes nil) it has been
3309 ;; renamed to the backup file. This case `save-buffer'
3310 ;; handles permissions.
3311 ;; Ensure that it is still readable.
3314 tmpfile
3317 ;; This is a bit lengthy due to the different methods
3318 ;; possible for file transfer. First, we check whether the
3319 ;; method uses an scp program. If so, we call it.
3320 ;; Otherwise, both encoding and decoding command must be
3321 ;; specified. However, if the method _also_ specifies an
3322 ;; encoding function, then that is used for encoding the
3323 ;; contents of the tmp file.
3328 ;; `copy-file' handles direct copy and out-of-band methods.
3339 ;; We keep the local file for performance
3340 ;; reasons, useful for "rsync".
3347 ;; Don't rename, in order to keep context in SELinux.
3352 ;; Use inline file transfer.
3354 ;; Encode tmpfile.
3358 ;; Use encoding function or command.
3361 tmpfile loc-enc)
3363 ;; The following `let' is a workaround for
3364 ;; the base64.el that comes with pgnus-0.84.
3365 ;; If both of the following conditions are
3366 ;; satisfied, it tries to write to a local
3367 ;; file in default-directory, but at this
3368 ;; point, default-directory is remote.
3369 ;; (`call-process-region' can't write to
3370 ;; remote files, it seems.) The file in
3371 ;; question is a tmp file anyway.
3379 loc-enc tmpfile t))
3381 v 'file-error
3384 filename loc-enc))))
3386 ;; Send buffer into remote decoding command which
3387 ;; writes to remote file. Because this happens on
3388 ;; the remote host, we cannot use the function.
3391 filename rem-dec)
3395 v
3399 tramp-end-of-heredoc
3401 tramp-end-of-heredoc))
3403 v nil
3404 "Couldn't write region to `%s', decode using `%s' failed"
3405 filename rem-dec)
3406 ;; When `file-precious-flag' is set, the region is
3407 ;; written to a temporary file. Check that the
3408 ;; checksum is equal to that from the local tmpfile.
3412 ;; cksum runs locally, if possible.
3414 ;; cksum runs remotely.
3416 v
3419 ;; ... they are different.
3426 v 'file-error
3429 filename rem-dec)))))
3431 ;; Save exit.
3434 ;; That's not expected.
3437 v 'file-error
3440 method))))
3442 ;; Make `last-coding-system-used' have the right value.
3449 ;; We must protect `last-coding-system-used', now we have set it
3450 ;; to its correct value.
3452 ;; Set file modification time.
3456 ;; We must pass modtime explicitly, because FILENAME can
3457 ;; be different from (buffer-file-name), f.e. if
3458 ;; `file-precious-flag' is set.
3464 ;; Set the ownership.
3474 ;; VC backends check for the existence of various different special
3475 ;; files. This is very time consuming, because every single check
3476 ;; requires a remote command (the file cache must be invalidated).
3477 ;; Therefore, we apply a kind of optimization. We install the file
3478 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3479 ;; remembers all file names for which `file-exists-p' or
3480 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3481 ;; is performed. Afterwards, a script is applied for all collected
3482 ;; file names, using just one remote command. The result of this
3483 ;; script is used to fill the file cache with actual values. Now we
3484 ;; can reset the file name handlers, and we make a second run of
3485 ;; `vc-registered', which returns the expected result without sending
3486 ;; any other remote command.
3488 "Like `vc-registered' for Tramp files."
3494 ;; There could be new files, created by the vc backend. We
3495 ;; cannot reuse the old cache entries, therefore. In
3496 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3497 ;; could also be a timestamp as `current-time' returns. This
3498 ;; means invalidate all cache entries with an older timestamp.
3504 ;; Here we collect only file names, which need an operation.
3508 ;; Send just one command, in order to fill the cache.
3511 v
3520 ;; We cannot use `tramp-send-command-and-read',
3521 ;; because this does not cooperate well with
3522 ;; heredoc documents.
3524 v
3527 tramp-end-of-heredoc
3529 tramp-vc-registered-file-names
3531 tramp-end-of-heredoc))
3533 ;; Read the expression.
3540 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3541 ;; calls shall be answered from the file cache. We unset
3542 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3543 ;; in order to keep the cache.
3545 remote-file-name-inhibit-cache process-file-side-effects)
3546 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3565 ;; Run.
3569 ;;;###tramp-autoload
3571 "Invoke remote-shell Tramp file name handler.
3572 Fall back to normal file name handler if no Tramp handler exists."
3590 "Invoke special file name handler, which collects files to be handled."
3598 ;; That's what we want: file names, for which checks are
3599 ;; applied. We assume that VC uses only `file-exists-p' and
3600 ;; `file-readable-p' checks; otherwise we must extend the
3601 ;; list. We do not perform any action, but return nil, in
3602 ;; order to keep `vc-registered' running.
3605 nil)
3606 ;; `process-file' and `start-file-process' shall be ignored.
3609 ;; Tramp file name handlers like `expand-file-name'. They
3610 ;; must still work.
3612 ;; Default file name handlers, we don't care.
3616 "Like `file-notify-add-watch' for Tramp files."
3620 command events filter p sequence)
3622 ;; gvfs-monitor-dir.
3626 ;; inotifywait.
3629 events
3636 ;; None.
3638 v 'file-notify-error
3639 "No file notification program found on %s"
3641 ;; Start process.
3643 'start-file-process
3647 sequence))
3648 ;; Return the process object as watch-descriptor.
3651 v 'file-notify-error
3652 "`%s' failed to start on remote host"
3658 p))))
3670 ;; Attribute change is returned in unused wording.
3680 string)
3683 proc
3687 ;; File names are returned as absolute paths. We must
3688 ;; add the remote prefix.
3693 ;; Usually, we would add an Emacs event now. Unfortunately,
3694 ;; `unread-command-events' does not accept several events at
3695 ;; once. Therefore, we apply the callback directly.
3698 ;; Save rest of the string.
3707 ;; Check, whether there is a problem.
3713 line)
3718 proc
3725 ;; Usually, we would add an Emacs event now. Unfortunately,
3726 ;; `unread-command-events' does not accept several events at
3727 ;; once. Therefore, we apply the callback directly.
3730 ;;; Internal Functions:
3733 "Define in remote shell function NAME implemented as SCRIPT.
3734 Only send the definition if it has not already been done."
3735 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3736 ;; might be nil.
3741 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3742 ;; could result in unwanted command expansion. Avoid this.
3745 ;; The script could contain a call of Perl. This is masked with `%s'.
3750 vec
3758 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3759 Returns the exit code of the `test' program."
3762 v
3764 "%s %s %s"
3766 switch
3770 "Run `test'-like program on the remote system, given FILE1, FILE2.
3771 FORMAT-STRING contains the program name, switches, and place holders.
3772 Returns the exit code of the `test' program. Barfs if the methods,
3773 hosts, or files, disagree."
3777 v 'file-error
3782 v1
3789 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3790 First arg VEC specifies the connection, PROGNAME is the program
3791 to search for, and DIRLIST gives the list of directories to
3792 search. If IGNORE-TILDE is non-nil, directory names starting
3793 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3794 only in DIRLIST.
3796 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3798 This function expects to be in the right *tramp* buffer."
3801 ;; Check whether the executable is in $PATH. "which(1)" does not
3802 ;; report always a correct error code; therefore we check the
3803 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3804 ;; 5.11") have problems with this command, we disable the call
3805 ;; therefore.
3816 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3817 ;; `remove' is in CL, and we want to avoid CL dependencies.
3826 vec
3828 "do if test -x $d/%s && test -f $d/%s; "
3829 "then echo tramp_executable $d/%s; "
3832 progname progname progname
3833 tramp-end-of-heredoc
3835 tramp-end-of-heredoc))
3841 result)))
3844 "Sets the remote environment PATH to existing directories.
3845 I.e., for each directory in `tramp-remote-path', it is tested
3846 whether it exists and if so, it is added to the environment
3847 variable PATH."
3853 ;; ------------------------------------------------------------
3854 ;; -- Communication with external shell --
3855 ;; ------------------------------------------------------------
3858 "Find a command on the remote host for checking if a file exists.
3859 Here, we are looking for a command which has zero exit status if the
3860 file exists and nonzero exit status otherwise."
3864 result)
3865 ;; The algorithm is as follows: we try a list of several commands.
3866 ;; For each command, we first run `$cmd /' -- this should return
3867 ;; true, as the root directory always exists. And then we run
3868 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3869 ;; does not exist. This should return false. We use the first
3870 ;; command we find that seems to work.
3871 ;; The list of commands to try is as follows:
3872 ;; `ls -d' This works on most systems, but NetBSD 1.4
3873 ;; has a bug: `ls' always returns zero exit
3874 ;; status, even for files which don't exist.
3875 ;; `test -e' Some Bourne shells have a `test' builtin
3876 ;; which does not know the `-e' option.
3877 ;; `/bin/test -e' For those, the `test' binary on disk normally
3878 ;; provides the option. Alas, the binary
3879 ;; is sometimes `/bin/test' and sometimes it's
3880 ;; `/usr/bin/test'.
3881 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3909 result))
3912 "Opens shell SHELL."
3915 ;; Find arguments for this shell.
3917 item extra-args)
3922 ;; It is useful to set the prompt in the following command
3923 ;; because some people have a setting for $PS1 which /bin/sh
3924 ;; doesn't know about and thus /bin/sh will display a strange
3925 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3926 ;; ksh will display the current working directory but /bin/sh
3927 ;; will display a dollar sign. The following command line sets
3928 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3929 ;; well as csh-like shells. We also unset the variable $ENV
3930 ;; because that is read by some sh implementations (eg, bash
3931 ;; when called as sh) on startup; this way, we avoid the startup
3932 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3933 ;; the prompt in /bin/bash, it must be discarded as well.
3934 ;; $HISTFILE is set according to `tramp-histfile-override'.
3937 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3942 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3946 t))
3951 "Opens a shell on the remote host which groks tilde expansion."
3959 shell)
3962 ;; CCC: "root" does not exist always, see QNAP 459.
3963 ;; Which check could we apply instead?
3966 ;; The default shell (ksh93) of OpenSolaris and
3967 ;; Solaris is buggy. We've got reports for
3968 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3977 ;; Maybe it works at least for some other commands.
3979 default-shell
3981 vec 2
3983 "Couldn't find a remote shell which groks tilde "
3985 default-shell)))
3987 default-shell)))
3989 ;; Open a new shell if needed.
3995 ;; Utility functions.
3998 "Wait for shell prompt and barf if none appears.
3999 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4000 seconds. If not, it produces an error message with the given ERROR-ARGS."
4004 proc timeout
4013 "Set up an interactive shell.
4014 Mainly sets the prompt and the echo correctly. PROC is the shell
4015 process to set up. VEC specifies the connection."
4018 vec
4023 ;; Disable echo.
4026 ;; Check whether the echo has really been disabled. Some
4027 ;; implementations, like busybox of embedded GNU/Linux, don't
4028 ;; support disabling.
4035 ;; Make sure backspaces and their echo are enabled and no line
4036 ;; width magic interferes with them.
4044 ;; Try to set up the coding system correctly.
4045 ;; CCC this can't be the right way to do it. Hm.
4049 ;; Use MULE to select the right EOL convention for communicating
4050 ;; with the process.
4056 cs-decode cs-encode)
4073 ;; Look for ^M and do something useful if found.
4075 ;; We have found a ^M but cannot frob the process coding system
4076 ;; because we're running on a non-MULE Emacs. Let's try
4077 ;; stty, instead.
4082 ;; Check whether the output of "uname -sr" has been changed. If
4083 ;; yes, this is a strong indication that we must expire all
4084 ;; connection properties. We start again with
4085 ;; `tramp-maybe-open-connection', it will be caught there.
4090 vec "uname"
4094 vec 3
4095 "Connection reset, because remote host changed from `%s' to `%s'"
4096 old-uname new-uname)
4097 ;; We want to keep the password.
4101 ;; Check whether the remote host suffers from buggy
4102 ;; `send-process-string'. This is known for FreeBSD (see comment in
4103 ;; `send_process', file process.c). I've tested sending 624 bytes
4104 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4105 ;; this host type is detected locally. It cannot handle remote
4106 ;; hosts, though.
4110 tramp-chunksize)
4118 ;; Set remote PATH variable.
4121 ;; Search for a good shell before searching for a command which
4122 ;; checks if a file exists. This is done because Tramp wants to use
4123 ;; "test foo; echo $?" to check if various conditions hold, and
4124 ;; there are buggy /bin/sh implementations which don't execute the
4125 ;; "echo $?" part if the "test" part has an error. In particular,
4126 ;; the OpenSolaris /bin/sh is a problem. There are also other
4127 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4128 ;; in function declarations, or changing HISTFILE in place.
4129 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4130 ;; detected.
4133 ;; Disable unexpected output.
4136 ;; IRIX64 bash expands "!" even when in single quotes. This
4137 ;; destroys our shell functions, we must disable it. See
4138 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4142 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4147 ;; Set `remote-tty' process property.
4152 ;; Dump stty settings in the traces.
4156 ;; Set the environment.
4161 unset vars item)
4171 vec
4173 tramp-end-of-heredoc
4175 tramp-end-of-heredoc)
4176 t))
4181 ;; Old text from documentation of tramp-methods:
4182 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4183 ;; of the base64 methods instead since base64 encoding is much more
4184 ;; reliable and the commands are more standardized between the different
4185 ;; Unix versions. But if you can't use base64 for some reason, please
4186 ;; note that the default uudecode command does not work well for some
4187 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4188 ;; the following command for uudecode:
4189 ;;
4190 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4191 ;;
4192 ;; For Irix, no solution is known yet.
4200 "List of local coding commands for inline transfer.
4201 Each item is a list that looks like this:
4203 \(FORMAT ENCODING DECODING\)
4205 FORMAT is symbol describing the encoding/decoding format. It can be
4206 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4208 ENCODING and DECODING can be strings, giving commands, or symbols,
4209 giving functions. If they are strings, then they can contain
4211 file name will be put into the command line at that spot. If the
4212 specifier is not present, the input should be read from standard
4213 input.
4215 If they are functions, they will be called with two arguments, start
4216 and end of region, and are expected to replace the region contents
4221 ;; "-i" is more robust with older base64 from GNU coreutils.
4222 ;; However, I don't know whether all base64 versions do supports
4223 ;; this option.
4235 "List of remote coding commands for inline transfer.
4236 Each item is a list that looks like this:
4238 \(FORMAT ENCODING DECODING [TEST]\)
4240 FORMAT is a symbol describing the encoding/decoding format. It can be
4241 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4243 ENCODING and DECODING can be strings, giving commands, or symbols,
4244 giving variables. If they are strings, then they can contain
4246 file name will be put into the command line at that spot. If the
4247 specifier is not present, the input should be read from standard
4248 input.
4250 If they are variables, this variable is a string containing a
4251 Perl or Shell implementation for this functionality. This
4252 program will be transferred to the remote host, and it is
4254 specifier in the variable value denotes a temporary file.
4256 The optional TEST command can be used for further tests, whether
4260 "Find an inline transfer encoding that works.
4261 Goes through the list `tramp-local-coding-commands' and
4262 `tramp-remote-coding-commands'."
4267 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4275 ;; If the local encoder or decoder is a string, the
4276 ;; corresponding command has to work locally.
4283 loc-enc nil nil))
4291 loc-dec nil nil))
4293 ;; Search for remote coding commands with the same format
4301 ;; Check the remote test command if exists.
4307 ;; Check if remote perl exists when necessary.
4311 ;; Check if remote encoding and decoding commands can be
4312 ;; called remotely with null input and output. This makes
4313 ;; sure there are no syntax errors and the command is really
4314 ;; found. Note that we do not redirect stdout to /dev/null,
4315 ;; for two reasons: when checking the decoding command, we
4316 ;; actually check the output it gives. And also, when
4317 ;; redirecting "mimencode" output to /dev/null, then as root
4318 ;; it might change the permissions of /dev/null!
4326 vec 5
4335 tmpfile)
4342 tramp-temp-name-prefix
4344 value
4346 value
4348 ?t
4354 vec 5
4357 vec
4359 t)
4367 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4373 ;; Set connection properties. Since the commands are risky
4374 ;; (due to output direction), we cache them in the process cache.
4385 "Call the local encoding or decoding command.
4387 Otherwise, INPUT is passed via standard input.
4388 INPUT can also be nil which means `/dev/null'.
4389 OUTPUT can be a string (which specifies a file name), or t (which
4390 means standard output and thus the current buffer), or nil (which
4391 means discard it)."
4393 nil tramp-encoding-shell
4396 nil
4397 tramp-encoding-command-switch
4407 "List of compress and decompress commands for inline transfer.
4408 Each item is a list that looks like this:
4410 \(COMPRESS DECOMPRESS\)
4415 "Find an inline transfer compress command that works.
4416 Goes through the list `tramp-inline-compress-commands'."
4421 item compress decompress found)
4428 vec 5
4429 "Checking local compress commands `%s', `%s' for sanity"
4430 compress decompress)
4435 ;; Windows shells need the program file name after
4436 ;; the pipe symbol be quoted if they use forward
4437 ;; slashes as directory separators.
4444 vec 5
4445 "Checking remote compress commands `%s', `%s' for sanity"
4446 compress decompress)
4452 ;; Did we find something?
4455 ;; Set connection properties. Since the commands are
4456 ;; risky (due to output direction), we cache them in the
4457 ;; process cache.
4471 "Expands VEC according to `tramp-default-proxies-alist'.
4472 Gateway hops are already opened."
4476 choices proxy)
4478 ;; Ad-hoc proxy definitions.
4483 tramp-prefix-format proxy tramp-postfix-host-format)))
4488 proxy)
4489 ;; Add the hop.
4491 'tramp-default-proxies-alist
4494 proxy))
4496 ;; Save the new value.
4501 ;; Look for proxy hosts to be passed.
4507 ;; Host.
4510 ;; User.
4514 ;; No more hops needed.
4516 ;; Replace placeholders.
4519 proxy
4524 ;; Add the hop.
4526 ;; Start next search.
4529 ;; Handle gateways.
4537 ;; Is the method prepared for gateways?
4540 vec 'file-error
4542 ;; Open the gateway connection.
4547 target-alist)
4548 ;; For the password prompt, we need the correct values.
4549 ;; Therefore, we must remember the gateway vector. But we
4550 ;; cannot do it as connection property, because it shouldn't
4551 ;; be persistent. And we have no started process yet either.
4555 ;; Foreign and out-of-band methods are not supported for multi-hops.
4568 vec 'file-error
4569 "Method `%s' is not supported for multi-hops."
4572 ;; In case the host name is not used for the remote shell
4573 ;; command, the user could be misguided by applying a random
4574 ;; host name.
4580 ;; There are multi-hops.
4582 ;; The host name is used for the remote shell command.
4585 ;; The host is local. We cannot use `tramp-local-host-p'
4586 ;; here, because it opens a connection as well.
4589 v 'file-error
4590 "Host `%s' looks like a remote host, `%s' can only use the local host"
4591 host method)))
4593 ;; Result.
4594 target-alist))
4597 "Return the Control* arguments of the local ssh."
4599 ;; No options to be computed.
4605 ;; There is already a value to be used.
4608 ;; Determine the options.
4620 ;; When we use a non-existing host name, we could run
4621 ;; into DNS timeouts. So we use "localhost" with an
4622 ;; improper port, expecting nobody runs sshd on the
4623 ;; telnet port.
4625 vec "ssh" nil t nil
4641 tramp-ssh-controlmaster-options)))
4644 "Maybe open a connection VEC.
4645 Does not do anything if a connection is already open, but re-opens the
4646 connection if a previous connection has died for some reason."
4654 ;; If Tramp opens the same connection within a short time frame,
4655 ;; there is a problem. We shall signal this.
4664 ;; If too much time has passed since last command was sent, look
4665 ;; whether process is still alive. If it isn't, kill it. When
4666 ;; using ssh, it can sometimes happen that the remote end has hung
4667 ;; up but the local ssh client doesn't recognize this until it
4668 ;; tries to send some data to the remote end. So that's why we
4669 ;; try to send a command from time to time, then look again
4670 ;; whether the process is really alive.
4681 ;; The error will be caught locally.
4687 ;; New connection must be opened.
4691 ;; If `non-essential' is non-nil, don't reopen a new connection.
4696 vec 3
4707 ;; Start new process.
4722 ;; We will apply `tramp-ssh-controlmaster-options'
4723 ;; only for the first hop.
4728 ;; This must be done in order to avoid our file
4729 ;; name handler.
4733 'start-process
4738 tramp-encoding-command-interactive)
4741 ;; Set sentinel and query flag.
4752 ;; Check whether process is alive.
4754 p 10
4757 ;; Now do all the connections as specified.
4787 ;; We don't create the temporary file. In
4788 ;; fact, it is just a prefix for the
4789 ;; ControlPath option of ssh; the real
4790 ;; temporary file has another name, and it is
4791 ;; created and protected by ssh. It is also
4792 ;; removed by ssh when the connection is
4793 ;; closed. The temporary file name is cached
4794 ;; in the main connection process, therefore
4795 ;; we cannot use `tramp-get-connection-process'.
4801 tramp-temp-name-prefix
4803 spec r-shell)
4805 ;; Add arguments for asynchronous processes.
4809 ;; Add gateway arguments if necessary.
4815 ;; Check for port number. Until now, there's no
4816 ;; need for handling like method, user, host.
4821 ;; Check, whether there is a restricted shell.
4826 ;; Set variables for computing the prompt for
4827 ;; reading password. They can also be derived
4828 ;; from a gateway.
4833 ;; Add login environment.
4836 login-env
4841 login-env))
4845 "%s=%s %s"
4848 command)))
4851 ;; Replace `login-args' place holders.
4859 ?h l-host ?u l-user ?p l-port ?c options)
4860 command
4862 ;; We do not want to see the trailing local
4863 ;; prompt in `start-file-process'.
4865 command " "
4871 ;; Local shell could be a Windows COMSPEC. It
4872 ;; doesn't know the ";" syntax, but we must exit
4873 ;; always for `start-file-process'. It could
4874 ;; also be a restricted shell, which does not
4875 ;; allow "exec".
4878 ;; Send the command.
4882 p vec pos tramp-actions-before-shell
4886 ;; Next hop.
4890 ;; Make initial shell settings.
4893 ;; When the user did interrupt, we must cleanup.
4896 ;; Propagate the quit signal.
4900 "Send the COMMAND to connection VEC.
4901 Erases temporary buffer before sending the command. If optional
4902 arg NEVEROPEN is non-nil, never try to open the connection. This
4903 is meant to be used from `tramp-maybe-open-connection' only. The
4904 function waits for output unless NOOUTPUT is set."
4908 ;; We mark the command string that it can be erased in the output buffer.
4910 ;; If we put `tramp-echo-mark' after a trailing newline (which
4911 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4912 ;; that newline and adds `tramp-rsh-end-of-line' right after
4913 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4914 ;; trailing line endings and sends two prompts after executing
4915 ;; the command, which confuses `tramp-wait-for-output'.
4919 ;; No need to restore a trailing newline here since `tramp-send-string'
4920 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4922 ;; Send the command.
4928 "Wait for output from remote command."
4934 ;; be leading escape sequences, which must be ignored.
4936 ;; Sometimes, the commands do not return a newline but a
4937 ;; null byte before the shell prompt, for example "git
4938 ;; ls-files -c -z ...".
4943 ;; A simple-minded busybox has sent " ^H" sequences.
4944 ;; Delete them.
4949 ;; Delete the prompt.
4955 proc 'file-error
4956 "[[Remote prompt `%s' not found in %d secs]]"
4957 tramp-end-of-output timeout)
4959 proc 'file-error
4961 ;; Return value is whether end-of-output sentinel was found.
4962 found)))
4966 "Run COMMAND and check its exit status.
4967 Sends `echo $?' along with the COMMAND for checking the exit status.
4968 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4969 status is 0, and nil otherwise.
4971 If the optional argument SUBSHELL is non-nil, the command is
4972 executed in a subshell, ie surrounded by parentheses. If
4973 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4975 vec
4977 command
4979 "echo tramp_exit_status $?"
4993 "Run COMMAND, check exit status, throw error if exit status not okay.
4994 Similar to `tramp-send-command-and-check' but accepts two more arguments
4995 FMT and ARGS which are passed to `error'."
5000 "Run COMMAND and return the output, which must be a Lisp expression.
5001 If MARKER is a regexp, read the output after that string.
5002 In case there is no valid Lisp expression and NOERROR is nil, it
5003 raises an error."
5010 ;; Read the marker.
5016 vec 'file-error
5017 "`%s' does not return the marker `%s': `%s'"
5019 ;; Read the expression.
5022 ;; Error handling.
5027 vec 'file-error
5028 "`%s' does not return a valid Lisp expression: `%s'"
5032 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5033 Convert file mode bits to string and set virtual device number.
5034 Return ATTR."
5036 ;; Remove color escape sequences from symlink.
5040 ;; Convert uid and gid. Use -1 as indication of unusable value.
5051 ;; Convert last access time.
5056 ;; Convert last modification time.
5061 ;; Convert last status change time.
5066 ;; Convert file size.
5072 ;; Convert file mode bits to string.
5077 ;; Convert directory indication bit.
5080 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5086 ;; Set file's gid change bit.
5094 ;; Convert inode.
5100 ;; Inodes can be incredible huge. We must hide this.
5102 ;; Set virtual device number.
5105 attr))
5108 "Converts STRING to shell glob pattern which ignores case."
5114 string
5118 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5128 localname)
5134 "Return t if this is an out-of-band method, nil otherwise."
5136 ;; It shall be an out-of-band method.
5138 ;; There must be a size, otherwise the file doesn't exist.
5140 ;; Either the file size is large enough, or (in rare cases) there
5141 ;; does not exist a remote encoding.
5146 ;; Variables local to connection.
5150 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5151 ;; cache the result for the session only. Otherwise, the result
5152 ;; is cached persistently.
5155 vec)
5156 "remote-path"
5165 ;; Default if "getconf" is not available.
5168 vec 3
5173 ;; The login shell could return more than just the $PATH
5174 ;; string. So we use `tramp-end-of-heredoc' as marker.
5177 vec
5183 'identity
5190 ;; Replace place holder `tramp-default-remote-path'.
5198 ;; Replace place holder `tramp-own-remote-path'.
5206 ;; Remove double entries.
5213 ;; Remove non-existing directories.
5215 nil
5225 x))
5226 x))
5227 remote-path)))))
5233 locale)
5240 candidates nil)
5242 ;; Return value.
5252 result)
5254 ;; Check parameters. On busybox, "ls" output coloring is
5255 ;; enabled by default sometimes. So we try to disable it
5256 ;; when possible. $LS_COLORING is not supported there.
5257 ;; Some "ls" versions are sensible wrt the order of
5258 ;; arguments, they fail when "-al" is after the
5259 ;; "--color=never" argument (for example on FreeBSD).
5274 ;; Some "ls" versions are sensible wrt the order of arguments,
5275 ;; they fail when "-al" is after the "--dired" argument (for
5276 ;; example on FreeBSD).
5284 ;; Some "ls" versions are sensible wrt the order of arguments,
5285 ;; they fail when "-al" is after the "--dired" argument (for
5286 ;; example on FreeBSD).
5295 "test"
5299 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5300 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5301 ;; for otherwise the shell crashes.
5313 vec
5336 ;; We must check also for some Perl modules.
5344 result)))
5351 tmp)
5352 ;; Check whether stat(1) returns usable syntax. "%s" does not
5353 ;; work on older AIX systems.
5362 result)))
5372 result))))
5388 ;; Busyboxes do support the "-t" option only when they have been
5389 ;; built with the DESKTOP config option. Let's check it.
5392 vec "touch-t"
5394 vec
5396 "%s -t %s %s"
5397 result
5401 result)))
5420 result)
5422 ;; Check POSIX parameter.
5429 vec
5438 vec
5442 "print $>"
5454 vec
5458 "import os; print (os.getuid())"
5472 ;; Ensure there is a valid result.
5480 vec
5489 vec
5498 vec
5502 "import os; print (os.getgid())"
5516 ;; Ensure there is a valid result.
5522 ;; Some predefined connection properties.
5524 "Return the compress command related to PROP.
5525 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5526 the length of the file to be compressed.
5528 If no corresponding command is found, nil is returned."
5537 "Return the coding command related to PROP.
5538 PROP is either `remote-encoding', `remote-decoding',
5539 `local-encoding' or `local-decoding'.
5541 SIZE is the length of the file to be coded. Depending on SIZE,
5542 compression might be applied.
5544 If no corresponding command is found, nil is returned.
5545 Otherwise, either a string is returned which contains a `%s' mark
5546 to be used for the respective input or output file; or a Lisp
5547 function cell is returned to be applied on a buffer."
5548 ;; We must catch the errors, because we want to return nil, when
5549 ;; no inline coding is found.
5559 compress)
5560 ;; The connection property might have been cached. So we must
5561 ;; send the script to the remote side - maybe.
5569 ;; Check for the `compress' command.
5571 ;; Return the value.
5591 'call-process-region beg end
5596 coding)
5599 ;; Windows shells need the program file name after
5600 ;; the pipe symbol be quoted if they use forward
5601 ;; slashes as directory separators.
5608 coding compress))
5611 ;; Windows shells need the program file name after
5612 ;; the pipe symbol be quoted if they use forward
5613 ;; slashes as directory separators.
5618 compress coding))
5632 ;;; TODO:
5634 ;; * Don't use globbing for directories with many files, as this is
5635 ;; likely to produce long command lines, and some shells choke on
5636 ;; long command lines.
5637 ;; * Make it work for different encodings, and for different file name
5638 ;; encodings, too. (Daniel Pittman)
5639 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5640 ;; then look if it's the right version (with `perl -v').
5641 ;; * When editing a remote CVS controlled file as a different user, VC
5642 ;; gets confused about the file locking status. Try to find out why
5643 ;; the workaround doesn't work.
5644 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5645 ;; until the last but one hop via `start-file-process'. Apply it
5646 ;; also for ftp and smb.
5647 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5648 ;; some shell with root privileges, it would be nice if I could
5649 ;; just call
5650 ;; trampclient filename.c
5651 ;; as an editor, and the _current_ shell would connect to an Emacs
5652 ;; server and would be used in an existing non-privileged Emacs
5653 ;; session for doing the editing in question.
5654 ;; That way, I need not tell Emacs my password again and be afraid
5655 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5656 ;; once display a just typed password in the context of a keyboard
5657 ;; sequence prompt for a question immediately following in a shell
5658 ;; script run within Emacs -- nasty).
5659 ;; And if I have some ssh session running to a different computer,
5660 ;; having the possibility of passing a local file there to a local
5661 ;; Emacs session (in case I can arrange for a connection back) would
5662 ;; be nice.
5663 ;; Likely the corresponding Tramp server should not allow the
5664 ;; equivalent of the emacsclient -eval option in order to make this
5665 ;; reasonably unproblematic. And maybe trampclient should have some
5666 ;; way of passing credentials, like by using an SSL socket or
5667 ;; something. (David Kastrup)
5668 ;; * Reconnect directly to a compliant shell without first going
5669 ;; through the user's default shell. (Pete Forman)
5670 ;; * How can I interrupt the remote process with a signal
5671 ;; (interrupt-process seems not to work)? (Markus Triska)
5672 ;; * Avoid the local shell entirely for starting remote processes. If
5673 ;; so, I think even a signal, when delivered directly to the local
5674 ;; SSH instance, would correctly be propagated to the remote process
5675 ;; automatically; possibly SSH would have to be started with
5676 ;; "-t". (Markus Triska)
5677 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5678 ;; isn't on the remote host. (Mark A. Hershberger)
5679 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5680 ;; * Optimize out-of-band copying when both methods are scp-like (not
5681 ;; rsync).
5682 ;; * Keep a second connection open for out-of-band methods like scp or
5683 ;; rsync.
5685 ;;; tramp-sh.el ends here