| blob | a5d09af10a601695fe2213644980107dab737bc1 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2016 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.
42 ;;;###tramp-autoload
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."
51 ;;;###tramp-autoload
53 "The maximum file size where inline copying is preferred over an \
54 out-of-the-band copy.
55 If it is nil, out-of-the-band copy will be used without a check."
59 ;;;###tramp-autoload
61 "Value of TERM environment variable for logging in to remote host.
62 Because Tramp wants to parse the output of the remote shell, it is easily
63 confused by ANSI color escape sequences and suchlike. Often, shell init
64 files conditionalize this setup based on the TERM environment variable."
68 ;;;###tramp-autoload
70 "When invoking a shell, override the HISTFILE with this value.
71 When setting to a string, it redirects the shell history to that
75 The value t, the default value, unsets any setting of HISTFILE,
76 and sets both HISTFILESIZE and HISTSIZE to 0. If you set this
77 variable to nil, however, the *override* is disabled, so the
78 history will go to the default storage location,
86 ;;;###tramp-autoload
90 ;;;###tramp-autoload
94 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
95 ;; root users. It uses the `$' character for other users. In order
96 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
100 "///%s#$"
102 "String used to recognize end of output.
103 The `$' character at the end is quoted; the string cannot be
106 ;;;###tramp-autoload
113 ;;;###tramp-autoload
115 "Whether to use `tramp-ssh-controlmaster-options'."
121 "Which ssh Control* arguments to use.
123 If it is a string, it should have the form
126 spec must be doubled, because the string is used as format string.
128 Otherwise, it will be auto-detected by Tramp, if
129 `tramp-use-ssh-controlmaster-options' is non-nil. The value
130 depends on the installed local ssh version.
134 ;; Initialize `tramp-methods' with the supported methods.
135 ;;;###tramp-autoload
147 ;;;###tramp-autoload
158 ;;;###tramp-autoload
176 ;;;###tramp-autoload
195 ;;;###tramp-autoload
211 ;;;###tramp-autoload
219 ;;;###tramp-autoload
227 ;;;###tramp-autoload
241 ;;;###tramp-autoload
255 ;;;###tramp-autoload
264 ;;;###tramp-autoload
273 ;; We use "-v" for better error tracking.
276 ;; We use "-p" as required for newer busyboxes. For older
277 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
278 ;; can be achieved by tweaking `tramp-connection-properties'.
281 ;;;###tramp-autoload
290 ;;;###tramp-autoload
292 'tramp-methods
299 ;;;###tramp-autoload
303 ;; The password template must be masked. Otherwise, it could be
304 ;; interpreted as password prompt if the remote host echoes the command.
307 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
313 ;;;###tramp-autoload
321 ;;;###tramp-autoload
330 ;;;###tramp-autoload
338 ;;;###tramp-autoload
342 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
346 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
347 tramp-terminal-type
348 tramp-initial-end-of-output))
354 ;;;###tramp-autoload
360 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
361 tramp-terminal-type
362 tramp-initial-end-of-output))
367 ;;;###tramp-autoload
374 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
375 tramp-terminal-type
376 tramp-initial-end-of-output))
387 ;;;###tramp-autoload
394 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
395 tramp-terminal-type
396 tramp-initial-end-of-output))
405 ;;;###tramp-autoload
417 ;;;###tramp-autoload
421 ;;;###tramp-autoload
425 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
426 ;; Do not add "plink" based methods, they ask interactively for the user.
427 ;;;###tramp-autoload
436 ;;;###tramp-autoload
442 ;;;###tramp-autoload
458 ;;;###tramp-autoload
463 ;;;###tramp-autoload
468 ;;;###tramp-autoload
473 ;;;###tramp-autoload
481 ;;;###tramp-autoload
510 ;; "getconf PATH" yields:
511 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
512 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
513 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
514 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
515 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
516 ;; IRIX64: /usr/bin
517 ;;;###tramp-autoload
523 "List of directories to search for executables on remote host.
524 For every remote host, this variable will be set buffer local,
525 keeping the list of existing directories on that host.
527 You can use `~' in this list, but when searching for a shell which groks
528 tilde expansion, all directory names starting with `~' will be ignored.
530 `Default Directories' represent the list of directories given by
532 entry on top of this list, because these are the default
533 directories for POSIX compatible commands. On remote hosts which
534 do not offer the getconf command (like cygwin), the value
537 `Private Directories' are the settings of the $PATH environment,
538 as given in your `~/.profile'."
545 ;;;###tramp-autoload
552 "List of environment variables to be set on the remote host.
554 Each element should be a string of the form ENVVARNAME=VALUE. An
555 entry ENVVARNAME= disables the corresponding environment variable,
556 which might have been set in the init files like ~/.profile.
558 Special handling is applied to the PATH environment, which should
559 not be set here. Instead, it should be set via `tramp-remote-path'."
564 ;;;###tramp-autoload
566 "Alist specifying extra arguments to pass to the remote shell.
567 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
568 matching the shell file name and ARGS is a string specifying the
569 arguments.
571 This variable is only used when Tramp needs to start up another shell
572 for tilde expansion. The extra arguments should typically prevent the
573 shell from reading its init file."
575 ;; This might be the wrong way to test whether the widget type
576 ;; `alist' is available. Who knows the right way to test it?
591 "List of pattern/action pairs.
592 Whenever a pattern matches, the corresponding action is performed.
593 Each item looks like (PATTERN ACTION).
595 The PATTERN should be a symbol, a variable. The value of this
596 variable gives the regular expression to search for. Note that the
598 appended to it.
600 The ACTION should also be a symbol, but a function. When the
608 "List of pattern/action pairs.
609 This list is used for copying/renaming with out-of-band methods.
614 "(echo begin 600 %t; tail -n +2) | uudecode
615 cat %t
616 rm -f %t"
617 "Shell function to implement `uudecode' to standard output.
618 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
619 for this or `uudecode -p', but some systems don't, and for them
623 "%s -e '
624 use File::Spec;
627 sub myrealpath {
628 my ($file) = @_;
629 return realpath($file) if -e $file;
630 }
632 sub recursive {
633 my ($volume, @dirs) = @_;
634 my $real = myrealpath(File::Spec->catpath(
636 if ($real) {
637 my ($vol, $dir) = File::Spec->splitpath($real, 1);
638 return ($vol, File::Spec->splitdir($dir));
639 }
640 else {
641 my $last = pop(@dirs);
642 ($volume, @dirs) = recursive($volume, @dirs);
643 push(@dirs, $last);
644 return ($volume, @dirs);
645 }
646 }
648 $result = myrealpath($ARGV[0]);
649 if (!$result) {
650 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
651 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
654 }
659 "Perl script to produce output suitable for use with `file-truename'
660 on the remote file system.
661 Escape sequence %s is replaced with name of Perl binary.
665 "%s -e 'sub case {
666 my $str = shift;
667 if ($ARGV[2]) {
668 return lc($str);
669 }
670 else {
671 return $str;
672 }
673 }
675 @files = readdir(d); closedir(d);
676 foreach $f (@files) {
677 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
680 }
681 else {
683 }
684 }
685 }
688 "Perl script to produce output suitable for use with
689 `file-name-all-completions' on the remote file system. Escape
690 sequence %s is replaced with name of Perl binary. This string is
693 ;; Perl script to implement `file-attributes' in a Lisp `read'able
694 ;; output. If you are hacking on this, note that you get *no* output
695 ;; unless this spits out a complete line, including the '\n' at the
696 ;; end.
697 ;; The device number is returned as "-1", because there will be a virtual
698 ;; device number set in `tramp-sh-handle-file-attributes'.
700 "%s -e '
701 @stat = lstat($ARGV[0]);
702 if (!@stat) {
704 exit 0;
705 }
706 if (($stat[2] & 0170000) == 0120000)
707 {
708 $type = readlink($ARGV[0]);
711 }
712 elsif (($stat[2] & 0170000) == 040000)
713 {
715 }
716 else
717 {
719 };
722 printf(
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
739 "Perl script to produce output suitable for use with `file-attributes'
740 on the remote file system.
741 Escape sequence %s is replaced with name of Perl binary.
745 "%s -e '
748 @list = readdir(DIR);
749 closedir(DIR);
750 $n = scalar(@list);
752 for($i = 0; $i < $n; $i++)
753 {
754 $filename = $list[$i];
755 @stat = lstat($filename);
756 if (($stat[2] & 0170000) == 0120000)
757 {
758 $type = readlink($filename);
761 }
762 elsif (($stat[2] & 0170000) == 040000)
763 {
765 }
766 else
767 {
769 };
773 printf(
774 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
775 $filename,
776 $type,
777 $stat[3],
778 $uid,
779 $gid,
780 $stat[8] >> 16 & 0xffff,
781 $stat[8] & 0xffff,
782 $stat[9] >> 16 & 0xffff,
783 $stat[9] & 0xffff,
784 $stat[10] >> 16 & 0xffff,
785 $stat[10] & 0xffff,
786 $stat[7],
787 $stat[2],
788 $stat[1] >> 16 & 0xffff,
789 $stat[1] & 0xffff,
790 $stat[0] >> 16 & 0xffff,
791 $stat[0] & 0xffff);
792 }
794 "Perl script implementing `directory-files-attributes' as Lisp `read'able
795 output.
796 Escape sequence %s is replaced with name of Perl binary.
799 ;; These two use base64 encoding.
801 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
802 "Perl program to use for encoding a file.
803 Escape sequence %s is replaced with name of Perl binary.
804 This string is passed to `format', so percent characters need to be doubled.
805 This implementation requires the MIME::Base64 Perl module to be installed
809 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
810 "Perl program to use for decoding a file.
811 Escape sequence %s is replaced with name of Perl binary.
812 This string is passed to `format', so percent characters need to be doubled.
813 This implementation requires the MIME::Base64 Perl module to be installed
817 "%s -e '
818 # This script contributed by Juanma Barranquero <lektu@terra.es>.
819 # Copyright (C) 2002-2016 Free Software Foundation, Inc.
820 use strict;
822 my %%trans = do {
823 my $i = 0;
824 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
825 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
826 };
827 my $data;
829 # We read in chunks of 54 bytes, to generate output lines
830 # of 72 chars (plus end of line)
831 while (read STDIN, $data, 54) {
832 my $pad = q();
834 # Only for the last chunk, and only if did not fill the last three-byte packet
835 if (eof) {
836 my $mod = length($data) %% 3;
837 $pad = q(=) x (3 - $mod) if $mod;
838 }
840 # Not the fastest method, but it is simple: unpack to binary string, split
841 # by groups of 6 bits and convert back from binary to byte; then map into
842 # the translation table
843 print
844 join q(),
845 map($trans{$_},
846 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
847 $pad,
849 }' 2>/dev/null"
850 "Perl program to use for encoding a file.
851 Escape sequence %s is replaced with name of Perl binary.
855 "%s -e '
856 # This script contributed by Juanma Barranquero <lektu@terra.es>.
857 # Copyright (C) 2002-2016 Free Software Foundation, Inc.
858 use strict;
860 my %%trans = do {
861 my $i = 0;
862 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
863 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
864 };
866 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
870 # We are going to accumulate into $pending to accept any line length
871 # (we do not check they are <= 76 chars as the RFC says)
872 my $pending = q();
874 while (my $data = <STDIN>) {
875 chomp $data;
877 # If we find one or two =, we have reached the end and
878 # any following data is to be discarded
879 my $finished = $data =~ s/(==?).*/$1/;
880 $pending .= $data;
882 my $len = length($pending);
883 my $chunk = substr($pending, 0, $len & ~3);
884 $pending = substr($pending, $len & ~3 + 1);
886 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
887 # split in 8-bit chunks and convert back to char.
888 print join q(),
889 map $bytes{$_},
890 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
892 last if $finished;
893 }' 2>/dev/null"
894 "Perl program to use for decoding a file.
895 Escape sequence %s is replaced with name of Perl binary.
899 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
900 "Perl program to use for encoding a file.
904 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
905 "Perl program to use for decoding a file.
910 BEGIN {
913 }
914 {
915 for (c=1; c<=length($0); c++) {
916 d=index(b16, substr($0,c,1))
917 if (d--) {
918 for (b=1; b<=4; b++) {
919 o=o*2+int(d/8); d=(d*2)%%16
920 if (++obc==6) {
921 printf substr(b64,o+1,1)
923 obc=0; o=0
924 }
925 }
926 }
927 }
928 }
929 END {
930 if (obc) {
932 while (obc++<6) { o=o*2 }
934 } else {
936 }
937 printf tail
938 }'"
939 "Awk program to use for encoding a file.
944 BEGIN {
946 }
947 {
948 for (i=1; i<=length($0); i++) {
949 c=index(b64, substr($0,i,1))
950 if(c--) {
951 for(b=0; b<6; b++) {
952 o=o*2+int(c/32); c=(c*2)%%64
953 if(++obc==8) {
954 if (o) {
956 } else {
958 }
959 obc=0; o=0
960 }
961 }
962 }
963 }
964 }'"
965 "Awk program to use for decoding a file.
969 "test -c /dev/zero && \
970 od -v -t x1 -A n </dev/null && \
971 busybox awk '{}' </dev/null"
982 while read file; do
985 else
987 fi
990 else
992 fi
993 done
995 "Script to check existence of VC related files.
996 It must be send formatted with two strings; the tests for file
997 existence, and file readability. Input shall be read via
998 here-document, otherwise the command could exceed maximum length
1001 ;; New handlers should be added here.
1005 ;; `byte-compiler-base-file-name' performed by default handler.
1010 ;; `diff-latest-backup-file' performed by default handler.
1014 . tramp-sh-handle-directory-files-and-attributes)
1033 ;; `file-name-sans-versions' performed by default handler.
1047 ;; `find-file-noselect' performed by default handler.
1048 ;; `get-file-buffer' performed by default handler.
1069 "Alist of handler functions.
1072 ;; This must be the last entry, because `identity' always matches.
1073 ;;;###tramp-autoload
1077 ;;; File Name Handler Functions:
1081 "Like `make-symbolic-link' for Tramp files.
1082 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1083 the symlink. If LINKNAME is a Tramp file, only the localname component is
1084 used as the target of the symlink.
1086 If LINKNAME is a Tramp file and the localname component is relative, then
1087 it is expanded first, before the localname component is taken. Note that
1088 this can give surprising results if the user/host for the source and
1089 target of the symlink differ."
1096 l 'file-error
1099 ;; Do the 'confirm if exists' thing.
1101 ;; What to do?
1106 "File %s already exists; make it a link anyway? "
1107 l-localname)))))
1112 ;; If FILENAME is a Tramp name, use just the localname component.
1121 ;; Right, they are on the same host, regardless of user, method,
1122 ;; etc. We now make the link on the remote machine. This will
1123 ;; occur as the user that FILENAME belongs to.
1128 "%s -sf %s %s"
1129 ln
1131 ;; The command could exceed PATH_MAX, so we use
1132 ;; relative file names. However, relative file names
1133 ;; could start with "-". `tramp-shell-quote-argument'
1134 ;; does not handle this, we must do it ourselves.
1139 "Like `file-truename' for Tramp files."
1141 "%s%s"
1144 method user host
1149 ;; Use GNU readlink --canonicalize-missing where available.
1152 v
1160 ;; Use Perl implementation.
1168 v
1172 ;; Do it yourself.
1176 ;; Don't make the following value larger than
1177 ;; necessary. People expect an error message in a
1178 ;; timely fashion when something is wrong;
1179 ;; otherwise they might think that Emacs is hung.
1180 ;; Of course, correctness has to come first.
1182 symlink-target)
1193 method user host
1205 ;; It's a symlink, follow it.
1211 ;; If the symlink was absolute, we'll get a
1212 ;; string like "/user@host:/some/target";
1213 ;; extract the "/some/target" part from it.
1217 v 'file-error
1218 "Symlink target `%s' on wrong host"
1219 symlink-target))
1225 ;; It's a file.
1229 v 'file-error
1232 ;; Combine list to form string.
1241 result))))
1243 ;; Preserve trailing "/".
1246 ;; Basic functions.
1249 "Like `file-exists-p' for Tramp files."
1257 v
1259 "%s %s"
1264 "Like `file-attributes' for Tramp files."
1267 ;; Don't modify `last-coding-system-used' by accident.
1274 v
1282 ;; The scripts could fail, for example with huge file size.
1286 "Implement `file-attributes' for Tramp files using the ls(1) command."
1288 res-inode res-filemodes res-numlinks
1289 res-uid res-gid res-size res-symlink-target)
1291 ;; We cannot send all three commands combined, it could exceed
1292 ;; NAME_MAX or PATH_MAX. Happened on Mac OS X, for example.
1294 vec
1299 vec
1304 vec
1308 ;; On systems which have no quoting style, file names
1309 ;; with special characters could fail.
1317 ;; Parse `ls -l' output ...
1321 ;; ... inode
1337 ;; ... file mode flags
1339 ;; ... number links
1341 ;; ... uid and gid
1353 ;; ... size
1355 ;; From the file modes, figure out other stuff.
1358 ;; If symlink, find out file name pointed to.
1365 ;; Return data gathered.
1367 ;; 0. t for directory, string (name linked to) for symbolic
1368 ;; link, or nil.
1370 ;; 1. Number of links to file.
1371 res-numlinks
1372 ;; 2. File uid.
1373 res-uid
1374 ;; 3. File gid.
1375 res-gid
1376 ;; 4. Last access time, as a list of integers. Normally
1377 ;; this would be in the same format as `current-time', but
1378 ;; the subseconds part is not currently implemented, and
1379 ;; (0 0) denotes an unknown time.
1380 ;; 5. Last modification time, likewise.
1381 ;; 6. Last status change time, likewise.
1383 ;; 7. Size in bytes (-1, if number is out of range).
1384 res-size
1385 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1386 res-filemodes
1387 ;; 9. t if file's gid would change if file were deleted and
1388 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1389 t
1390 ;; 10. Inode number.
1391 res-inode
1392 ;; 11. Device number. Will be replaced by a virtual device number.
1397 "Implement `file-attributes' for Tramp files using a Perl script."
1402 vec
1408 "Implement `file-attributes' for Tramp files using stat(1) command."
1411 vec
1414 ;; On Opsware, pdksh (which is the true name of ksh there)
1415 ;; doesn't parse correctly the sequence "((". Therefore, we add
1416 ;; a space. Apostrophes in the stat output are masked as
1417 ;; `tramp-stat-marker', in order to make a proper shell escape of
1418 ;; them in file names.
1419 "( (%s %s || %s -h %s) && (%s -c "
1420 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1427 tramp-stat-marker tramp-stat-marker
1432 tramp-stat-marker tramp-stat-marker
1434 tramp-stat-quoted-marker)))
1437 "Like `set-visited-file-modtime' for Tramp files."
1444 coding-system-used)
1448 ;; '(-1 65535) means file doesn't exists yet.
1451 ;; We use '(0 0) as a don't-know value. See also
1452 ;; `tramp-do-file-attributes-with-ls'.
1457 v
1465 nil)))))
1467 ;; This function makes the same assumption as
1468 ;; `tramp-sh-handle-set-visited-file-modtime'.
1470 "Like `verify-visited-file-modtime' for Tramp files.
1471 At the time `verify-visited-file-modtime' calls this function, we
1472 already know that the buffer is visiting a file and that
1473 `visited-file-modtime' does not return 0. Do not call this
1474 function directly, unless those two cases are already taken care
1475 of."
1478 ;; There is no file visiting the buffer, or the buffer has no
1479 ;; recorded last modification time, or there is no established
1480 ;; connection.
1484 t
1492 ;; File exists, and has a known modtime.
1495 modtime
1496 ;; For compatibility, deal with both the old
1497 ;; (HIGH . LOW) and the new (HIGH LOW) return
1498 ;; values of `visited-file-modtime'.
1501 mt)))
1503 ;; Modtime has the don't know value.
1506 v
1513 attr
1516 ;; If file does not exist, say it is not modified if and
1517 ;; only if that agrees with the buffer's record.
1521 "Like `set-file-modes' for Tramp files."
1525 ;; FIXME: extract the proper text from chmod's stderr.
1527 v
1532 "Like `set-file-times' for Tramp files."
1539 time)))
1542 "env TZ=UTC %s %s %s"
1550 "Set the ownership for FILENAME.
1551 If UID and GID are provided, these values are used; otherwise uid
1552 and gid of the corresponding user is taken. Both parameters must
1553 be non-negative integers."
1554 ;; Modern Unices allow chown only for root. So we might need
1555 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1556 ;; working with su(do)? when it is needed, so it shall succeed in
1557 ;; the majority of cases.
1558 ;; Don't modify `last-coding-system-used' by accident.
1563 ;; If we are root on the local host, we can do it directly.
1571 "chown %d:%d %s" uid gid
1574 ;; We handle also the local part, because there doesn't exist
1575 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1576 ;; timeout for this.
1581 nil "chown" nil nil nil
1585 "Check, whether SELINUX is enabled on the remote host."
1590 "Like `file-selinux-context' for Tramp files."
1599 "%s -d -Z %s"
1607 ;; Return the context.
1608 context))))
1611 "Like `set-file-selinux-context' for Tramp files."
1631 t)))))
1634 "Check, whether ACL is enabled on the remote host."
1639 "Like `file-acl' for Tramp files."
1645 "getfacl -ac %s"
1654 "Like `set-file-acl' for Tramp files."
1661 tramp-end-of-heredoc
1662 acl-string
1663 tramp-end-of-heredoc))
1665 ;; Success.
1668 t)
1669 ;; In case of errors, we return nil.
1671 nil)))
1673 ;; Simple functions using the `test' command.
1676 "Like `file-executable-p' for Tramp files."
1679 ;; Examine `file-attributes' cache to see if request can be
1680 ;; satisfied without remote operation.
1685 "Like `file-readable-p' for Tramp files."
1688 ;; Examine `file-attributes' cache to see if request can be
1689 ;; satisfied without remote operation.
1693 ;; When the remote shell is started, it looks for a shell which groks
1694 ;; tilde expansion. Here, we assume that all shells which grok tilde
1695 ;; expansion will also provide a `test' command which groks `-nt' (for
1696 ;; newer than). If this breaks, tell me about it and I'll try to do
1697 ;; something smarter about it.
1699 "Like `file-newer-than-file-p' for Tramp files."
1701 nil)
1703 t)
1704 ;; We are sure both files exist at this point.
1707 ;; We try to get the mtime of both files. If they are not
1708 ;; equal to the "dont-know" value, then we subtract the times
1709 ;; and obtain the result.
1715 ;; If one of them is the dont-know value, then we can
1716 ;; still try to run a shell command on the remote host.
1717 ;; However, this only works if both files are Tramp
1718 ;; files and both have the same method, same user, same
1719 ;; host.
1724 v 'file-error
1725 "Files %s and %s must have same method, user, host"
1726 file1 file2)))
1731 ;; Functions implemented using the basic functions above.
1734 "Like `file-directory-p' for Tramp files."
1736 ;; `file-directory-p' is used as predicate for file name completion.
1737 ;; Sometimes, when a connection is not established yet, it is
1738 ;; desirable to return t immediately for "/method:foo:". It can
1739 ;; be expected that this is always a directory.
1745 "Like `file-writable-p' for Tramp files."
1749 ;; Examine `file-attributes' cache to see if request can be
1750 ;; satisfied without remote operation.
1753 ;; If file doesn't exist, check if directory is writable.
1758 "Like `file-ownership-preserved-p' for Tramp files."
1762 ;; Return t if the file doesn't exist, since it's true that no
1763 ;; information would be lost by an (attempted) delete and create.
1770 ;; Directory listings.
1774 "Like `directory-files-and-attributes' for Tramp files."
1782 v localname
1793 v localname id-format))
1796 v localname id-format))
1798 result item)
1808 result
1810 ;; The scripts could fail, for example with huge file size.
1812 directory full match nosort id-format)))))
1816 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1819 vec tramp-perl-directory-files-and-attributes
1823 vec
1827 object))
1831 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1834 vec
1837 ;; We must care about file names with spaces, or starting with
1838 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1839 ;; but it does not work on all remote systems. Apostrophes in
1840 ;; the stat output are masked as `tramp-stat-marker', in order to
1841 ;; make a proper shell escape of them in file names.
1843 "xargs %s -c "
1844 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1848 ;; On systems which have no quoting style, file names with special
1849 ;; characters could fail.
1857 tramp-stat-marker tramp-stat-marker
1858 tramp-stat-marker tramp-stat-marker
1863 tramp-stat-marker tramp-stat-marker
1864 tramp-stat-quoted-marker)))
1866 ;; This function should return "foo/" for directories and "bar" for
1867 ;; files.
1869 "Like `file-name-all-completions' for Tramp files."
1874 filename
1876 'list
1878 ;; Try cache entries for `filename', `filename' with last
1879 ;; character removed, `filename' with last two characters
1880 ;; removed, ..., and finally the empty string - all
1881 ;; concatenated to the local directory name.
1884 tramp-completion-reread-directory-timeout)))
1886 ;; This is inefficient for very long file names, pity
1887 ;; `reduce' is not available...
1890 'append
1895 v
1897 "file-name-all-completions"
1898 nil)))
1900 ;; We cannot use a length of 0, because file properties
1901 ;; for "foo" and "foo/" are identical.
1904 ;; Cache expired or no matching cache entry found so we need
1905 ;; to perform a remote operation.
1907 ;; Get a list of directories and files, including reliably
1908 ;; tagging the directories with a trailing '/'. Because I
1909 ;; rock. --daniel@danann.net
1911 ;; Changed to perform `cd' in the same remote op and only
1912 ;; get entries starting with `filename'. Capture any `cd'
1913 ;; error messages. Ensure any `cd' and `echo' aliases are
1914 ;; ignored.
1916 v
1920 v tramp-perl-file-name-all-completions
1928 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1929 ;; `ls' with wildcard might fail with `Argument
1930 ;; list too long' error in some corner cases; if
1931 ;; `ls' fails after `cd' succeeded, chances are
1932 ;; that's the case, so let's retry without
1933 ;; wildcard. This will return "too many" entries
1934 ;; but that isn't harmful.
1935 " || %s -a 2>/dev/null)"
1936 " | while IFS= read f; do"
1942 ;; When `filename' is empty, just `ls' without
1943 ;; `filename' argument is more efficient than `ls *'
1944 ;; for very large directories and might avoid the
1945 ;; `Argument list too long' error.
1946 ;;
1947 ;; With and only with wildcard, we need to add
1948 ;; `-d' to prevent `ls' from descending into
1949 ;; sub-directories.
1951 "."
1956 ;; Now grab the output.
1960 ;; Check result code, found in last line of output.
1964 ;; Grab error message from line before last line
1965 ;; (it was put there by `cd 2>&1').
1968 v 'file-error
1969 "tramp-sh-handle-file-name-all-completions: %s"
1971 ;; For peace of mind, if buffer doesn't end in `fail'
1972 ;; then it should end in `ok'. If neither are in the
1973 ;; buffer something went seriously wrong on the remote
1974 ;; side.
1977 v 'file-error
1978 "\
1979 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1985 ;; Because the remote op went through OK we know the
1986 ;; directory we `cd'-ed to exists.
1989 ;; Because the remote op went through OK we know every
1990 ;; file listed by `ls' exists.
1994 result)
1996 ;; Store result in the cache.
2001 ;; cp, mv and ln
2005 "Like `add-name-to-file' for Tramp files."
2010 v 'file-error
2011 "add-name-to-file: %s"
2020 "File %s already exists; make it a new name anyway? "
2021 newname)))
2028 v1
2032 "error with add-name-to-file, see buffer `%s' for details"
2037 preserve-uid-gid preserve-extended-attributes)
2038 "Like `copy-file' for Tramp files."
2042 ;; At least one file a Tramp file?
2046 'copy filename newname ok-if-already-exists keep-date
2047 preserve-uid-gid preserve-extended-attributes))
2048 ;; Compat section. PRESERVE-EXTENDED-ATTRIBUTES has been
2049 ;; introduced with Emacs 24.1 (as PRESERVE-SELINUX-CONTEXT), and
2050 ;; renamed in Emacs 24.3.
2053 'copy-file
2055 preserve-uid-gid preserve-extended-attributes)))
2058 'copy-file
2063 "Like `copy-directory' for Tramp files."
2069 ;; When DIRNAME and NEWNAME are remote, they must have
2070 ;; the same method.
2076 ;; scp or rsync DTRT.
2090 ;; We must do it file-wise.
2092 'copy-directory
2097 ;; When newname did exist, we have wrong cached values.
2105 "Like `rename-file' for Tramp files."
2106 ;; Check if both files are local -- invoke normal rename-file.
2107 ;; Otherwise, use Tramp from local system.
2110 ;; At least one file a Tramp file?
2114 'rename filename newname ok-if-already-exists
2121 preserve-uid-gid preserve-extended-attributes)
2122 "Copy or rename a remote file.
2123 OP must be `copy' or `rename' and indicates the operation to perform.
2124 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2125 the new file (for copy) or the new name of the file (for rename).
2126 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2127 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2128 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2129 the uid and gid if both files are on the same host.
2130 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2132 This function is invoked by `tramp-sh-handle-copy-file' and
2133 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2134 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2135 file names."
2152 filename newname)
2155 ;; Both are Tramp files.
2160 ;; Shortcut: if method, host, user are the same for
2161 ;; both files, we invoke `cp' or `mv' on the remote
2162 ;; host directly.
2165 op filename newname
2166 ok-if-already-exists keep-date preserve-uid-gid))
2168 ;; Try out-of-band operation.
2173 op filename newname keep-date))
2175 ;; No shortcut was possible. So we copy the file
2176 ;; first. If the operation was `rename', we go back
2177 ;; and delete the original file (if the copy was
2178 ;; successful). The approach is simple-minded: we
2179 ;; create a new buffer, insert the contents of the
2180 ;; source file into it, then write out the buffer to
2181 ;; the target file. The advantage is that it doesn't
2182 ;; matter which file name handlers are used for the
2183 ;; source and target file.
2186 op filename newname keep-date))))))
2188 ;; One file is a Tramp file, the other one is local.
2191 ;; Fast track on local machine.
2194 op filename newname
2195 ok-if-already-exists keep-date preserve-uid-gid))
2197 ;; If the Tramp file has an out-of-band method, the
2198 ;; corresponding copy-program can be invoked.
2201 op filename newname keep-date))
2203 ;; Use the inline method via a Tramp buffer.
2205 op filename newname keep-date))))
2208 ;; One of them must be a Tramp file.
2211 ;; Handle `preserve-extended-attributes'. We ignore possible
2212 ;; errors, because ACL strings could be incompatible.
2217 ;; In case of `rename', we must flush the cache of the source file.
2223 ;; When newname did exist, we have wrong cached values.
2230 "Use an Emacs buffer to copy or rename a file.
2231 First arg OP is either `copy' or `rename' and indicates the operation.
2232 FILENAME is the source file, NEWNAME the target file.
2233 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2234 ;; We must disable multibyte, because binary data shall not be
2235 ;; converted. We don't want the target file to be compressed, so we
2236 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2237 ;; be called either. We remove `tramp-file-name-handler' from
2238 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2239 ;; `insert-file-contents' might be deactivated in some corner cases.
2250 ;; KEEP-DATE handling.
2252 ;; Set the mode.
2254 ;; If the operation was `rename', delete the original file.
2259 "Invokes `cp' or `mv' on the remote system.
2260 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2261 respectively. FILENAME specifies the file to copy or rename,
2262 NEWNAME is the name of the new file (for copy) or the new name of
2263 the file (for rename). Both files must reside on the same host.
2264 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2265 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2266 the uid and gid from FILENAME."
2276 v 'file-error
2277 "Unknown operation `%s', must be `copy' or `rename'"
2278 op))))
2282 filename))
2286 newname))
2288 cmd-result)
2291 ;; Both files are on a remote host, with same user.
2303 ;; Mask cp -f error.
2305 tramp-operation-not-permitted-regexp nil t))
2306 cmd-result)
2308 nil v 'file-error
2309 "Copying directly failed, see buffer `%s' for details."
2312 ;; We are on the local host.
2315 ;; We can do it directly.
2318 ;; No sticky bit when renaming.
2329 localname1 localname2 ok-if-already-exists
2330 keep-date preserve-uid-gid)
2334 ;; We can do it directly with `tramp-send-command'
2342 ok-if-already-exists keep-date t)
2343 ;; We must change the ownership to the local user.
2349 ;; We need a temporary file in between.
2351 ;; Create the temporary file.
2359 "%s %s %s" cmd
2362 "Copying directly failed, see buffer `%s' for details."
2364 ;; We must change the ownership as remote user.
2365 ;; Since this does not work reliable, we also
2366 ;; give read permissions.
2376 localname1 tmpfile t
2377 keep-date preserve-uid-gid)
2379 'rename-file
2381 ;; We must change the ownership as local user.
2382 ;; Since this does not work reliable, we also
2383 ;; give read permissions.
2386 tmpfile
2390 ;; Move the temporary file to its destination.
2395 "cp -f -p %s %s"
2398 "Copying directly failed, see buffer `%s' for details."
2402 'rename-file
2405 ;; Save exit.
2408 ;; Set the time and mode. Mask possible errors.
2415 "Invoke `scp' program to copy.
2416 The method used must be an out-of-band method."
2420 copy-program copy-args copy-env copy-keep-date port listener spec
2421 options source target remote-copy-program remote-copy-args)
2426 ;; Both are Tramp files. We shall optimize it when the
2427 ;; methods for FILENAME and NEWNAME are the same.
2437 op filename tmpfile keep-date)
2440 ;; Save exit.
2447 ;; Set variables for computing the prompt for reading
2448 ;; password.
2455 ;; Expand hops. Might be necessary for gateway methods.
2459 ;; Check which ones of source and target are Tramp files.
2471 'file-name-directory
2473 newname))))
2475 ;; Check for host and port number. We cannot use
2476 ;; `tramp-file-name-port', because this returns also
2477 ;; `tramp-default-port', which might clash with settings in
2478 ;; "~/.ssh/config".
2485 ;; Check for user. There might be an interactive setting.
2489 ;; Check for listener port.
2496 ;; Compose copy command.
2505 ?h host ?u user ?p port ?r listener ?c options
2511 copy-args
2513 ;; " " has either been a replacement of "%k" (when
2514 ;; keep-date argument is non-nil), or a replacement
2515 ;; for the whole keep-date sublist.
2516 " "
2521 copy-args
2525 copy-env
2527 nil
2534 remote-copy-program
2540 remote-copy-args
2544 ;; Check for local copy program.
2549 ;; Install listener on the remote side. The prompt must be
2550 ;; consumed later on, when the process does not listen anymore.
2557 v 'file-error
2561 'identity
2569 v 'file-error
2570 "Listener process not running on remote host: `%s'"
2571 remote-copy-program))
2579 ;; The default directory must be remote.
2583 ;; Set the transfer process properties.
2593 copy-args
2595 copy-args
2600 ;; Use an asynchronous process. By this, password can
2601 ;; be handled. We don't set a timeout, because the
2602 ;; copying of large files can last longer than 60
2603 ;; secs.
2607 copy-program
2609 copy-args
2618 ;; We must adapt `tramp-local-end-of-line' for
2619 ;; sending the password.
2622 p v nil tramp-actions-copy-out-of-band))
2624 ;; Check the return code.
2629 orig-vec 'file-error
2630 "Couldn't find exit status of `%s'"
2636 orig-vec 'file-error
2637 "Error copying: `%s'"
2640 ;; Reset the transfer process properties.
2643 ;; Clear the remote prompt.
2646 ;; Houston, we have a problem! Likely, the listener is
2647 ;; still running, so let's clear everything (but the
2648 ;; cached password).
2651 ;; Handle KEEP-DATE argument.
2655 ;; Set the mode.
2660 ;; If the operation was `rename', delete the original file.
2667 "Like `make-directory' for Tramp files."
2679 "Like `delete-directory' for Tramp files."
2691 "Like `delete-file' for Tramp files."
2702 ;; Dired.
2708 "Like `dired-compress-file' for Tramp files."
2709 ;; Code stolen mainly from dired-aux.el.
2714 suffix)
2715 ;; See if any suffix rule matches this file name.
2723 nil)
2725 ;; We found an uncompression rule.
2735 ;; We don't recognize the file as compressed, so compress it.
2736 ;; Try gzip.
2750 "Like `insert-directory' for Tramp files."
2757 filename switches wildcard full-directory-p)
2777 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2778 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2781 v
2784 switches
2786 localname
2789 v
2793 "Couldn't `cd %s'"
2797 v
2800 switches
2805 ""
2813 ;; We cannot use `insert-buffer-substring' because the Tramp
2814 ;; buffer changes its contents before insertion due to calling
2815 ;; `expand-file-name' and alike.
2820 ;; Check for "--dired" output.
2827 ;; Now read the numeric positions of file names.
2833 ;; End is followed by \n or by " -> ".
2835 ;; Remove trailing lines.
2841 ;; Some busyboxes are reluctant to discard colors.
2849 ;; Decode the output, it could be multibyte.
2854 ;; The inserted file could be from somewhere else.
2861 "."
2868 ;; Canonicalization of file names.
2871 "Like `expand-file-name' for Tramp files.
2873 the result will be a local, non-Tramp, file name."
2874 ;; If DIR is not given, use `default-directory' or "/".
2876 ;; Unless NAME is absolute, concat DIR and NAME.
2879 ;; If connection is not established yet, run the real handler.
2883 ;; Dissect NAME.
2887 ;; Tilde expansion if necessary. This needs a shell which
2888 ;; groks tilde expansion! The function `tramp-find-shell' is
2889 ;; supposed to find such a shell on the remote host. Please
2890 ;; tell me about it when this doesn't work on your system.
2894 ;; We cannot simply apply "~/", because under sudo "~/" is
2895 ;; expanded to the local user home directory but to the
2896 ;; root home directory. On the other hand, using always
2897 ;; the default user name for tilde expansion is not
2898 ;; appropriate either, because ssh and companions might
2899 ;; use a user name from the config file.
2911 ;; There might be a double slash, for example when "~/"
2912 ;; expands to "/". Remove this.
2915 ;; No tilde characters in file name, do normal
2916 ;; `expand-file-name' (this does "/./" and "/../").
2917 ;; `default-directory' is bound, because on Windows there would
2918 ;; be problems with UNC shares or Cygwin mounts.
2921 method user host
2925 hop)))))
2927 ;;; Remote commands:
2930 "Flush file caches."
2938 ;; We use BUFFER also as connection buffer during setup. Because of
2939 ;; this, its original contents must be saved, and restored once
2940 ;; connection has been setup.
2942 "Like `start-file-process' for Tramp files."
2947 ;; BUFFER can be nil. We use a temporary buffer.
2949 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2950 ;; it might be that the arguments exceed the command line
2951 ;; length. Therefore, we modify the command.
2956 ;; When PROGRAM is nil, we just provide a tty.
2962 args
2966 ;; Use a human-friendly prompt, for example for `shell'.
2967 ;; We discard hops, if existing, that's why we cannot use
2968 ;; `file-remote-p'.
2975 tramp-initial-end-of-output))
2976 ;; We use as environment the difference to toplevel
2977 ;; `process-environment'.
2978 env
2983 env)
3002 ;; We do not want to raise an error when
3003 ;; `start-file-process' has been started several times in
3004 ;; `eshell' and friends.
3008 ;; NAME must be unique as process name.
3012 ;; Set the new process properties.
3018 ;; We catch this event. Otherwise, `start-process' could
3019 ;; be called on the local host.
3022 ;; Activate narrowing in order to save BUFFER
3023 ;; contents. Clear also the modification time;
3024 ;; otherwise we might be interrupted by
3025 ;; `verify-visited-file-modtime'.
3031 ;; We call `tramp-maybe-open-connection', in order
3032 ;; to cleanup the prompt afterwards.
3038 ;; Now do it.
3040 ;; Send the command.
3042 ;; Check, whether a pty is associated.
3046 v 'file-error
3049 ;; Set query flag and process marker for this
3050 ;; process. We ignore errors, because the process
3051 ;; could have finished already.
3055 ;; Return process.
3056 p))))
3058 ;; Save exit.
3069 "Like `process-file' for Tramp files."
3070 ;; The implementation is not complete yet.
3076 ;; Compute command.
3079 ;; We use as environment the difference to toplevel `process-environment'.
3087 "env %s %s"
3089 ;; Determine input.
3094 ;; INFILE is on the same remote host.
3096 ;; INFILE must be copied to remote host.
3102 ;; Determine output.
3104 ;; Just a buffer.
3107 ;; A buffer name.
3110 ;; (REAL-DESTINATION ERROR-DESTINATION)
3112 ;; output.
3120 ;; stderr.
3125 ;; stderr is on the same remote host.
3128 ;; stderr must be copied to remote host. The temporary
3129 ;; file must be deleted after execution.
3132 method user host stderr))))
3133 ;; stderr to be discarded.
3136 ;; 't
3141 ;; Send the command. It might not return in time, so we protect
3142 ;; it. Call it in a subshell, in order to preserve working
3143 ;; directory.
3150 command)
3151 t t)
3153 ;; We should add the output anyway.
3160 ;; When the user did interrupt, we should do it also. We use
3161 ;; return code -1 as marker.
3165 ;; Handle errors.
3170 ;; Provide error file.
3173 ;; Cleanup. We remove all file cache values for the connection,
3174 ;; because the remote process could have changed them.
3180 ;; Return exit status.
3183 ret))))
3186 "Like `file-local-copy' for Tramp files."
3190 v 'file-error
3200 ;; `copy-file' handles direct copy and out-of-band methods.
3205 ;; Use inline encoding for file transfer.
3209 v 3
3211 filename rem-enc)
3218 tmpfile loc-dec)
3220 ;; If local decoding is a function, we call it.
3221 ;; We must disable multibyte, because
3222 ;; `uudecode-decode-region' doesn't handle it
3223 ;; correctly. Unset `file-name-handler-alist'.
3224 ;; Otherwise, epa-file gets confused.
3232 ;; If tramp-decoding-function is not defined for this
3233 ;; method, we invoke tramp-decoding-command instead.
3235 ;; Unset `file-name-handler-alist'. Otherwise,
3236 ;; epa-file gets confused.
3244 loc-dec tmpfile2 tmpfile)
3247 ;; Set proper permissions.
3249 ;; Set local user ownership.
3252 ;; Oops, I don't know what to do.
3256 ;; Error handling.
3262 tmpfile)))
3264 ;; CCC grok LOCKNAME
3267 "Like `write-region' for Tramp files."
3270 ;; Following part commented out because we don't know what to do about
3271 ;; file locking, and it does not appear to be a problem to ignore it.
3272 ;; Ange-ftp ignores it, too.
3273 ;; (when (and lockname (stringp lockname))
3274 ;; (setq lockname (expand-file-name lockname)))
3275 ;; (unless (or (eq lockname nil)
3276 ;; (string= lockname filename))
3277 ;; (error
3278 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3290 ;; `file-writable-p' calls `file-expand-file-name'. We
3291 ;; cannot use `tramp-run-real-handler' therefore.
3297 ;; Short track: if we are on the local host, we can run directly.
3299 'write-region
3303 ;; We use this to save the value of
3304 ;; `last-coding-system-used' after writing the tmp
3305 ;; file. At the end of the function, we set
3306 ;; `last-coding-system-used' to this saved value. This
3307 ;; way, any intermediary coding systems used while
3308 ;; talking to the remote shell or suchlike won't hose
3309 ;; this variable. This approach was snarfed from
3310 ;; ange-ftp.el.
3311 coding-system-used
3312 ;; Write region into a tmp file. This isn't really
3313 ;; needed if we use an encoding function, but currently
3314 ;; we use it always because this makes the logic
3315 ;; simpler. We must also set `temporary-file-directory',
3316 ;; because it could point to a remote directory.
3322 ;; If `append' is non-nil, we copy the file locally, and let
3323 ;; the native `write-region' implementation do the job.
3326 ;; We say `no-message' here because we don't want the
3327 ;; visited file modtime data to be clobbered from the temp
3328 ;; file. We call `set-visited-file-modtime' ourselves later
3329 ;; on. We must ensure that `file-coding-system-alist'
3330 ;; matches `tmpfile'.
3336 'write-region
3343 ;; Now, `last-coding-system-used' has the right value. Remember it.
3346 ;; The permissions of the temporary file should be set. If
3347 ;; FILENAME does not exist (eq modes nil) it has been
3348 ;; renamed to the backup file. This case `save-buffer'
3349 ;; handles permissions.
3350 ;; Ensure that it is still readable.
3353 tmpfile
3356 ;; This is a bit lengthy due to the different methods
3357 ;; possible for file transfer. First, we check whether the
3358 ;; method uses an scp program. If so, we call it.
3359 ;; Otherwise, both encoding and decoding command must be
3360 ;; specified. However, if the method _also_ specifies an
3361 ;; encoding function, then that is used for encoding the
3362 ;; contents of the tmp file.
3367 ;; `copy-file' handles direct copy and out-of-band methods.
3377 ;; We keep the local file for performance
3378 ;; reasons, useful for "rsync".
3385 ;; Don't rename, in order to keep context in SELinux.
3390 ;; Use inline file transfer.
3392 ;; Encode tmpfile.
3396 ;; Use encoding function or command.
3399 "Encoding local file `%s' using `%s'"
3400 tmpfile loc-enc)
3402 ;; The following `let' is a workaround for
3403 ;; the base64.el that comes with pgnus-0.84.
3404 ;; If both of the following conditions are
3405 ;; satisfied, it tries to write to a local
3406 ;; file in default-directory, but at this
3407 ;; point, default-directory is remote.
3408 ;; (`call-process-region' can't write to
3409 ;; remote files, it seems.) The file in
3410 ;; question is a tmp file anyway.
3418 loc-enc tmpfile t))
3420 v 'file-error
3423 filename loc-enc))))
3425 ;; Send buffer into remote decoding command which
3426 ;; writes to remote file. Because this happens on
3427 ;; the remote host, we cannot use the function.
3430 "Decoding remote file `%s' using `%s'"
3431 filename rem-dec)
3435 v
3439 tramp-end-of-heredoc
3441 tramp-end-of-heredoc))
3443 v nil
3444 "Couldn't write region to `%s', decode using `%s' failed"
3445 filename rem-dec)
3446 ;; When `file-precious-flag' is set, the region is
3447 ;; written to a temporary file. Check that the
3448 ;; checksum is equal to that from the local tmpfile.
3452 ;; cksum runs locally, if possible.
3454 ;; cksum runs remotely.
3456 v
3459 ;; ... they are different.
3466 v 'file-error
3469 filename rem-dec)))))
3471 ;; Save exit.
3474 ;; That's not expected.
3477 v 'file-error
3480 method))))
3482 ;; Make `last-coding-system-used' have the right value.
3489 ;; We must protect `last-coding-system-used', now we have set it
3490 ;; to its correct value.
3492 ;; Set file modification time.
3496 ;; We must pass modtime explicitly, because FILENAME can
3497 ;; be different from (buffer-file-name), f.e. if
3498 ;; `file-precious-flag' is set.
3504 ;; Set the ownership.
3514 ;; VC backends check for the existence of various different special
3515 ;; files. This is very time consuming, because every single check
3516 ;; requires a remote command (the file cache must be invalidated).
3517 ;; Therefore, we apply a kind of optimization. We install the file
3518 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3519 ;; remembers all file names for which `file-exists-p' or
3520 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3521 ;; is performed. Afterwards, a script is applied for all collected
3522 ;; file names, using just one remote command. The result of this
3523 ;; script is used to fill the file cache with actual values. Now we
3524 ;; can reset the file name handlers, and we make a second run of
3525 ;; `vc-registered', which returns the expected result without sending
3526 ;; any other remote command.
3528 "Like `vc-registered' for Tramp files."
3534 ;; There could be new files, created by the vc backend. We
3535 ;; cannot reuse the old cache entries, therefore. In
3536 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3537 ;; could also be a timestamp as `current-time' returns. This
3538 ;; means invalidate all cache entries with an older timestamp.
3544 ;; Here we collect only file names, which need an operation.
3548 ;; Send just one command, in order to fill the cache.
3551 v
3560 ;; We cannot use `tramp-send-command-and-read',
3561 ;; because this does not cooperate well with
3562 ;; heredoc documents.
3564 v
3567 tramp-end-of-heredoc
3569 tramp-vc-registered-file-names
3571 tramp-end-of-heredoc))
3573 ;; Read the expression.
3580 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3581 ;; calls shall be answered from the file cache. We unset
3582 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3583 ;; in order to keep the cache.
3585 remote-file-name-inhibit-cache process-file-side-effects)
3586 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3605 ;; Run.
3609 ;;;###tramp-autoload
3611 "Invoke remote-shell Tramp file name handler.
3612 Fall back to normal file name handler if no Tramp handler exists."
3630 "Invoke special file name handler, which collects files to be handled."
3638 ;; That's what we want: file names, for which checks are
3639 ;; applied. We assume that VC uses only `file-exists-p' and
3640 ;; `file-readable-p' checks; otherwise we must extend the
3641 ;; list. We do not perform any action, but return nil, in
3642 ;; order to keep `vc-registered' running.
3645 nil)
3646 ;; `process-file' and `start-file-process' shall be ignored.
3649 ;; Tramp file name handlers like `expand-file-name'. They
3650 ;; must still work.
3652 ;; Default file name handlers, we don't care.
3656 "Like `file-notify-add-watch' for Tramp files."
3660 command events filter p sequence)
3662 ;; gvfs-monitor-dir.
3665 events
3669 attribute-changed))
3674 ;; inotifywait.
3677 events
3687 ;; Make events a list of symbols.
3688 events
3692 ;; None.
3694 v 'file-notify-error
3695 "No file notification program found on %s"
3697 ;; Start process.
3699 'start-file-process
3703 sequence))
3704 ;; Return the process object as watch-descriptor.
3707 v 'file-notify-error
3708 "`%s' failed to start on remote host"
3712 ;; Needed for process filter.
3717 ;; There might be an error if the monitor is not supported.
3718 ;; Give the filter a chance to read the output.
3723 p))))
3727 file-notify events."
3737 ;; Attribute change is returned in unused wording.
3749 string)
3754 proc
3759 ;; File names are returned as absolute paths. We must
3760 ;; add the remote prefix.
3764 ;; Remove watch when file or directory to be watched is deleted.
3768 ;; Usually, we would add an Emacs event now. Unfortunately,
3769 ;; `unread-command-events' does not accept several events at
3770 ;; once. Therefore, we apply the handler directly.
3773 'file-notify-handle-event
3776 ;; Save rest of the string.
3786 ;; Check, whether there is a problem.
3792 line)
3797 proc
3804 ;; Remove watch when file or directory to be watched is deleted.
3807 ;; Usually, we would add an Emacs event now. Unfortunately,
3808 ;; `unread-command-events' does not accept several events at
3809 ;; once. Therefore, we apply the handler directly.
3812 'file-notify-handle-event
3815 ;;; Internal Functions:
3818 "Define in remote shell function NAME implemented as SCRIPT.
3819 Only send the definition if it has not already been done."
3820 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3821 ;; might be nil.
3827 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3828 ;; could result in unwanted command expansion. Avoid this.
3831 ;; The script could contain a call of Perl. This is masked with `%s'.
3836 vec
3844 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3845 Returns the exit code of the `test' program."
3848 v
3850 "%s %s %s"
3852 switch
3856 "Run `test'-like program on the remote system, given FILE1, FILE2.
3857 FORMAT-STRING contains the program name, switches, and place holders.
3858 Returns the exit code of the `test' program. Barfs if the methods,
3859 hosts, or files, disagree."
3863 v 'file-error
3868 v1
3875 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3876 First arg VEC specifies the connection, PROGNAME is the program
3877 to search for, and DIRLIST gives the list of directories to
3878 search. If IGNORE-TILDE is non-nil, directory names starting
3879 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3880 only in DIRLIST.
3882 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3884 This function expects to be in the right *tramp* buffer."
3887 ;; Check whether the executable is in $PATH. "which(1)" does not
3888 ;; report always a correct error code; therefore we check the
3889 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3890 ;; 5.11") have problems with this command, we disable the call
3891 ;; therefore.
3902 ;; Remove all ~/foo directories from dirlist.
3911 vec
3913 "do if test -x $d/%s && test -f $d/%s; "
3914 "then echo tramp_executable $d/%s; "
3917 progname progname progname
3918 tramp-end-of-heredoc
3920 tramp-end-of-heredoc))
3926 result)))
3929 "Sets the remote environment PATH to existing directories.
3930 I.e., for each directory in `tramp-remote-path', it is tested
3931 whether it exists and if so, it is added to the environment
3932 variable PATH."
3938 ;; ------------------------------------------------------------
3939 ;; -- Communication with external shell --
3940 ;; ------------------------------------------------------------
3943 "Find a command on the remote host for checking if a file exists.
3944 Here, we are looking for a command which has zero exit status if the
3945 file exists and nonzero exit status otherwise."
3949 result)
3950 ;; The algorithm is as follows: we try a list of several commands.
3951 ;; For each command, we first run `$cmd /' -- this should return
3952 ;; true, as the root directory always exists. And then we run
3953 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3954 ;; does not exist. This should return false. We use the first
3955 ;; command we find that seems to work.
3956 ;; The list of commands to try is as follows:
3957 ;; `ls -d' This works on most systems, but NetBSD 1.4
3958 ;; has a bug: `ls' always returns zero exit
3959 ;; status, even for files which don't exist.
3960 ;; `test -e' Some Bourne shells have a `test' builtin
3961 ;; which does not know the `-e' option.
3962 ;; `/bin/test -e' For those, the `test' binary on disk normally
3963 ;; provides the option. Alas, the binary
3964 ;; is sometimes `/bin/test' and sometimes it's
3965 ;; `/usr/bin/test'.
3966 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3994 result))
3997 "Opens shell SHELL."
4000 ;; Find arguments for this shell.
4002 item extra-args)
4007 ;; It is useful to set the prompt in the following command
4008 ;; because some people have a setting for $PS1 which /bin/sh
4009 ;; doesn't know about and thus /bin/sh will display a strange
4010 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4011 ;; ksh will display the current working directory but /bin/sh
4012 ;; will display a dollar sign. The following command line sets
4013 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4014 ;; well as csh-like shells. We also unset the variable $ENV
4015 ;; because that is read by some sh implementations (eg, bash
4016 ;; when called as sh) on startup; this way, we avoid the startup
4017 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4018 ;; the prompt in /bin/bash, it must be discarded as well.
4019 ;; $HISTFILE is set according to `tramp-histfile-override'.
4022 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
4027 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4031 t))
4036 "Opens a shell on the remote host which groks tilde expansion."
4039 shell)
4042 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4043 ;; Which check could we apply instead?
4046 ;; The default shell (ksh93) of OpenSolaris and
4047 ;; Solaris is buggy. We've got reports for
4048 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4057 ;; Maybe it works at least for some other commands.
4059 default-shell
4061 vec 2
4063 "Couldn't find a remote shell which groks tilde "
4065 default-shell)))
4067 default-shell)))
4069 ;; Open a new shell if needed.
4075 ;; Utility functions.
4078 "Wait for shell prompt and barf if none appears.
4079 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4080 seconds. If not, it produces an error message with the given ERROR-ARGS."
4084 proc timeout
4093 "Set up an interactive shell.
4094 Mainly sets the prompt and the echo correctly. PROC is the shell
4095 process to set up. VEC specifies the connection."
4100 ;; Disable tab and echo expansion.
4104 ;; Check whether the echo has really been disabled. Some
4105 ;; implementations, like busybox of embedded GNU/Linux, don't
4106 ;; support disabling.
4113 ;; Make sure backspaces and their echo are enabled and no line
4114 ;; width magic interferes with them.
4122 ;; Check whether the output of "uname -sr" has been changed. If
4123 ;; yes, this is a strong indication that we must expire all
4124 ;; connection properties. We start again with
4125 ;; `tramp-maybe-open-connection', it will be caught there.
4130 vec "uname"
4134 vec 3
4135 "Connection reset, because remote host changed from `%s' to `%s'"
4136 old-uname new-uname)
4137 ;; We want to keep the password.
4141 ;; Try to set up the coding system correctly.
4142 ;; CCC this can't be the right way to do it. Hm.
4145 ;; Use MULE to select the right EOL convention for communicating
4146 ;; with the process.
4152 cs-decode cs-encode)
4156 cs-encode
4158 cs-encode
4166 ;; Special setting for Mac OS X.
4178 ;; Check whether the remote host suffers from buggy
4179 ;; `send-process-string'. This is known for FreeBSD (see comment in
4180 ;; `send_process', file process.c). I've tested sending 624 bytes
4181 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4182 ;; this host type is detected locally. It cannot handle remote
4183 ;; hosts, though.
4187 tramp-chunksize)
4195 ;; Set remote PATH variable.
4198 ;; Search for a good shell before searching for a command which
4199 ;; checks if a file exists. This is done because Tramp wants to use
4200 ;; "test foo; echo $?" to check if various conditions hold, and
4201 ;; there are buggy /bin/sh implementations which don't execute the
4202 ;; "echo $?" part if the "test" part has an error. In particular,
4203 ;; the OpenSolaris /bin/sh is a problem. There are also other
4204 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4205 ;; in function declarations, or changing HISTFILE in place.
4206 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4207 ;; detected.
4210 ;; Disable unexpected output.
4213 ;; IRIX64 bash expands "!" even when in single quotes. This
4214 ;; destroys our shell functions, we must disable it. See
4215 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4219 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4224 ;; Set utf8 encoding. Needed for Mac OS X, for example. This is
4225 ;; non-POSIX, so we must expect errors on some systems.
4228 ;; Set `remote-tty' process property.
4233 ;; Dump stty settings in the traces.
4237 ;; Set the environment.
4242 unset vars item)
4252 vec
4254 tramp-end-of-heredoc
4256 tramp-end-of-heredoc)
4257 t))
4262 ;; Old text from documentation of tramp-methods:
4263 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4264 ;; of the base64 methods instead since base64 encoding is much more
4265 ;; reliable and the commands are more standardized between the different
4266 ;; Unix versions. But if you can't use base64 for some reason, please
4267 ;; note that the default uudecode command does not work well for some
4268 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4269 ;; the following command for uudecode:
4270 ;;
4271 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4272 ;;
4273 ;; For Irix, no solution is known yet.
4281 "List of local coding commands for inline transfer.
4282 Each item is a list that looks like this:
4284 \(FORMAT ENCODING DECODING)
4286 FORMAT is symbol describing the encoding/decoding format. It can be
4287 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4289 ENCODING and DECODING can be strings, giving commands, or symbols,
4290 giving functions. If they are strings, then they can contain
4292 file name will be put into the command line at that spot. If the
4293 specifier is not present, the input should be read from standard
4294 input.
4296 If they are functions, they will be called with two arguments, start
4297 and end of region, and are expected to replace the region contents
4302 ;; "-i" is more robust with older base64 from GNU coreutils.
4303 ;; However, I don't know whether all base64 versions do supports
4304 ;; this option.
4312 ;; This is painful slow, so we put it on the end.
4319 "List of remote coding commands for inline transfer.
4320 Each item is a list that looks like this:
4322 \(FORMAT ENCODING DECODING [TEST])
4324 FORMAT is a symbol describing the encoding/decoding format. It can be
4325 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4327 ENCODING and DECODING can be strings, giving commands, or symbols,
4328 giving variables. If they are strings, then they can contain
4330 file name will be put into the command line at that spot. If the
4331 specifier is not present, the input should be read from standard
4332 input.
4334 If they are variables, this variable is a string containing a
4335 Perl or Shell implementation for this functionality. This
4336 program will be transferred to the remote host, and it is
4338 specifier in the variable value denotes a temporary file.
4340 The optional TEST command can be used for further tests, whether
4344 "Find an inline transfer encoding that works.
4345 Goes through the list `tramp-local-coding-commands' and
4346 `tramp-remote-coding-commands'."
4351 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4359 ;; If the local encoder or decoder is a string, the
4360 ;; corresponding command has to work locally.
4367 loc-enc nil nil))
4375 loc-dec nil nil))
4377 ;; Search for remote coding commands with the same format
4385 ;; Check the remote test command if exists.
4391 ;; Check if remote perl exists when necessary.
4396 ;; Check if remote encoding and decoding commands can be
4397 ;; called remotely with null input and output. This makes
4398 ;; sure there are no syntax errors and the command is really
4399 ;; found. Note that we do not redirect stdout to /dev/null,
4400 ;; for two reasons: when checking the decoding command, we
4401 ;; actually check the output it gives. And also, when
4402 ;; redirecting "mimencode" output to /dev/null, then as root
4403 ;; it might change the permissions of /dev/null!
4411 vec 5
4420 tmpfile)
4427 tramp-temp-name-prefix
4429 value
4431 value
4433 ?t
4438 vec 5
4441 vec
4443 t)
4451 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4457 ;; Set connection properties. Since the commands are risky
4458 ;; (due to output direction), we cache them in the process cache.
4469 "Call the local encoding or decoding command.
4471 Otherwise, INPUT is passed via standard input.
4472 INPUT can also be nil which means `/dev/null'.
4473 OUTPUT can be a string (which specifies a file name), or t (which
4474 means standard output and thus the current buffer), or nil (which
4475 means discard it)."
4477 nil tramp-encoding-shell
4480 nil
4481 tramp-encoding-command-switch
4491 "List of compress and decompress commands for inline transfer.
4492 Each item is a list that looks like this:
4494 \(COMPRESS DECOMPRESS)
4499 "Find an inline transfer compress command that works.
4500 Goes through the list `tramp-inline-compress-commands'."
4505 item compress decompress found)
4512 vec 5
4513 "Checking local compress commands `%s', `%s' for sanity"
4514 compress decompress)
4519 ;; Windows shells need the program file name after
4520 ;; the pipe symbol be quoted if they use forward
4521 ;; slashes as directory separators.
4528 vec 5
4529 "Checking remote compress commands `%s', `%s' for sanity"
4530 compress decompress)
4536 ;; Did we find something?
4539 ;; Set connection properties. Since the commands are
4540 ;; risky (due to output direction), we cache them in the
4541 ;; process cache.
4555 "Expands VEC according to `tramp-default-proxies-alist'.
4556 Gateway hops are already opened."
4560 choices proxy)
4562 ;; Ad-hoc proxy definitions.
4567 tramp-prefix-format proxy tramp-postfix-host-format)))
4572 proxy)
4573 ;; Add the hop.
4575 'tramp-default-proxies-alist
4578 proxy))
4580 ;; Save the new value.
4585 ;; Look for proxy hosts to be passed.
4591 ;; Host.
4594 ;; User.
4598 ;; No more hops needed.
4600 ;; Replace placeholders.
4603 proxy
4608 ;; Add the hop.
4610 ;; Start next search.
4613 ;; Handle gateways.
4621 ;; Is the method prepared for gateways?
4624 vec 'file-error
4626 ;; Open the gateway connection.
4631 target-alist)
4632 ;; For the password prompt, we need the correct values.
4633 ;; Therefore, we must remember the gateway vector. But we
4634 ;; cannot do it as connection property, because it shouldn't
4635 ;; be persistent. And we have no started process yet either.
4639 ;; Foreign and out-of-band methods are not supported for multi-hops.
4646 vec 'file-error
4647 "Method `%s' is not supported for multi-hops."
4650 ;; In case the host name is not used for the remote shell
4651 ;; command, the user could be misguided by applying a random
4652 ;; host name.
4658 ;; There are multi-hops.
4660 ;; The host name is used for the remote shell command.
4662 ;; The host is local. We cannot use `tramp-local-host-p'
4663 ;; here, because it opens a connection as well.
4666 v 'file-error
4667 "Host `%s' looks like a remote host, `%s' can only use the local host"
4668 host method)))
4670 ;; Result.
4671 target-alist))
4674 "Return the Control* arguments of the local ssh."
4676 ;; No options to be computed.
4681 ;; There is already a value to be used.
4684 ;; Determine the options.
4696 ;; We use a non-existing IP address, in order to avoid
4697 ;; useless connections, and DNS timeouts.
4704 " -o ControlPath='tramp.%%r@%%h:%%p'"
4713 tramp-ssh-controlmaster-options)))
4716 "Maybe open a connection VEC.
4717 Does not do anything if a connection is already open, but re-opens the
4718 connection if a previous connection has died for some reason."
4726 ;; If Tramp opens the same connection within a short time frame,
4727 ;; there is a problem. We shall signal this.
4736 ;; If too much time has passed since last command was sent, look
4737 ;; whether process is still alive. If it isn't, kill it. When
4738 ;; using ssh, it can sometimes happen that the remote end has hung
4739 ;; up but the local ssh client doesn't recognize this until it
4740 ;; tries to send some data to the remote end. So that's why we
4741 ;; try to send a command from time to time, then look again
4742 ;; whether the process is really alive.
4753 ;; The error will be caught locally.
4759 ;; New connection must be opened.
4763 ;; If `non-essential' is non-nil, don't reopen a new connection.
4764 ;; This variable has been introduced with Emacs 24.1.
4769 vec 3
4780 ;; Start new process.
4797 ;; We will apply `tramp-ssh-controlmaster-options'
4798 ;; only for the first hop.
4802 ;; There are unfortune settings for "cmdproxy" on
4803 ;; W32 systems.
4806 ;; This must be done in order to avoid our file
4807 ;; name handler.
4811 'start-process
4816 tramp-encoding-command-interactive)
4819 ;; Set sentinel and query flag.
4830 ;; Check whether process is alive.
4832 p 10
4835 ;; Now do all the connections as specified.
4861 ;; We don't create the temporary file. In
4862 ;; fact, it is just a prefix for the
4863 ;; ControlPath option of ssh; the real
4864 ;; temporary file has another name, and it is
4865 ;; created and protected by ssh. It is also
4866 ;; removed by ssh when the connection is
4867 ;; closed. The temporary file name is cached
4868 ;; in the main connection process, therefore
4869 ;; we cannot use `tramp-get-connection-process'.
4875 tramp-temp-name-prefix
4877 spec r-shell)
4879 ;; Add arguments for asynchronous processes.
4883 ;; Add gateway arguments if necessary.
4889 ;; Check for port number. Until now, there's no
4890 ;; need for handling like method, user, host.
4895 ;; Check, whether there is a restricted shell.
4900 ;; Set variables for computing the prompt for
4901 ;; reading password. They can also be derived
4902 ;; from a gateway.
4907 ;; Add login environment.
4910 login-env
4915 login-env))
4919 "%s=%s %s"
4922 command)))
4925 ;; Replace `login-args' place holders.
4933 ?h l-host ?u l-user ?p l-port ?c options)
4934 command
4936 ;; We do not want to see the trailing local
4937 ;; prompt in `start-file-process'.
4939 command " "
4945 ;; Local shell could be a Windows COMSPEC. It
4946 ;; doesn't know the ";" syntax, but we must exit
4947 ;; always for `start-file-process'. It could
4948 ;; also be a restricted shell, which does not
4949 ;; allow "exec".
4952 ;; Send the command.
4956 p vec pos tramp-actions-before-shell
4960 ;; Next hop.
4964 ;; Make initial shell settings.
4967 ;; Mark it as connected.
4970 ;; When the user did interrupt, we must cleanup.
4973 ;; Propagate the quit signal.
4977 "Send the COMMAND to connection VEC.
4978 Erases temporary buffer before sending the command. If optional
4979 arg NEVEROPEN is non-nil, never try to open the connection. This
4980 is meant to be used from `tramp-maybe-open-connection' only. The
4981 function waits for output unless NOOUTPUT is set."
4985 ;; We mark the command string that it can be erased in the output buffer.
4987 ;; If we put `tramp-echo-mark' after a trailing newline (which
4988 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4989 ;; that newline and adds `tramp-rsh-end-of-line' right after
4990 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4991 ;; trailing line endings and sends two prompts after executing
4992 ;; the command, which confuses `tramp-wait-for-output'.
4996 ;; No need to restore a trailing newline here since `tramp-send-string'
4997 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4999 ;; Send the command.
5005 "Wait for output from remote command."
5011 ;; be leading escape sequences, which must be ignored.
5012 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
5013 ;; option send also escape sequences, which must be
5014 ;; ignored.
5017 tramp-device-escape-sequence-regexp))
5018 ;; Sometimes, the commands do not return a newline but a
5019 ;; null byte before the shell prompt, for example "git
5020 ;; ls-files -c -z ...".
5025 ;; A simple-minded busybox has sent " ^H" sequences.
5026 ;; Delete them.
5031 ;; Delete the prompt.
5037 proc 'file-error
5038 "[[Remote prompt `%s' not found in %d secs]]"
5039 tramp-end-of-output timeout)
5041 proc 'file-error
5043 ;; Return value is whether end-of-output sentinel was found.
5044 found)))
5048 "Run COMMAND and check its exit status.
5049 Sends `echo $?' along with the COMMAND for checking the exit status.
5050 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5051 status is 0, and nil otherwise.
5053 If the optional argument SUBSHELL is non-nil, the command is
5054 executed in a subshell, ie surrounded by parentheses. If
5055 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5057 vec
5059 command
5061 "echo tramp_exit_status $?"
5075 "Run COMMAND, check exit status, throw error if exit status not okay.
5076 Similar to `tramp-send-command-and-check' but accepts two more arguments
5077 FMT and ARGS which are passed to `error'."
5082 "Run COMMAND and return the output, which must be a Lisp expression.
5083 If MARKER is a regexp, read the output after that string.
5084 In case there is no valid Lisp expression and NOERROR is nil, it
5085 raises an error."
5092 ;; Read the marker.
5098 vec 'file-error
5099 "`%s' does not return the marker `%s': `%s'"
5101 ;; Read the expression.
5104 ;; Error handling.
5109 vec 'file-error
5110 "`%s' does not return a valid Lisp expression: `%s'"
5114 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5115 Convert file mode bits to string and set virtual device number.
5116 Return ATTR."
5118 ;; Remove color escape sequences from symlink.
5122 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5123 ;; indication of unusable value.
5134 ;; Convert last access time.
5139 ;; Convert last modification time.
5144 ;; Convert last status change time.
5149 ;; Convert file size.
5155 ;; Convert file mode bits to string.
5160 ;; Convert directory indication bit.
5163 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5169 ;; Set file's gid change bit.
5177 ;; Convert inode.
5183 ;; Inodes can be incredible huge. We must hide this.
5185 ;; Set virtual device number.
5188 attr))
5191 "Converts STRING to shell glob pattern which ignores case."
5197 string
5201 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5212 localname)
5218 "Return t if this is an out-of-band method, nil otherwise."
5220 ;; It shall be an out-of-band method.
5222 ;; There must be a size, otherwise the file doesn't exist.
5224 ;; Either the file size is large enough, or (in rare cases) there
5225 ;; does not exist a remote encoding.
5230 ;; Variables local to connection.
5234 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5235 ;; cache the result for the session only. Otherwise, the result
5236 ;; is cached persistently.
5239 vec)
5240 "remote-path"
5249 ;; Default if "getconf" is not available.
5252 vec 3
5257 ;; The login shell could return more than just the $PATH
5258 ;; string. So we use `tramp-end-of-heredoc' as marker.
5262 vec
5267 'identity
5271 'identity
5279 nil)))))
5281 ;; Replace place holder `tramp-default-remote-path'.
5289 ;; Replace place holder `tramp-own-remote-path'.
5297 ;; Remove double entries.
5304 ;; Remove non-existing directories.
5306 nil
5316 x))
5317 x))
5318 remote-path)))))
5324 locale)
5331 candidates nil)
5333 ;; Return value.
5343 result)
5345 ;; Check parameters. On busybox, "ls" output coloring is
5346 ;; enabled by default sometimes. So we try to disable it
5347 ;; when possible. $LS_COLORING is not supported there.
5348 ;; Some "ls" versions are sensible wrt the order of
5349 ;; arguments, they fail when "-al" is after the
5350 ;; "--color=never" argument (for example on FreeBSD).
5365 ;; Some "ls" versions are sensible wrt the order of arguments,
5366 ;; they fail when "-al" is after the "--dired" argument (for
5367 ;; example on FreeBSD).
5383 ;; Option "-w" is available on BSD systems. No argument is
5384 ;; given, because this could return wrong results in case "ls"
5385 ;; supports the "-w NUM" argument, as for busyboxes.
5393 "test"
5397 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5398 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5399 ;; for otherwise the shell crashes.
5411 vec
5434 ;; We must check also for some Perl modules.
5442 result)))
5449 tmp)
5450 ;; Check whether stat(1) returns usable syntax. "%s" does not
5451 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5452 ;; use shell quoted format for "%N", we check the boundaries "`"
5453 ;; and "'", therefore. See Bug#23422 in coreutils.
5462 result)))
5472 result))))
5488 ;; Busyboxes do support the "-t" option only when they have been
5489 ;; built with the DESKTOP config option. Let's check it.
5492 vec "touch-t"
5494 vec
5496 "%s -t %s %s"
5497 result
5501 result)))
5520 result)
5522 ;; Check POSIX parameter.
5529 vec
5538 vec
5542 "print $>"
5554 vec
5558 "import os; print (os.getuid())"
5572 ;; Ensure there is a valid result.
5575 tramp-unknown-id-integer)
5577 tramp-unknown-id-string)
5582 vec
5591 vec
5600 vec
5604 "import os; print (os.getgid())"
5618 ;; Ensure there is a valid result.
5621 tramp-unknown-id-integer)
5623 tramp-unknown-id-string)
5626 ;; Some predefined connection properties.
5628 "Return the compress command related to PROP.
5629 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5630 the length of the file to be compressed.
5632 If no corresponding command is found, nil is returned."
5641 "Return the coding command related to PROP.
5642 PROP is either `remote-encoding', `remote-decoding',
5643 `local-encoding' or `local-decoding'.
5645 SIZE is the length of the file to be coded. Depending on SIZE,
5646 compression might be applied.
5648 If no corresponding command is found, nil is returned.
5649 Otherwise, either a string is returned which contains a `%s' mark
5650 to be used for the respective input or output file; or a Lisp
5651 function cell is returned to be applied on a buffer."
5652 ;; We must catch the errors, because we want to return nil, when
5653 ;; no inline coding is found.
5663 compress)
5664 ;; The connection property might have been cached. So we must
5665 ;; send the script to the remote side - maybe.
5673 ;; Check for the `compress' command.
5675 ;; Return the value.
5700 coding)
5703 ;; Windows shells need the program file name after
5704 ;; the pipe symbol be quoted if they use forward
5705 ;; slashes as directory separators.
5712 coding compress))
5715 ;; Windows shells need the program file name after
5716 ;; the pipe symbol be quoted if they use forward
5717 ;; slashes as directory separators.
5722 compress coding))
5736 ;;; TODO:
5738 ;; * Don't use globbing for directories with many files, as this is
5739 ;; likely to produce long command lines, and some shells choke on
5740 ;; long command lines.
5741 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5742 ;; then look if it's the right version (with `perl -v').
5743 ;; * When editing a remote CVS controlled file as a different user, VC
5744 ;; gets confused about the file locking status. Try to find out why
5745 ;; the workaround doesn't work.
5746 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5747 ;; until the last but one hop via `start-file-process'. Apply it
5748 ;; also for ftp and smb.
5749 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5750 ;; some shell with root privileges, it would be nice if I could
5751 ;; just call
5752 ;; trampclient filename.c
5753 ;; as an editor, and the _current_ shell would connect to an Emacs
5754 ;; server and would be used in an existing non-privileged Emacs
5755 ;; session for doing the editing in question.
5756 ;; That way, I need not tell Emacs my password again and be afraid
5757 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5758 ;; once display a just typed password in the context of a keyboard
5759 ;; sequence prompt for a question immediately following in a shell
5760 ;; script run within Emacs -- nasty).
5761 ;; And if I have some ssh session running to a different computer,
5762 ;; having the possibility of passing a local file there to a local
5763 ;; Emacs session (in case I can arrange for a connection back) would
5764 ;; be nice.
5765 ;; Likely the corresponding Tramp server should not allow the
5766 ;; equivalent of the emacsclient -eval option in order to make this
5767 ;; reasonably unproblematic. And maybe trampclient should have some
5768 ;; way of passing credentials, like by using an SSL socket or
5769 ;; something. (David Kastrup)
5770 ;; * Reconnect directly to a compliant shell without first going
5771 ;; through the user's default shell. (Pete Forman)
5772 ;; * How can I interrupt the remote process with a signal
5773 ;; (interrupt-process seems not to work)? (Markus Triska)
5774 ;; * Avoid the local shell entirely for starting remote processes. If
5775 ;; so, I think even a signal, when delivered directly to the local
5776 ;; SSH instance, would correctly be propagated to the remote process
5777 ;; automatically; possibly SSH would have to be started with
5778 ;; "-t". (Markus Triska)
5779 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5780 ;; isn't on the remote host. (Mark A. Hershberger)
5781 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5782 ;; * Optimize out-of-band copying when both methods are scp-like (not
5783 ;; rsync).
5784 ;; * Keep a second connection open for out-of-band methods like scp or
5785 ;; rsync.
5787 ;;; tramp-sh.el ends here