| blob | e907719469115508ff6a6f3b62da6f810a988c62 |
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."
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."
61 ;;;###tramp-autoload
63 "Value of TERM environment variable for logging in to remote host.
64 Because Tramp wants to parse the output of the remote shell, it is easily
65 confused by ANSI color escape sequences and suchlike. Often, shell init
66 files conditionalize this setup based on the TERM environment variable."
71 ;;;###tramp-autoload
73 "When invoking a shell, override the HISTFILE with this value.
74 When setting to a string, it redirects the shell history to that
78 The value t, the default value, unsets any setting of HISTFILE,
79 and sets both HISTFILESIZE and HISTSIZE to 0. If you set this
80 variable to nil, however, the *override* is disabled, so the
81 history will go to the default storage location,
90 ;;;###tramp-autoload
94 ;;;###tramp-autoload
98 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
99 ;; root users. It uses the `$' character for other users. In order
100 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
104 "///%s#$"
106 "String used to recognize end of output.
107 The `$' character at the end is quoted; the string cannot be
110 ;;;###tramp-autoload
117 ;;;###tramp-autoload
119 "Whether to use `tramp-ssh-controlmaster-options'."
126 "Which ssh Control* arguments to use.
128 If it is a string, it should have the form
131 spec must be doubled, because the string is used as format string.
133 Otherwise, it will be auto-detected by Tramp, if
134 `tramp-use-ssh-controlmaster-options' is non-nil. The value
135 depends on the installed local ssh version.
139 ;; Initialize `tramp-methods' with the supported methods.
140 ;;;###tramp-autoload
152 ;;;###tramp-autoload
163 ;;;###tramp-autoload
181 ;;;###tramp-autoload
200 ;;;###tramp-autoload
216 ;;;###tramp-autoload
224 ;;;###tramp-autoload
232 ;;;###tramp-autoload
246 ;;;###tramp-autoload
260 ;;;###tramp-autoload
269 ;;;###tramp-autoload
278 ;; We use "-v" for better error tracking.
281 ;; We use "-p" as required for newer busyboxes. For older
282 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
283 ;; can be achieved by tweaking `tramp-connection-properties'.
286 ;;;###tramp-autoload
295 ;;;###tramp-autoload
297 'tramp-methods
304 ;;;###tramp-autoload
308 ;; The password template must be masked. Otherwise, it could be
309 ;; interpreted as password prompt if the remote host echoes the command.
312 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
318 ;;;###tramp-autoload
326 ;;;###tramp-autoload
335 ;;;###tramp-autoload
343 ;;;###tramp-autoload
347 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
351 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
352 tramp-terminal-type
353 tramp-initial-end-of-output))
359 ;;;###tramp-autoload
365 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
366 tramp-terminal-type
367 tramp-initial-end-of-output))
372 ;;;###tramp-autoload
379 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
380 tramp-terminal-type
381 tramp-initial-end-of-output))
392 ;;;###tramp-autoload
399 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
400 tramp-terminal-type
401 tramp-initial-end-of-output))
410 ;;;###tramp-autoload
422 ;;;###tramp-autoload
426 ;;;###tramp-autoload
430 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
431 ;; Do not add "plink" based methods, they ask interactively for the user.
432 ;;;###tramp-autoload
441 ;;;###tramp-autoload
447 ;;;###tramp-autoload
463 ;;;###tramp-autoload
468 ;;;###tramp-autoload
473 ;;;###tramp-autoload
478 ;;;###tramp-autoload
486 ;;;###tramp-autoload
515 ;; "getconf PATH" yields:
516 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
517 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
518 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
519 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
520 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
521 ;; IRIX64: /usr/bin
522 ;;;###tramp-autoload
528 "List of directories to search for executables on remote host.
529 For every remote host, this variable will be set buffer local,
530 keeping the list of existing directories on that host.
532 You can use `~' in this list, but when searching for a shell which groks
533 tilde expansion, all directory names starting with `~' will be ignored.
535 `Default Directories' represent the list of directories given by
537 entry on head of this list, because these are the default
538 directories for POSIX compatible commands. On remote hosts which
539 do not offer the getconf command (like cygwin), the value
541 the list by the special value `tramp-default-remote-path'.
543 `Private Directories' are the settings of the $PATH environment,
544 as given in your `~/.profile'. This entry is represented in
545 the list by the special value `tramp-own-remote-path'."
553 ;;;###tramp-autoload
560 "List of environment variables to be set on the remote host.
562 Each element should be a string of the form ENVVARNAME=VALUE. An
563 entry ENVVARNAME= disables the corresponding environment variable,
564 which might have been set in the init files like ~/.profile.
566 Special handling is applied to the PATH environment, which should
567 not be set here. Instead, it should be set via `tramp-remote-path'."
573 ;;;###tramp-autoload
575 "Alist specifying extra arguments to pass to the remote shell.
576 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
577 matching the shell file name and ARGS is a string specifying the
578 arguments.
580 This variable is only used when Tramp needs to start up another shell
581 for tilde expansion. The extra arguments should typically prevent the
582 shell from reading its init file."
584 ;; This might be the wrong way to test whether the widget type
585 ;; `alist' is available. Who knows the right way to test it?
601 "List of pattern/action pairs.
602 Whenever a pattern matches, the corresponding action is performed.
603 Each item looks like (PATTERN ACTION).
605 The PATTERN should be a symbol, a variable. The value of this
606 variable gives the regular expression to search for. Note that the
608 appended to it.
610 The ACTION should also be a symbol, but a function. When the
618 "List of pattern/action pairs.
619 This list is used for copying/renaming with out-of-band methods.
624 "(echo begin 600 %t; tail -n +2) | uudecode
625 cat %t
626 rm -f %t"
627 "Shell function to implement `uudecode' to standard output.
628 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
629 for this or `uudecode -p', but some systems don't, and for them
633 "%s -e '
634 use File::Spec;
637 sub myrealpath {
638 my ($file) = @_;
639 return realpath($file) if -e $file;
640 }
642 sub recursive {
643 my ($volume, @dirs) = @_;
644 my $real = myrealpath(File::Spec->catpath(
646 if ($real) {
647 my ($vol, $dir) = File::Spec->splitpath($real, 1);
648 return ($vol, File::Spec->splitdir($dir));
649 }
650 else {
651 my $last = pop(@dirs);
652 ($volume, @dirs) = recursive($volume, @dirs);
653 push(@dirs, $last);
654 return ($volume, @dirs);
655 }
656 }
658 $result = myrealpath($ARGV[0]);
659 if (!$result) {
660 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
661 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
664 }
669 "Perl script to produce output suitable for use with `file-truename'
670 on the remote file system.
671 Escape sequence %s is replaced with name of Perl binary.
675 "%s -e '
677 @files = readdir(d); closedir(d);
678 foreach $f (@files) {
681 }
682 else {
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.
1071 "Alist of handler functions.
1074 ;; This must be the last entry, because `identity' always matches.
1075 ;;;###tramp-autoload
1079 ;;; File Name Handler Functions:
1083 "Like `make-symbolic-link' for Tramp files.
1084 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1085 the symlink. If LINKNAME is a Tramp file, only the localname component is
1086 used as the target of the symlink.
1088 If LINKNAME is a Tramp file and the localname component is relative, then
1089 it is expanded first, before the localname component is taken. Note that
1090 this can give surprising results if the user/host for the source and
1091 target of the symlink differ."
1098 l 'file-error
1101 ;; Do the 'confirm if exists' thing.
1103 ;; What to do?
1108 "File %s already exists; make it a link anyway? "
1109 l-localname)))))
1114 ;; If FILENAME is a Tramp name, use just the localname component.
1123 ;; Right, they are on the same host, regardless of user, method,
1124 ;; etc. We now make the link on the remote machine. This will
1125 ;; occur as the user that FILENAME belongs to.
1130 "%s -sf %s %s"
1131 ln
1133 ;; The command could exceed PATH_MAX, so we use
1134 ;; relative file names. However, relative file names
1135 ;; could start with "-". `tramp-shell-quote-argument'
1136 ;; does not handle this, we must do it ourselves.
1141 "Like `file-truename' for Tramp files."
1143 "%s%s"
1146 method user host
1151 ;; Use GNU readlink --canonicalize-missing where available.
1154 v
1162 ;; Use Perl implementation.
1170 v
1174 ;; Do it yourself.
1178 ;; Don't make the following value larger than
1179 ;; necessary. People expect an error message in a
1180 ;; timely fashion when something is wrong;
1181 ;; otherwise they might think that Emacs is hung.
1182 ;; Of course, correctness has to come first.
1184 symlink-target)
1196 method user host
1208 ;; It's a symlink, follow it.
1214 ;; If the symlink was absolute, we'll get a
1215 ;; string like "/user@host:/some/target";
1216 ;; extract the "/some/target" part from it.
1220 v 'file-error
1221 "Symlink target `%s' on wrong host"
1222 symlink-target))
1228 ;; It's a file.
1232 v 'file-error
1235 ;; Combine list to form string.
1244 result))))
1246 ;; Preserve trailing "/".
1249 ;; Basic functions.
1252 "Like `file-exists-p' for Tramp files."
1260 v
1262 "%s %s"
1267 "Like `file-attributes' for Tramp files."
1270 ;; Don't modify `last-coding-system-used' by accident.
1277 v
1285 ;; The scripts could fail, for example with huge file size.
1289 "Implement `file-attributes' for Tramp files using the ls(1) command."
1291 res-inode res-filemodes res-numlinks
1292 res-uid res-gid res-size res-symlink-target)
1294 ;; We cannot send all three commands combined, it could exceed
1295 ;; NAME_MAX or PATH_MAX. Happened on Mac OS X, for example.
1297 vec
1302 vec
1307 vec
1311 ;; On systems which have no quoting style, file names
1312 ;; with special characters could fail.
1320 ;; Parse `ls -l' output ...
1324 ;; ... inode
1340 ;; ... file mode flags
1342 ;; ... number links
1344 ;; ... uid and gid
1356 ;; ... size
1358 ;; From the file modes, figure out other stuff.
1361 ;; If symlink, find out file name pointed to.
1368 ;; Return data gathered.
1370 ;; 0. t for directory, string (name linked to) for symbolic
1371 ;; link, or nil.
1373 ;; 1. Number of links to file.
1374 res-numlinks
1375 ;; 2. File uid.
1376 res-uid
1377 ;; 3. File gid.
1378 res-gid
1379 ;; 4. Last access time, as a list of integers. Normally
1380 ;; this would be in the same format as `current-time', but
1381 ;; the subseconds part is not currently implemented, and
1382 ;; (0 0) denotes an unknown time.
1383 ;; 5. Last modification time, likewise.
1384 ;; 6. Last status change time, likewise.
1386 ;; 7. Size in bytes (-1, if number is out of range).
1387 res-size
1388 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1389 res-filemodes
1390 ;; 9. t if file's gid would change if file were deleted and
1391 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1392 t
1393 ;; 10. Inode number.
1394 res-inode
1395 ;; 11. Device number. Will be replaced by a virtual device number.
1400 "Implement `file-attributes' for Tramp files using a Perl script."
1405 vec
1411 "Implement `file-attributes' for Tramp files using stat(1) command."
1414 vec
1417 ;; On Opsware, pdksh (which is the true name of ksh there)
1418 ;; doesn't parse correctly the sequence "((". Therefore, we add
1419 ;; a space. Apostrophes in the stat output are masked as
1420 ;; `tramp-stat-marker', in order to make a proper shell escape of
1421 ;; them in file names.
1422 "( (%s %s || %s -h %s) && (%s -c "
1423 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1430 tramp-stat-marker tramp-stat-marker
1435 tramp-stat-marker tramp-stat-marker
1437 tramp-stat-quoted-marker)))
1440 "Like `set-visited-file-modtime' for Tramp files."
1447 coding-system-used)
1451 ;; '(-1 65535) means file doesn't exists yet.
1455 ;; We use '(0 0) as a don't-know value. See also
1456 ;; `tramp-do-file-attributes-with-ls'.
1461 v
1469 nil)))))
1471 ;; This function makes the same assumption as
1472 ;; `tramp-sh-handle-set-visited-file-modtime'.
1474 "Like `verify-visited-file-modtime' for Tramp files.
1475 At the time `verify-visited-file-modtime' calls this function, we
1476 already know that the buffer is visiting a file and that
1477 `visited-file-modtime' does not return 0. Do not call this
1478 function directly, unless those two cases are already taken care
1479 of."
1482 ;; There is no file visiting the buffer, or the buffer has no
1483 ;; recorded last modification time, or there is no established
1484 ;; connection.
1488 t
1496 ;; File exists, and has a known modtime.
1499 modtime
1500 ;; For compatibility, deal with both the old
1501 ;; (HIGH . LOW) and the new (HIGH LOW) return
1502 ;; values of `visited-file-modtime'.
1505 mt)))
1507 ;; Modtime has the don't know value.
1510 v
1517 attr
1520 ;; If file does not exist, say it is not modified if and
1521 ;; only if that agrees with the buffer's record.
1525 "Like `set-file-modes' for Tramp files."
1529 ;; FIXME: extract the proper text from chmod's stderr.
1531 v
1536 "Like `set-file-times' for Tramp files."
1543 time)))
1546 "env TZ=UTC %s %s %s"
1554 "Set the ownership for FILENAME.
1555 If UID and GID are provided, these values are used; otherwise uid
1556 and gid of the corresponding user is taken. Both parameters must
1557 be non-negative integers."
1558 ;; Modern Unices allow chown only for root. So we might need
1559 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1560 ;; working with su(do)? when it is needed, so it shall succeed in
1561 ;; the majority of cases.
1562 ;; Don't modify `last-coding-system-used' by accident.
1567 ;; If we are root on the local host, we can do it directly.
1575 "chown %d:%d %s" uid gid
1578 ;; We handle also the local part, because there doesn't exist
1579 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1580 ;; timeout for this.
1585 nil "chown" nil nil nil
1589 "Check, whether SELINUX is enabled on the remote host."
1594 "Like `file-selinux-context' for Tramp files."
1603 "%s -d -Z %s"
1611 ;; Return the context.
1612 context))))
1615 "Like `set-file-selinux-context' for Tramp files."
1635 t)))))
1638 "Check, whether ACL is enabled on the remote host."
1643 "Like `file-acl' for Tramp files."
1649 "getfacl -ac %s"
1658 "Like `set-file-acl' for Tramp files."
1665 tramp-end-of-heredoc
1666 acl-string
1667 tramp-end-of-heredoc))
1669 ;; Success.
1672 t)
1673 ;; In case of errors, we return nil.
1675 nil)))
1677 ;; Simple functions using the `test' command.
1680 "Like `file-executable-p' for Tramp files."
1683 ;; Examine `file-attributes' cache to see if request can be
1684 ;; satisfied without remote operation.
1689 "Like `file-readable-p' for Tramp files."
1692 ;; Examine `file-attributes' cache to see if request can be
1693 ;; satisfied without remote operation.
1697 ;; When the remote shell is started, it looks for a shell which groks
1698 ;; tilde expansion. Here, we assume that all shells which grok tilde
1699 ;; expansion will also provide a `test' command which groks `-nt' (for
1700 ;; newer than). If this breaks, tell me about it and I'll try to do
1701 ;; something smarter about it.
1703 "Like `file-newer-than-file-p' for Tramp files."
1705 nil)
1707 t)
1708 ;; We are sure both files exist at this point.
1711 ;; We try to get the mtime of both files. If they are not
1712 ;; equal to the "dont-know" value, then we subtract the times
1713 ;; and obtain the result.
1726 ;; If one of them is the dont-know value, then we can
1727 ;; still try to run a shell command on the remote host.
1728 ;; However, this only works if both files are Tramp
1729 ;; files and both have the same method, same user, same
1730 ;; host.
1735 v 'file-error
1736 "Files %s and %s must have same method, user, host"
1737 file1 file2)))
1742 ;; Functions implemented using the basic functions above.
1745 "Like `file-directory-p' for Tramp files."
1747 ;; `file-directory-p' is used as predicate for file name completion.
1748 ;; Sometimes, when a connection is not established yet, it is
1749 ;; desirable to return t immediately for "/method:foo:". It can
1750 ;; be expected that this is always a directory.
1756 "Like `file-writable-p' for Tramp files."
1760 ;; Examine `file-attributes' cache to see if request can be
1761 ;; satisfied without remote operation.
1764 ;; If file doesn't exist, check if directory is writable.
1769 "Like `file-ownership-preserved-p' for Tramp files."
1773 ;; Return t if the file doesn't exist, since it's true that no
1774 ;; information would be lost by an (attempted) delete and create.
1783 ;; Directory listings.
1787 "Like `directory-files-and-attributes' for Tramp files."
1795 v localname
1806 v localname id-format))
1809 v localname id-format))
1811 result item)
1821 result
1823 ;; The scripts could fail, for example with huge file size.
1825 directory full match nosort id-format)))))
1829 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1832 vec tramp-perl-directory-files-and-attributes
1836 vec
1840 object))
1844 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1847 vec
1850 ;; We must care about file names with spaces, or starting with
1851 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1852 ;; but it does not work on all remote systems. Apostrophes in
1853 ;; the stat output are masked as `tramp-stat-marker', in order to
1854 ;; make a proper shell escape of them in file names.
1856 "xargs %s -c "
1857 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1861 ;; On systems which have no quoting style, file names with special
1862 ;; characters could fail.
1870 tramp-stat-marker tramp-stat-marker
1871 tramp-stat-marker tramp-stat-marker
1876 tramp-stat-marker tramp-stat-marker
1877 tramp-stat-quoted-marker)))
1879 ;; This function should return "foo/" for directories and "bar" for
1880 ;; files.
1882 "Like `file-name-all-completions' for Tramp files."
1885 filename
1889 ;; Get a list of directories and files, including reliably
1890 ;; tagging the directories with a trailing "/". Because I
1891 ;; rock. --daniel@danann.net
1893 v
1897 v tramp-perl-file-name-all-completions
1903 "(cd %s 2>&1 && %s -a 2>/dev/null"
1904 " | while IFS= read f; do"
1912 ;; Now grab the output.
1916 ;; Check result code, found in last line of output.
1920 ;; Grab error message from line before last line
1921 ;; (it was put there by `cd 2>&1').
1924 v 'file-error
1925 "tramp-sh-handle-file-name-all-completions: %s"
1927 ;; For peace of mind, if buffer doesn't end in `fail'
1928 ;; then it should end in `ok'. If neither are in the
1929 ;; buffer something went seriously wrong on the remote
1930 ;; side.
1934 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1939 result))))))
1941 ;; cp, mv and ln
1945 "Like `add-name-to-file' for Tramp files."
1950 v 'file-error
1951 "add-name-to-file: %s"
1960 "File %s already exists; make it a new name anyway? "
1961 newname)))
1963 v2 'file-already-exists
1969 v1
1973 "error with add-name-to-file, see buffer `%s' for details"
1978 preserve-uid-gid preserve-extended-attributes)
1979 "Like `copy-file' for Tramp files."
1983 ;; At least one file a Tramp file?
1987 'copy filename newname ok-if-already-exists keep-date
1988 preserve-uid-gid preserve-extended-attributes))
1989 ;; Compat section. PRESERVE-EXTENDED-ATTRIBUTES has been
1990 ;; introduced with Emacs 24.1 (as PRESERVE-SELINUX-CONTEXT), and
1991 ;; renamed in Emacs 24.3.
1994 'copy-file
1996 preserve-uid-gid preserve-extended-attributes)))
1999 'copy-file
2004 "Like `copy-directory' for Tramp files."
2010 ;; When DIRNAME and NEWNAME are remote, they must have
2011 ;; the same method.
2017 ;; scp or rsync DTRT.
2031 ;; We must do it file-wise.
2033 'copy-directory
2038 ;; When newname did exist, we have wrong cached values.
2046 "Like `rename-file' for Tramp files."
2047 ;; Check if both files are local -- invoke normal rename-file.
2048 ;; Otherwise, use Tramp from local system.
2051 ;; At least one file a Tramp file?
2055 'rename filename newname ok-if-already-exists
2062 preserve-uid-gid preserve-extended-attributes)
2063 "Copy or rename a remote file.
2064 OP must be `copy' or `rename' and indicates the operation to perform.
2065 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2066 the new file (for copy) or the new name of the file (for rename).
2067 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2068 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2069 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2070 the uid and gid if both files are on the same host.
2071 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2073 This function is invoked by `tramp-sh-handle-copy-file' and
2074 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2075 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2076 file names."
2094 filename newname)
2097 ;; Both are Tramp files.
2102 ;; Shortcut: if method, host, user are the same for
2103 ;; both files, we invoke `cp' or `mv' on the remote
2104 ;; host directly.
2107 op filename newname
2108 ok-if-already-exists keep-date preserve-uid-gid))
2110 ;; Try out-of-band operation.
2115 op filename newname keep-date))
2117 ;; No shortcut was possible. So we copy the file
2118 ;; first. If the operation was `rename', we go back
2119 ;; and delete the original file (if the copy was
2120 ;; successful). The approach is simple-minded: we
2121 ;; create a new buffer, insert the contents of the
2122 ;; source file into it, then write out the buffer to
2123 ;; the target file. The advantage is that it doesn't
2124 ;; matter which file name handlers are used for the
2125 ;; source and target file.
2128 op filename newname keep-date))))))
2130 ;; One file is a Tramp file, the other one is local.
2133 ;; Fast track on local machine.
2136 op filename newname
2137 ok-if-already-exists keep-date preserve-uid-gid))
2139 ;; If the Tramp file has an out-of-band method, the
2140 ;; corresponding copy-program can be invoked.
2143 op filename newname keep-date))
2145 ;; Use the inline method via a Tramp buffer.
2147 op filename newname keep-date))))
2150 ;; One of them must be a Tramp file.
2153 ;; Handle `preserve-extended-attributes'. We ignore possible
2154 ;; errors, because ACL strings could be incompatible.
2159 ;; In case of `rename', we must flush the cache of the source file.
2165 ;; When newname did exist, we have wrong cached values.
2172 "Use an Emacs buffer to copy or rename a file.
2173 First arg OP is either `copy' or `rename' and indicates the operation.
2174 FILENAME is the source file, NEWNAME the target file.
2175 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2176 ;; We must disable multibyte, because binary data shall not be
2177 ;; converted. We don't want the target file to be compressed, so we
2178 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2179 ;; be called either. We remove `tramp-file-name-handler' from
2180 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2181 ;; `insert-file-contents' might be deactivated in some corner cases.
2192 ;; KEEP-DATE handling.
2195 newname
2198 ;; Set the mode.
2200 ;; If the operation was `rename', delete the original file.
2205 "Invokes `cp' or `mv' on the remote system.
2206 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2207 respectively. FILENAME specifies the file to copy or rename,
2208 NEWNAME is the name of the new file (for copy) or the new name of
2209 the file (for rename). Both files must reside on the same host.
2210 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2211 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2212 the uid and gid from FILENAME."
2223 v 'file-error
2224 "Unknown operation `%s', must be `copy' or `rename'"
2225 op))))
2229 filename))
2233 newname))
2235 cmd-result)
2238 ;; Both files are on a remote host, with same user.
2250 ;; Mask cp -f error.
2252 tramp-operation-not-permitted-regexp nil t))
2253 cmd-result)
2255 nil v 'file-error
2256 "Copying directly failed, see buffer `%s' for details."
2259 ;; We are on the local host.
2262 ;; We can do it directly.
2265 ;; No sticky bit when renaming.
2276 localname1 localname2 ok-if-already-exists
2277 keep-date preserve-uid-gid)
2281 ;; We can do it directly with `tramp-send-command'
2289 ok-if-already-exists keep-date t)
2290 ;; We must change the ownership to the local user.
2296 ;; We need a temporary file in between.
2298 ;; Create the temporary file.
2306 "%s %s %s" cmd
2309 "Copying directly failed, see buffer `%s' for details."
2311 ;; We must change the ownership as remote user.
2312 ;; Since this does not work reliable, we also
2313 ;; give read permissions.
2323 localname1 tmpfile t
2324 keep-date preserve-uid-gid)
2326 'rename-file
2328 ;; We must change the ownership as local user.
2329 ;; Since this does not work reliable, we also
2330 ;; give read permissions.
2333 tmpfile
2337 ;; Move the temporary file to its destination.
2342 "cp -f -p %s %s"
2345 "Copying directly failed, see buffer `%s' for details."
2349 'rename-file
2352 ;; Save exit.
2355 ;; Set the time and mode. Mask possible errors.
2362 "Invoke `scp' program to copy.
2363 The method used must be an out-of-band method."
2367 copy-program copy-args copy-env copy-keep-date port listener spec
2368 options source target remote-copy-program remote-copy-args)
2373 ;; Both are Tramp files. We shall optimize it when the
2374 ;; methods for FILENAME and NEWNAME are the same.
2384 op filename tmpfile keep-date)
2387 ;; Save exit.
2394 ;; Set variables for computing the prompt for reading
2395 ;; password.
2402 ;; Expand hops. Might be necessary for gateway methods.
2406 ;; Check which ones of source and target are Tramp files.
2410 'file-name-as-directory
2419 ;; Check for host and port number. We cannot use
2420 ;; `tramp-file-name-port', because this returns also
2421 ;; `tramp-default-port', which might clash with settings in
2422 ;; "~/.ssh/config".
2429 ;; Check for user. There might be an interactive setting.
2433 ;; Check for listener port.
2440 ;; Compose copy command.
2449 ?h host ?u user ?p port ?r listener ?c options
2455 copy-args
2457 ;; " " has either been a replacement of "%k" (when
2458 ;; keep-date argument is non-nil), or a replacement
2459 ;; for the whole keep-date sublist.
2460 " "
2465 copy-args
2469 copy-env
2471 nil
2478 remote-copy-program
2484 remote-copy-args
2488 ;; Check for local copy program.
2493 ;; Install listener on the remote side. The prompt must be
2494 ;; consumed later on, when the process does not listen anymore.
2501 v 'file-error
2505 'identity
2513 v 'file-error
2514 "Listener process not running on remote host: `%s'"
2515 remote-copy-program))
2523 ;; The default directory must be remote.
2527 ;; Set the transfer process properties.
2537 copy-args
2539 copy-args
2544 ;; Use an asynchronous process. By this, password can
2545 ;; be handled. We don't set a timeout, because the
2546 ;; copying of large files can last longer than 60 secs.
2556 command))))
2561 ;; We must adapt `tramp-local-end-of-line' for
2562 ;; sending the password.
2565 p v nil tramp-actions-copy-out-of-band))))
2567 ;; Reset the transfer process properties.
2570 ;; Clear the remote prompt.
2573 ;; Houston, we have a problem! Likely, the listener is
2574 ;; still running, so let's clear everything (but the
2575 ;; cached password).
2578 ;; Handle KEEP-DATE argument.
2581 newname
2585 ;; Set the mode.
2590 ;; If the operation was `rename', delete the original file.
2597 "Like `make-directory' for Tramp files."
2609 "Like `delete-directory' for Tramp files."
2621 "Like `delete-file' for Tramp files."
2632 ;; Dired.
2638 "Like `dired-compress-file' for Tramp files."
2639 ;; Code stolen mainly from dired-aux.el.
2644 suffix)
2645 ;; See if any suffix rule matches this file name.
2653 nil)
2655 ;; We found an uncompression rule.
2665 ;; We don't recognize the file as compressed, so compress it.
2666 ;; Try gzip.
2680 "Like `insert-directory' for Tramp files."
2687 filename switches wildcard full-directory-p)
2709 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2710 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2713 v
2716 switches
2718 localname
2721 v
2725 "Couldn't `cd %s'"
2729 v
2732 switches
2737 ""
2745 ;; We cannot use `insert-buffer-substring' because the Tramp
2746 ;; buffer changes its contents before insertion due to calling
2747 ;; `expand-file-name' and alike.
2752 ;; Check for "--dired" output.
2759 ;; Now read the numeric positions of file names.
2765 ;; End is followed by \n or by " -> ".
2767 ;; Remove trailing lines.
2773 ;; Some busyboxes are reluctant to discard colors.
2781 ;; Decode the output, it could be multibyte.
2786 ;; The inserted file could be from somewhere else.
2793 "."
2800 ;; Canonicalization of file names.
2803 "Like `expand-file-name' for Tramp files.
2805 the result will be a local, non-Tramp, file name."
2806 ;; If DIR is not given, use `default-directory' or "/".
2808 ;; Unless NAME is absolute, concat DIR and NAME.
2811 ;; If connection is not established yet, run the real handler.
2814 ;; Dissect NAME.
2818 ;; Tilde expansion if necessary. This needs a shell which
2819 ;; groks tilde expansion! The function `tramp-find-shell' is
2820 ;; supposed to find such a shell on the remote host. Please
2821 ;; tell me about it when this doesn't work on your system.
2825 ;; We cannot simply apply "~/", because under sudo "~/" is
2826 ;; expanded to the local user home directory but to the
2827 ;; root home directory. On the other hand, using always
2828 ;; the default user name for tilde expansion is not
2829 ;; appropriate either, because ssh and companions might
2830 ;; use a user name from the config file.
2842 ;; There might be a double slash, for example when "~/"
2843 ;; expands to "/". Remove this.
2846 ;; No tilde characters in file name, do normal
2847 ;; `expand-file-name' (this does "/./" and "/../").
2848 ;; `default-directory' is bound, because on Windows there would
2849 ;; be problems with UNC shares or Cygwin mounts.
2852 method user host
2856 hop)))))
2858 ;;; Remote commands:
2861 "Flush file caches."
2869 ;; We use BUFFER also as connection buffer during setup. Because of
2870 ;; this, its original contents must be saved, and restored once
2871 ;; connection has been setup.
2873 "Like `start-file-process' for Tramp files."
2878 ;; BUFFER can be nil. We use a temporary buffer.
2880 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2881 ;; it might be that the arguments exceed the command line
2882 ;; length. Therefore, we modify the command.
2887 ;; When PROGRAM is nil, we just provide a tty.
2893 args
2897 ;; Use a human-friendly prompt, for example for `shell'.
2898 ;; We discard hops, if existing, that's why we cannot use
2899 ;; `file-remote-p'.
2906 tramp-initial-end-of-output))
2907 ;; We use as environment the difference to toplevel
2908 ;; `process-environment'.
2909 env uenv
2923 "unset %s &&"
2938 ;; We do not want to raise an error when
2939 ;; `start-file-process' has been started several times in
2940 ;; `eshell' and friends.
2944 ;; NAME must be unique as process name.
2948 ;; Set the new process properties.
2954 ;; We catch this event. Otherwise, `start-process' could
2955 ;; be called on the local host.
2958 ;; Activate narrowing in order to save BUFFER
2959 ;; contents. Clear also the modification time;
2960 ;; otherwise we might be interrupted by
2961 ;; `verify-visited-file-modtime'.
2967 ;; We call `tramp-maybe-open-connection', in order
2968 ;; to cleanup the prompt afterwards.
2974 ;; Now do it.
2976 ;; Send the command.
2978 ;; Check, whether a pty is associated.
2982 v 'file-error
2985 ;; Set query flag and process marker for this
2986 ;; process. We ignore errors, because the process
2987 ;; could have finished already.
2991 ;; Return process.
2992 p))))
2994 ;; Save exit.
3005 "Like `process-file' for Tramp files."
3006 ;; The implementation is not complete yet.
3012 ;; Compute command.
3015 ;; We use as environment the difference to toplevel `process-environment'.
3026 "env %s %s"
3031 "unset %s && %s"
3033 ;; Determine input.
3038 ;; INFILE is on the same remote host.
3040 ;; INFILE must be copied to remote host.
3046 ;; Determine output.
3048 ;; Just a buffer.
3051 ;; A buffer name.
3054 ;; (REAL-DESTINATION ERROR-DESTINATION)
3056 ;; output.
3064 ;; stderr.
3069 ;; stderr is on the same remote host.
3072 ;; stderr must be copied to remote host. The temporary
3073 ;; file must be deleted after execution.
3076 method user host stderr))))
3077 ;; stderr to be discarded.
3080 ;; 't
3085 ;; Send the command. It might not return in time, so we protect
3086 ;; it. Call it in a subshell, in order to preserve working
3087 ;; directory.
3094 command)
3095 t t)
3097 ;; We should add the output anyway.
3104 ;; When the user did interrupt, we should do it also. We use
3105 ;; return code -1 as marker.
3109 ;; Handle errors.
3114 ;; Provide error file.
3117 ;; Cleanup. We remove all file cache values for the connection,
3118 ;; because the remote process could have changed them.
3124 ;; Return exit status.
3127 ret))))
3130 "Like `file-local-copy' for Tramp files."
3134 v tramp-file-missing
3145 ;; `copy-file' handles direct copy and out-of-band methods.
3150 ;; Use inline encoding for file transfer.
3154 v 3
3156 filename rem-enc)
3163 tmpfile loc-dec)
3165 ;; If local decoding is a function, we call it.
3166 ;; We must disable multibyte, because
3167 ;; `uudecode-decode-region' doesn't handle it
3168 ;; correctly. Unset `file-name-handler-alist'.
3169 ;; Otherwise, epa-file gets confused.
3177 ;; If tramp-decoding-function is not defined for this
3178 ;; method, we invoke tramp-decoding-command instead.
3180 ;; Unset `file-name-handler-alist'. Otherwise,
3181 ;; epa-file gets confused.
3189 loc-dec tmpfile2 tmpfile)
3192 ;; Set proper permissions.
3194 ;; Set local user ownership.
3197 ;; Oops, I don't know what to do.
3201 ;; Error handling.
3207 tmpfile)))
3209 ;; CCC grok LOCKNAME
3212 "Like `write-region' for Tramp files."
3215 ;; Following part commented out because we don't know what to do about
3216 ;; file locking, and it does not appear to be a problem to ignore it.
3217 ;; Ange-ftp ignores it, too.
3218 ;; (when (and lockname (stringp lockname))
3219 ;; (setq lockname (expand-file-name lockname)))
3220 ;; (unless (or (eq lockname nil)
3221 ;; (string= lockname filename))
3222 ;; (error
3223 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3237 ;; `file-writable-p' calls `file-expand-file-name'. We
3238 ;; cannot use `tramp-run-real-handler' therefore.
3244 ;; Short track: if we are on the local host, we can run directly.
3246 'write-region
3250 ;; We use this to save the value of
3251 ;; `last-coding-system-used' after writing the tmp
3252 ;; file. At the end of the function, we set
3253 ;; `last-coding-system-used' to this saved value. This
3254 ;; way, any intermediary coding systems used while
3255 ;; talking to the remote shell or suchlike won't hose
3256 ;; this variable. This approach was snarfed from
3257 ;; ange-ftp.el.
3258 coding-system-used
3259 ;; Write region into a tmp file. This isn't really
3260 ;; needed if we use an encoding function, but currently
3261 ;; we use it always because this makes the logic
3262 ;; simpler. We must also set `temporary-file-directory',
3263 ;; because it could point to a remote directory.
3269 ;; If `append' is non-nil, we copy the file locally, and let
3270 ;; the native `write-region' implementation do the job.
3273 ;; We say `no-message' here because we don't want the
3274 ;; visited file modtime data to be clobbered from the temp
3275 ;; file. We call `set-visited-file-modtime' ourselves later
3276 ;; on. We must ensure that `file-coding-system-alist'
3277 ;; matches `tmpfile'.
3283 'write-region
3290 ;; Now, `last-coding-system-used' has the right value. Remember it.
3293 ;; The permissions of the temporary file should be set. If
3294 ;; FILENAME does not exist (eq modes nil) it has been
3295 ;; renamed to the backup file. This case `save-buffer'
3296 ;; handles permissions.
3297 ;; Ensure that it is still readable.
3300 tmpfile
3303 ;; This is a bit lengthy due to the different methods
3304 ;; possible for file transfer. First, we check whether the
3305 ;; method uses an scp program. If so, we call it.
3306 ;; Otherwise, both encoding and decoding command must be
3307 ;; specified. However, if the method _also_ specifies an
3308 ;; encoding function, then that is used for encoding the
3309 ;; contents of the tmp file.
3315 ;; `copy-file' handles direct copy and out-of-band methods.
3325 ;; We keep the local file for performance
3326 ;; reasons, useful for "rsync".
3333 ;; Don't rename, in order to keep context in SELinux.
3338 ;; Use inline file transfer.
3340 ;; Encode tmpfile.
3344 ;; Use encoding function or command.
3347 "Encoding local file `%s' using `%s'"
3348 tmpfile loc-enc)
3350 ;; The following `let' is a workaround for
3351 ;; the base64.el that comes with pgnus-0.84.
3352 ;; If both of the following conditions are
3353 ;; satisfied, it tries to write to a local
3354 ;; file in default-directory, but at this
3355 ;; point, default-directory is remote.
3356 ;; (`call-process-region' can't write to
3357 ;; remote files, it seems.) The file in
3358 ;; question is a tmp file anyway.
3366 loc-enc tmpfile t))
3368 v 'file-error
3371 filename loc-enc))))
3373 ;; Send buffer into remote decoding command which
3374 ;; writes to remote file. Because this happens on
3375 ;; the remote host, we cannot use the function.
3378 "Decoding remote file `%s' using `%s'"
3379 filename rem-dec)
3383 v
3387 tramp-end-of-heredoc
3389 tramp-end-of-heredoc))
3391 v nil
3392 "Couldn't write region to `%s', decode using `%s' failed"
3393 filename rem-dec)
3394 ;; When `file-precious-flag' is set, the region is
3395 ;; written to a temporary file. Check that the
3396 ;; checksum is equal to that from the local tmpfile.
3400 ;; cksum runs locally, if possible.
3402 ;; cksum runs remotely.
3404 v
3407 ;; ... they are different.
3414 v 'file-error
3417 filename rem-dec)))))
3419 ;; Save exit.
3422 ;; That's not expected.
3425 v 'file-error
3428 method))))
3430 ;; Make `last-coding-system-used' have the right value.
3437 ;; We must protect `last-coding-system-used', now we have set it
3438 ;; to its correct value.
3440 ;; Set file modification time.
3444 ;; We must pass modtime explicitly, because FILENAME can
3445 ;; be different from (buffer-file-name), f.e. if
3446 ;; `file-precious-flag' is set.
3452 ;; Set the ownership.
3462 ;; VC backends check for the existence of various different special
3463 ;; files. This is very time consuming, because every single check
3464 ;; requires a remote command (the file cache must be invalidated).
3465 ;; Therefore, we apply a kind of optimization. We install the file
3466 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3467 ;; remembers all file names for which `file-exists-p' or
3468 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3469 ;; is performed. Afterwards, a script is applied for all collected
3470 ;; file names, using just one remote command. The result of this
3471 ;; script is used to fill the file cache with actual values. Now we
3472 ;; can reset the file name handlers, and we make a second run of
3473 ;; `vc-registered', which returns the expected result without sending
3474 ;; any other remote command.
3476 "Like `vc-registered' for Tramp files."
3482 ;; There could be new files, created by the vc backend. We
3483 ;; cannot reuse the old cache entries, therefore. In
3484 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3485 ;; could also be a timestamp as `current-time' returns. This
3486 ;; means invalidate all cache entries with an older timestamp.
3492 ;; Here we collect only file names, which need an operation.
3496 ;; Send just one command, in order to fill the cache.
3499 v
3508 ;; We cannot use `tramp-send-command-and-read',
3509 ;; because this does not cooperate well with
3510 ;; heredoc documents.
3512 v
3515 tramp-end-of-heredoc
3517 tramp-vc-registered-file-names
3519 tramp-end-of-heredoc))
3521 ;; Read the expression.
3528 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3529 ;; calls shall be answered from the file cache. We unset
3530 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3531 ;; in order to keep the cache.
3533 remote-file-name-inhibit-cache process-file-side-effects)
3534 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3553 ;; Run.
3557 ;;;###tramp-autoload
3559 "Invoke remote-shell Tramp file name handler.
3560 Fall back to normal file name handler if no Tramp handler exists."
3578 "Invoke special file name handler, which collects files to be handled."
3586 ;; That's what we want: file names, for which checks are
3587 ;; applied. We assume that VC uses only `file-exists-p' and
3588 ;; `file-readable-p' checks; otherwise we must extend the
3589 ;; list. We do not perform any action, but return nil, in
3590 ;; order to keep `vc-registered' running.
3593 nil)
3594 ;; `process-file' and `start-file-process' shall be ignored.
3597 ;; Tramp file name handlers like `expand-file-name'. They
3598 ;; must still work.
3600 ;; Default file name handlers, we don't care.
3604 "Like `file-notify-add-watch' for Tramp files."
3608 command events filter p sequence)
3610 ;; gvfs-monitor-dir.
3613 events
3617 attribute-changed))
3622 ;; inotifywait.
3625 events
3635 ;; Make events a list of symbols.
3636 events
3640 ;; None.
3642 v 'file-notify-error
3643 "No file notification program found on %s"
3645 ;; Start process.
3647 'start-file-process
3651 sequence))
3652 ;; Return the process object as watch-descriptor.
3655 v 'file-notify-error
3656 "`%s' failed to start on remote host"
3660 ;; Needed for process filter.
3665 ;; There might be an error if the monitor is not supported.
3666 ;; Give the filter a chance to read the output.
3671 p))))
3675 file-notify events."
3685 ;; Attribute change is returned in unused wording.
3697 string)
3702 proc
3707 ;; File names are returned as absolute paths. We must
3708 ;; add the remote prefix.
3712 ;; Remove watch when file or directory to be watched is deleted.
3716 ;; Usually, we would add an Emacs event now. Unfortunately,
3717 ;; `unread-command-events' does not accept several events at
3718 ;; once. Therefore, we apply the handler directly.
3721 'file-notify-handle-event
3724 ;; Save rest of the string.
3734 ;; Check, whether there is a problem.
3740 line)
3745 proc
3752 ;; Remove watch when file or directory to be watched is deleted.
3755 ;; Usually, we would add an Emacs event now. Unfortunately,
3756 ;; `unread-command-events' does not accept several events at
3757 ;; once. Therefore, we apply the handler directly.
3760 'file-notify-handle-event
3763 ;;; Internal Functions:
3766 "Define in remote shell function NAME implemented as SCRIPT.
3767 Only send the definition if it has not already been done."
3768 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3769 ;; might be nil.
3775 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3776 ;; could result in unwanted command expansion. Avoid this.
3779 ;; The script could contain a call of Perl. This is masked with `%s'.
3784 vec
3792 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3793 Returns the exit code of the `test' program."
3796 v
3798 "%s %s %s"
3800 switch
3804 "Run `test'-like program on the remote system, given FILE1, FILE2.
3805 FORMAT-STRING contains the program name, switches, and place holders.
3806 Returns the exit code of the `test' program. Barfs if the methods,
3807 hosts, or files, disagree."
3811 v 'file-error
3816 v1
3823 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3824 First arg VEC specifies the connection, PROGNAME is the program
3825 to search for, and DIRLIST gives the list of directories to
3826 search. If IGNORE-TILDE is non-nil, directory names starting
3827 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3828 only in DIRLIST.
3830 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3832 This function expects to be in the right *tramp* buffer."
3835 ;; Check whether the executable is in $PATH. "which(1)" does not
3836 ;; report always a correct error code; therefore we check the
3837 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3838 ;; 5.11") have problems with this command, we disable the call
3839 ;; therefore.
3850 ;; Remove all ~/foo directories from dirlist.
3859 vec
3861 "do if test -x $d/%s && test -f $d/%s; "
3862 "then echo tramp_executable $d/%s; "
3865 progname progname progname
3866 tramp-end-of-heredoc
3868 tramp-end-of-heredoc))
3874 result)))
3877 "Sets the remote environment PATH to existing directories.
3878 I.e., for each directory in `tramp-remote-path', it is tested
3879 whether it exists and if so, it is added to the environment
3880 variable PATH."
3886 ;; ------------------------------------------------------------
3887 ;; -- Communication with external shell --
3888 ;; ------------------------------------------------------------
3891 "Find a command on the remote host for checking if a file exists.
3892 Here, we are looking for a command which has zero exit status if the
3893 file exists and nonzero exit status otherwise."
3897 result)
3898 ;; The algorithm is as follows: we try a list of several commands.
3899 ;; For each command, we first run `$cmd /' -- this should return
3900 ;; true, as the root directory always exists. And then we run
3901 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3902 ;; does not exist. This should return false. We use the first
3903 ;; command we find that seems to work.
3904 ;; The list of commands to try is as follows:
3905 ;; `ls -d' This works on most systems, but NetBSD 1.4
3906 ;; has a bug: `ls' always returns zero exit
3907 ;; status, even for files which don't exist.
3908 ;; `test -e' Some Bourne shells have a `test' builtin
3909 ;; which does not know the `-e' option.
3910 ;; `/bin/test -e' For those, the `test' binary on disk normally
3911 ;; provides the option. Alas, the binary
3912 ;; is sometimes `/bin/test' and sometimes it's
3913 ;; `/usr/bin/test'.
3914 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3942 result))
3945 "Opens shell SHELL."
3948 ;; Find arguments for this shell.
3950 item extra-args)
3955 ;; It is useful to set the prompt in the following command
3956 ;; because some people have a setting for $PS1 which /bin/sh
3957 ;; doesn't know about and thus /bin/sh will display a strange
3958 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3959 ;; ksh will display the current working directory but /bin/sh
3960 ;; will display a dollar sign. The following command line sets
3961 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3962 ;; well as csh-like shells. We also unset the variable $ENV
3963 ;; because that is read by some sh implementations (eg, bash
3964 ;; when called as sh) on startup; this way, we avoid the startup
3965 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3966 ;; the prompt in /bin/bash, it must be discarded as well.
3967 ;; $HISTFILE is set according to `tramp-histfile-override'.
3970 "exec env ENV=%s %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3976 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3980 t))
3985 "Opens a shell on the remote host which groks tilde expansion."
3988 shell)
3991 ;; CCC: "root" does not exist always, see my QNAP TS-459.
3992 ;; Which check could we apply instead?
3995 ;; The default shell (ksh93) of OpenSolaris and
3996 ;; Solaris is buggy. We've got reports for
3997 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4006 ;; Maybe it works at least for some other commands.
4008 default-shell
4010 vec 2
4012 "Couldn't find a remote shell which groks tilde "
4014 default-shell)))
4016 default-shell)))
4018 ;; Open a new shell if needed.
4024 ;; Utility functions.
4027 "Wait for shell prompt and barf if none appears.
4028 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4029 seconds. If not, it produces an error message with the given ERROR-ARGS."
4033 proc timeout
4042 "Set up an interactive shell.
4043 Mainly sets the prompt and the echo correctly. PROC is the shell
4044 process to set up. VEC specifies the connection."
4049 ;; Disable echo expansion.
4053 ;; Check whether the echo has really been disabled. Some
4054 ;; implementations, like busybox of embedded GNU/Linux, don't
4055 ;; support disabling.
4062 ;; Make sure backspaces and their echo are enabled and no line
4063 ;; width magic interferes with them.
4070 t)
4072 ;; Check whether the output of "uname -sr" has been changed. If
4073 ;; yes, this is a strong indication that we must expire all
4074 ;; connection properties. We start again with
4075 ;; `tramp-maybe-open-connection', it will be caught there.
4080 vec "uname"
4084 vec 3
4085 "Connection reset, because remote host changed from `%s' to `%s'"
4086 old-uname uname)
4087 ;; We want to keep the password.
4091 ;; Try to set up the coding system correctly.
4092 ;; CCC this can't be the right way to do it. Hm.
4095 ;; Use MULE to select the right EOL convention for
4096 ;; communicating with the process.
4102 cs-decode cs-encode)
4106 cs-encode
4113 ;; Special setting for Mac OS X.
4124 ;; Check whether the remote host suffers from buggy
4125 ;; `send-process-string'. This is known for FreeBSD (see comment
4126 ;; in `send_process', file process.c). I've tested sending 624
4127 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4128 ;; hack when this host type is detected locally. It cannot handle
4129 ;; remote hosts, though.
4133 tramp-chunksize)
4139 ;; Set remote PATH variable.
4142 ;; Search for a good shell before searching for a command which
4143 ;; checks if a file exists. This is done because Tramp wants to
4144 ;; use "test foo; echo $?" to check if various conditions hold,
4145 ;; and there are buggy /bin/sh implementations which don't execute
4146 ;; the "echo $?" part if the "test" part has an error. In
4147 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4148 ;; also other problems with /bin/sh of OpenSolaris, like
4149 ;; redirection of stderr in function declarations, or changing
4150 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4151 ;; by bash, when detected.
4154 ;; Disable unexpected output.
4157 ;; IRIX64 bash expands "!" even when in single quotes. This
4158 ;; destroys our shell functions, we must disable it. See
4159 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4163 ;; Disable tab expansion.
4168 ;; Set utf8 encoding. Needed for Mac OS X, for example. This is
4169 ;; non-POSIX, so we must expect errors on some systems.
4172 ;; Set `remote-tty' process property.
4177 ;; Dump stty settings in the traces.
4181 ;; Set the environment.
4195 vec
4197 tramp-end-of-heredoc
4199 tramp-end-of-heredoc)
4200 t))
4205 ;; Old text from documentation of tramp-methods:
4206 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4207 ;; of the base64 methods instead since base64 encoding is much more
4208 ;; reliable and the commands are more standardized between the different
4209 ;; Unix versions. But if you can't use base64 for some reason, please
4210 ;; note that the default uudecode command does not work well for some
4211 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4212 ;; the following command for uudecode:
4213 ;;
4214 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4215 ;;
4216 ;; For Irix, no solution is known yet.
4224 "List of local coding commands for inline transfer.
4225 Each item is a list that looks like this:
4227 \(FORMAT ENCODING DECODING)
4229 FORMAT is symbol describing the encoding/decoding format. It can be
4230 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4232 ENCODING and DECODING can be strings, giving commands, or symbols,
4233 giving functions. If they are strings, then they can contain
4235 file name will be put into the command line at that spot. If the
4236 specifier is not present, the input should be read from standard
4237 input.
4239 If they are functions, they will be called with two arguments, start
4240 and end of region, and are expected to replace the region contents
4245 ;; "-i" is more robust with older base64 from GNU coreutils.
4246 ;; However, I don't know whether all base64 versions do supports
4247 ;; this option.
4255 ;; This is painful slow, so we put it on the end.
4262 "List of remote coding commands for inline transfer.
4263 Each item is a list that looks like this:
4265 \(FORMAT ENCODING DECODING [TEST])
4267 FORMAT is a symbol describing the encoding/decoding format. It can be
4268 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4270 ENCODING and DECODING can be strings, giving commands, or symbols,
4271 giving variables. If they are strings, then they can contain
4273 file name will be put into the command line at that spot. If the
4274 specifier is not present, the input should be read from standard
4275 input.
4277 If they are variables, this variable is a string containing a
4278 Perl or Shell implementation for this functionality. This
4279 program will be transferred to the remote host, and it is
4281 specifier in the variable value denotes a temporary file.
4283 The optional TEST command can be used for further tests, whether
4287 "Find an inline transfer encoding that works.
4288 Goes through the list `tramp-local-coding-commands' and
4289 `tramp-remote-coding-commands'."
4294 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4302 ;; If the local encoder or decoder is a string, the
4303 ;; corresponding command has to work locally.
4310 loc-enc nil nil))
4318 loc-dec nil nil))
4320 ;; Search for remote coding commands with the same format
4328 ;; Check the remote test command if exists.
4334 ;; Check if remote perl exists when necessary.
4339 ;; Check if remote encoding and decoding commands can be
4340 ;; called remotely with null input and output. This makes
4341 ;; sure there are no syntax errors and the command is really
4342 ;; found. Note that we do not redirect stdout to /dev/null,
4343 ;; for two reasons: when checking the decoding command, we
4344 ;; actually check the output it gives. And also, when
4345 ;; redirecting "mimencode" output to /dev/null, then as root
4346 ;; it might change the permissions of /dev/null!
4354 vec 5
4363 tmpfile)
4370 tramp-temp-name-prefix
4372 value
4374 value
4376 ?t
4381 vec 5
4384 vec
4386 t)
4394 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4400 ;; Set connection properties. Since the commands are risky
4401 ;; (due to output direction), we cache them in the process cache.
4412 "Call the local encoding or decoding command.
4414 Otherwise, INPUT is passed via standard input.
4415 INPUT can also be nil which means `/dev/null'.
4416 OUTPUT can be a string (which specifies a file name), or t (which
4417 means standard output and thus the current buffer), or nil (which
4418 means discard it)."
4420 nil tramp-encoding-shell
4423 nil
4424 tramp-encoding-command-switch
4434 "List of compress and decompress commands for inline transfer.
4435 Each item is a list that looks like this:
4437 \(COMPRESS DECOMPRESS)
4442 "Find an inline transfer compress command that works.
4443 Goes through the list `tramp-inline-compress-commands'."
4448 item compress decompress found)
4455 vec 5
4456 "Checking local compress commands `%s', `%s' for sanity"
4457 compress decompress)
4462 ;; Windows shells need the program file name after
4463 ;; the pipe symbol be quoted if they use forward
4464 ;; slashes as directory separators.
4471 vec 5
4472 "Checking remote compress commands `%s', `%s' for sanity"
4473 compress decompress)
4479 ;; Did we find something?
4482 ;; Set connection properties. Since the commands are
4483 ;; risky (due to output direction), we cache them in the
4484 ;; process cache.
4498 "Expands VEC according to `tramp-default-proxies-alist'.
4499 Gateway hops are already opened."
4503 choices proxy)
4505 ;; Ad-hoc proxy definitions.
4510 tramp-prefix-format proxy tramp-postfix-host-format)))
4515 proxy)
4516 ;; Add the hop.
4518 'tramp-default-proxies-alist
4521 proxy))
4523 ;; Save the new value.
4528 ;; Look for proxy hosts to be passed.
4534 ;; Host.
4537 ;; User.
4541 ;; No more hops needed.
4543 ;; Replace placeholders.
4546 proxy
4551 ;; Add the hop.
4553 ;; Start next search.
4556 ;; Handle gateways.
4564 ;; Is the method prepared for gateways?
4567 vec 'file-error
4569 ;; Open the gateway connection.
4574 target-alist)
4575 ;; For the password prompt, we need the correct values.
4576 ;; Therefore, we must remember the gateway vector. But we
4577 ;; cannot do it as connection property, because it shouldn't
4578 ;; be persistent. And we have no started process yet either.
4582 ;; Foreign and out-of-band methods are not supported for multi-hops.
4589 vec 'file-error
4590 "Method `%s' is not supported for multi-hops."
4593 ;; In case the host name is not used for the remote shell
4594 ;; command, the user could be misguided by applying a random
4595 ;; host name.
4601 ;; There are multi-hops.
4603 ;; The host name is used for the remote shell command.
4605 ;; The host is local. We cannot use `tramp-local-host-p'
4606 ;; here, because it opens a connection as well.
4609 v 'file-error
4610 "Host `%s' looks like a remote host, `%s' can only use the local host"
4611 host method)))
4613 ;; Result.
4614 target-alist))
4617 "Return the Control* arguments of the local ssh."
4619 ;; No options to be computed.
4624 ;; There is already a value to be used.
4627 ;; Determine the options.
4639 ;; We use a non-existing IP address, in order to avoid
4640 ;; useless connections, and DNS timeouts.
4647 " -o ControlPath='tramp.%%r@%%h:%%p'"
4656 tramp-ssh-controlmaster-options)))
4659 "Maybe open a connection VEC.
4660 Does not do anything if a connection is already open, but re-opens the
4661 connection if a previous connection has died for some reason."
4669 ;; If Tramp opens the same connection within a short time frame,
4670 ;; there is a problem. We shall signal this.
4679 ;; If too much time has passed since last command was sent, look
4680 ;; whether process is still alive. If it isn't, kill it. When
4681 ;; using ssh, it can sometimes happen that the remote end has hung
4682 ;; up but the local ssh client doesn't recognize this until it
4683 ;; tries to send some data to the remote end. So that's why we
4684 ;; try to send a command from time to time, then look again
4685 ;; whether the process is really alive.
4696 ;; The error will be caught locally.
4702 ;; New connection must be opened.
4706 ;; If `non-essential' is non-nil, don't reopen a new connection.
4707 ;; This variable has been introduced with Emacs 24.1.
4712 vec 3
4723 ;; Start new process.
4740 ;; We will apply `tramp-ssh-controlmaster-options'
4741 ;; only for the first hop.
4745 ;; There are unfortunate settings for "cmdproxy" on
4746 ;; W32 systems.
4749 ;; This must be done in order to avoid our file
4750 ;; name handler.
4754 'start-process
4759 tramp-encoding-command-interactive)
4762 ;; Set sentinel and query flag.
4773 ;; Check whether process is alive.
4775 p 10
4778 ;; Now do all the connections as specified.
4804 ;; We don't create the temporary file. In
4805 ;; fact, it is just a prefix for the
4806 ;; ControlPath option of ssh; the real
4807 ;; temporary file has another name, and it is
4808 ;; created and protected by ssh. It is also
4809 ;; removed by ssh when the connection is
4810 ;; closed. The temporary file name is cached
4811 ;; in the main connection process, therefore
4812 ;; we cannot use `tramp-get-connection-process'.
4818 tramp-temp-name-prefix
4820 spec r-shell)
4822 ;; Add arguments for asynchronous processes.
4826 ;; Add gateway arguments if necessary.
4832 ;; Check for port number. Until now, there's no
4833 ;; need for handling like method, user, host.
4838 ;; Check, whether there is a restricted shell.
4843 ;; Set variables for computing the prompt for
4844 ;; reading password. They can also be derived
4845 ;; from a gateway.
4850 ;; Add login environment.
4853 login-env
4858 login-env))
4862 "%s=%s %s"
4865 command)))
4868 ;; Replace `login-args' place holders.
4876 ?h l-host ?u l-user ?p l-port ?c options)
4877 command
4879 ;; We do not want to see the trailing local
4880 ;; prompt in `start-file-process'.
4882 command " "
4888 ;; Local shell could be a Windows COMSPEC. It
4889 ;; doesn't know the ";" syntax, but we must exit
4890 ;; always for `start-file-process'. It could
4891 ;; also be a restricted shell, which does not
4892 ;; allow "exec".
4895 ;; Send the command.
4899 p vec
4902 tramp-actions-before-shell
4906 ;; Next hop.
4910 ;; Make initial shell settings.
4913 ;; Mark it as connected.
4916 ;; When the user did interrupt, we must cleanup.
4919 ;; Propagate the quit signal.
4923 "Send the COMMAND to connection VEC.
4924 Erases temporary buffer before sending the command. If optional
4925 arg NEVEROPEN is non-nil, never try to open the connection. This
4926 is meant to be used from `tramp-maybe-open-connection' only. The
4927 function waits for output unless NOOUTPUT is set."
4931 ;; We mark the command string that it can be erased in the output buffer.
4933 ;; If we put `tramp-echo-mark' after a trailing newline (which
4934 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4935 ;; that newline and adds `tramp-rsh-end-of-line' right after
4936 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4937 ;; trailing line endings and sends two prompts after executing
4938 ;; the command, which confuses `tramp-wait-for-output'.
4942 ;; No need to restore a trailing newline here since `tramp-send-string'
4943 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4945 ;; Send the command.
4951 "Wait for output from remote command."
4957 ;; be leading escape sequences, which must be ignored.
4958 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4959 ;; option send also escape sequences, which must be
4960 ;; ignored.
4963 tramp-device-escape-sequence-regexp))
4964 ;; Sometimes, the commands do not return a newline but a
4965 ;; null byte before the shell prompt, for example "git
4966 ;; ls-files -c -z ...".
4971 ;; A simple-minded busybox has sent " ^H" sequences.
4972 ;; Delete them.
4977 ;; Delete the prompt.
4983 proc 'file-error
4984 "[[Remote prompt `%s' not found in %d secs]]"
4985 tramp-end-of-output timeout)
4987 proc 'file-error
4989 ;; Return value is whether end-of-output sentinel was found.
4990 found)))
4994 "Run COMMAND and check its exit status.
4995 Sends `echo $?' along with the COMMAND for checking the exit status.
4996 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4997 status is 0, and nil otherwise.
4999 If the optional argument SUBSHELL is non-nil, the command is
5000 executed in a subshell, ie surrounded by parentheses. If
5001 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5003 vec
5005 command
5007 "echo tramp_exit_status $?"
5021 "Run COMMAND, check exit status, throw error if exit status not okay.
5022 Similar to `tramp-send-command-and-check' but accepts two more arguments
5023 FMT and ARGS which are passed to `error'."
5028 "Run COMMAND and return the output, which must be a Lisp expression.
5029 If MARKER is a regexp, read the output after that string.
5030 In case there is no valid Lisp expression and NOERROR is nil, it
5031 raises an error."
5038 ;; Read the marker.
5044 vec 'file-error
5045 "`%s' does not return the marker `%s': `%s'"
5047 ;; Read the expression.
5050 ;; Error handling.
5055 vec 'file-error
5056 "`%s' does not return a valid Lisp expression: `%s'"
5060 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5061 Convert file mode bits to string and set virtual device number.
5062 Return ATTR."
5064 ;; Remove color escape sequences from symlink.
5068 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5069 ;; indication of unusable value.
5080 ;; Convert last access time.
5085 ;; Convert last modification time.
5090 ;; Convert last status change time.
5095 ;; Convert file size.
5101 ;; Convert file mode bits to string.
5106 ;; Convert directory indication bit.
5109 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5115 ;; Set file's gid change bit.
5123 ;; Convert inode.
5129 ;; Inodes can be incredible huge. We must hide this.
5131 ;; Set virtual device number.
5134 attr))
5137 "Converts STRING to shell glob pattern which ignores case."
5143 string
5147 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5158 localname)
5164 "Return t if this is an out-of-band method, nil otherwise."
5166 ;; It shall be an out-of-band method.
5168 ;; There must be a size, otherwise the file doesn't exist.
5170 ;; Either the file size is large enough, or (in rare cases) there
5171 ;; does not exist a remote encoding.
5176 ;; Variables local to connection.
5179 "Compile list of remote directories for $PATH.
5180 Nonexistent directories are removed from spec."
5182 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5183 ;; cache the result for the session only. Otherwise, the result
5184 ;; is cached persistently.
5187 vec)
5188 "remote-path"
5197 ;; Default if "getconf" is not available.
5200 vec 3
5205 ;; The login shell could return more than just the $PATH
5206 ;; string. So we use `tramp-end-of-heredoc' as marker.
5210 vec
5215 'identity
5219 'identity
5227 nil)))))
5229 ;; Replace place holder `tramp-default-remote-path'.
5237 ;; Replace place holder `tramp-own-remote-path'.
5245 ;; Remove double entries.
5252 ;; Remove non-existing directories.
5254 nil
5264 x))
5265 x))
5266 remote-path)))))
5269 "Determine remote locale, supporting UTF8 if possible."
5273 locale)
5280 candidates nil)
5282 ;; Return value.
5286 "Determine remote `ls' command."
5293 result)
5295 ;; Check parameters. On busybox, "ls" output coloring is
5296 ;; enabled by default sometimes. So we try to disable it
5297 ;; when possible. $LS_COLORING is not supported there.
5298 ;; Some "ls" versions are sensible wrt the order of
5299 ;; arguments, they fail when "-al" is after the
5300 ;; "--color=never" argument (for example on FreeBSD).
5312 "Check, whether the remote `ls' command supports the --dired option."
5316 ;; Some "ls" versions are sensible wrt the order of arguments,
5317 ;; they fail when "-al" is after the "--dired" argument (for
5318 ;; example on FreeBSD).
5323 "Check, whether the remote `ls' command supports the --quoting-style option."
5332 "Check, whether the remote `ls' command supports the -w option."
5336 ;; Option "-w" is available on BSD systems. No argument is
5337 ;; given, because this could return wrong results in case "ls"
5338 ;; supports the "-w NUM" argument, as for busyboxes.
5343 "Determine remote `test' command."
5347 "test"
5351 "Check, whether the remote `test' command supports the -nt option."
5352 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5353 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5354 ;; for otherwise the shell crashes.
5366 vec
5373 "Determine remote command for file existing check."
5379 "Determine remote `ln' command."
5385 "Determine remote `perl' command."
5391 ;; Perform a basic check.
5396 ;; We must check also for some Perl modules.
5404 result)))
5407 "Determine remote `stat' command."
5412 tmp)
5413 ;; Check whether stat(1) returns usable syntax. "%s" does not
5414 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5415 ;; use shell quoted format for "%N", we check the boundaries "`"
5416 ;; and "'", therefore. See Bug#23422 in coreutils.
5425 result)))
5428 "Determine remote `readlink' command."
5436 result))))
5439 "Determine remote `trash' command."
5445 "Determine remote `touch' command."
5454 ;; Busyboxes do support the "-t" option only when they have been
5455 ;; built with the DESKTOP config option. Let's check it.
5458 vec "touch-t"
5460 vec
5462 "%s -t %s %s"
5463 result
5467 result)))
5470 "Determine remote `gvfs-monitor-dir' command."
5477 "Determine remote `inotifywait' command."
5483 "Determine remote `id' command."
5489 result)
5491 ;; Check POSIX parameter.
5497 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5499 vec
5507 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5509 vec
5513 "print $>"
5517 "Determine remote `python' command."
5525 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5527 vec
5531 "import os; print (os.getuid())"
5535 "The uid of the remote connection VEC, in ID-FORMAT.
5536 ID-FORMAT valid values are `string' and `integer'."
5547 ;; Ensure there is a valid result.
5550 tramp-unknown-id-integer)
5552 tramp-unknown-id-string)
5556 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5558 vec
5566 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5568 vec
5576 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5578 vec
5582 "import os; print (os.getgid())"
5586 "The gid of the remote connection VEC, in ID-FORMAT.
5587 ID-FORMAT valid values are `string' and `integer'."
5598 ;; Ensure there is a valid result.
5601 tramp-unknown-id-integer)
5603 tramp-unknown-id-string)
5607 "Check, whether the remote `env' command supports the -u option."
5610 ;; Option "-u" is a GNU extension.
5614 ;; Some predefined connection properties.
5616 "Return the compress command related to PROP.
5617 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5618 the length of the file to be compressed.
5620 If no corresponding command is found, nil is returned."
5629 "Return the coding command related to PROP.
5630 PROP is either `remote-encoding', `remote-decoding',
5631 `local-encoding' or `local-decoding'.
5633 SIZE is the length of the file to be coded. Depending on SIZE,
5634 compression might be applied.
5636 If no corresponding command is found, nil is returned.
5637 Otherwise, either a string is returned which contains a `%s' mark
5638 to be used for the respective input or output file; or a Lisp
5639 function cell is returned to be applied on a buffer."
5640 ;; We must catch the errors, because we want to return nil, when
5641 ;; no inline coding is found.
5651 compress)
5652 ;; The connection property might have been cached. So we must
5653 ;; send the script to the remote side - maybe.
5661 ;; Check for the `compress' command.
5663 ;; Return the value.
5684 coding)
5687 ;; Windows shells need the program file name after
5688 ;; the pipe symbol be quoted if they use forward
5689 ;; slashes as directory separators.
5696 coding compress))
5699 ;; Windows shells need the program file name after
5700 ;; the pipe symbol be quoted if they use forward
5701 ;; slashes as directory separators.
5706 compress coding))
5720 ;;; TODO:
5722 ;; * Don't use globbing for directories with many files, as this is
5723 ;; likely to produce long command lines, and some shells choke on
5724 ;; long command lines.
5725 ;;
5726 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5727 ;; then look if it's the right version (with `perl -v').
5728 ;;
5729 ;; * When editing a remote CVS controlled file as a different user, VC
5730 ;; gets confused about the file locking status. Try to find out why
5731 ;; the workaround doesn't work.
5732 ;;
5733 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5734 ;; until the last but one hop via `start-file-process'. Apply it
5735 ;; also for ftp and smb.
5736 ;;
5737 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5738 ;; some shell with root privileges, it would be nice if I could
5739 ;; just call
5740 ;; trampclient filename.c
5741 ;; as an editor, and the _current_ shell would connect to an Emacs
5742 ;; server and would be used in an existing non-privileged Emacs
5743 ;; session for doing the editing in question.
5744 ;; That way, I need not tell Emacs my password again and be afraid
5745 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5746 ;; once display a just typed password in the context of a keyboard
5747 ;; sequence prompt for a question immediately following in a shell
5748 ;; script run within Emacs -- nasty).
5749 ;; And if I have some ssh session running to a different computer,
5750 ;; having the possibility of passing a local file there to a local
5751 ;; Emacs session (in case I can arrange for a connection back) would
5752 ;; be nice.
5753 ;; Likely the corresponding Tramp server should not allow the
5754 ;; equivalent of the emacsclient -eval option in order to make this
5755 ;; reasonably unproblematic. And maybe trampclient should have some
5756 ;; way of passing credentials, like by using an SSL socket or
5757 ;; something. (David Kastrup)
5758 ;;
5759 ;; * Reconnect directly to a compliant shell without first going
5760 ;; through the user's default shell. (Pete Forman)
5761 ;;
5762 ;; * How can I interrupt the remote process with a signal
5763 ;; (interrupt-process seems not to work)? (Markus Triska)
5764 ;;
5765 ;; * Avoid the local shell entirely for starting remote processes. If
5766 ;; so, I think even a signal, when delivered directly to the local
5767 ;; SSH instance, would correctly be propagated to the remote process
5768 ;; automatically; possibly SSH would have to be started with
5769 ;; "-t". (Markus Triska)
5770 ;;
5771 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5772 ;; isn't on the remote host. (Mark A. Hershberger)
5773 ;;
5774 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5775 ;;
5776 ;; * Optimize out-of-band copying when both methods are scp-like (not
5777 ;; rsync).
5778 ;;
5779 ;; * Keep a second connection open for out-of-band methods like scp or
5780 ;; rsync.
5781 ;;
5782 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5783 ;;
5784 ;; * I think you could get the best of both worlds by using an
5785 ;; approach similar to Tramp but running a little tramp-daemon on
5786 ;; the other end, such that we can use a more efficient
5787 ;; communication protocol (e.g. when saving a file we could locally
5788 ;; diff it against the last version (of which the remote daemon
5789 ;; would also keep a copy), and then only send the diff).
5790 ;;
5791 ;; This said, even using such a daemon it might be difficult to get
5792 ;; good performance: part of the problem is the number of
5793 ;; round-trips. E.g. when saving a file we have to check if the
5794 ;; file was modified in the mean time and whether saving into a new
5795 ;; inode would change the owner (etc...), which each require a
5796 ;; round-trip. To get rid of these round-trips, we'd have to
5797 ;; shortcut this code and delegate the higher-level "save file"
5798 ;; operation to the remote server, which then has to perform those
5799 ;; tasks but still obeying the locally set customizations about how
5800 ;; to do each one of those tasks.
5801 ;;
5802 ;; We could either put higher-level ops in there (like
5803 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5804 ;; behavior, which is a lot of work and likely to be not 100%
5805 ;; faithful.
5806 ;;
5807 ;; Or we could introduce new low-level ops that are asynchronous,
5808 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5809 ;; start with a bunch of calls like `start-getting-file-attributes'
5810 ;; which could immediately be passed on to the remote side, and
5811 ;; later on checks the return value of those calls as and when
5812 ;; needed. (Stefan Monnier)
5814 ;;; tramp-sh.el ends here