| blob | 4b89c173471b9f7cf23a2411ed2f415997687085 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections -*- lexical-binding:t -*-
3 ;; Copyright (C) 1998-2017 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 ;; Maintainer: Michael Albinus <michael.albinus@gmx.de>
10 ;; Keywords: comm, processes
11 ;; Package: tramp
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;;; Code:
32 ;; Pacify byte-compiler.
44 ;;;###tramp-autoload
46 "The minimum size of compressing where inline transfer.
47 When inline transfer, compress transferred data of file
48 whose size is this value or above (up to `tramp-copy-size-limit').
49 If it is nil, no compression at all will be applied."
54 ;;;###tramp-autoload
56 "The maximum file size where inline copying is preferred over an \
57 out-of-the-band copy.
58 If it is nil, out-of-the-band copy will be used without a check."
63 ;;;###tramp-autoload
65 "Value of TERM environment variable for logging in to remote host.
66 Because Tramp wants to parse the output of the remote shell, it is easily
67 confused by ANSI color escape sequences and suchlike. Often, shell init
68 files conditionalize this setup based on the TERM environment variable."
73 ;;;###tramp-autoload
75 "When invoking a shell, override the HISTFILE with this value.
76 When setting to a string, it redirects the shell history to that
80 The value t unsets any setting of HISTFILE, and sets both
81 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
82 however, the *override* is disabled, so the history will go to
91 ;;;###tramp-autoload
95 ;;;###tramp-autoload
99 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
100 ;; root users. It uses the `$' character for other users. In order
101 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
105 "///%s#$"
107 "String used to recognize end of output.
108 The `$' character at the end is quoted; the string cannot be
111 ;;;###tramp-autoload
118 ;;;###tramp-autoload
120 "Whether to use `tramp-ssh-controlmaster-options'."
127 "Which ssh Control* arguments to use.
129 If it is a string, it should have the form
132 spec must be doubled, because the string is used as format string.
134 Otherwise, it will be auto-detected by Tramp, if
135 `tramp-use-ssh-controlmaster-options' is non-nil. The value
136 depends on the installed local ssh version.
140 ;; Initialize `tramp-methods' with the supported methods.
141 ;;;###tramp-autoload
153 ;;;###tramp-autoload
164 ;;;###tramp-autoload
178 ;;;###tramp-autoload
193 ;;;###tramp-autoload
209 ;;;###tramp-autoload
217 ;;;###tramp-autoload
225 ;;;###tramp-autoload
235 ;;;###tramp-autoload
245 ;;;###tramp-autoload
253 ;;;###tramp-autoload
262 ;; We use "-v" for better error tracking.
265 ;; We use "-p" as required for newer busyboxes. For older
266 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
267 ;; can be achieved by tweaking `tramp-connection-properties'.
269 ;;;###tramp-autoload
278 ;;;###tramp-autoload
280 'tramp-methods
287 ;;;###tramp-autoload
291 ;; The password template must be masked. Otherwise, it could be
292 ;; interpreted as password prompt if the remote host echoes the command.
295 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
301 ;;;###tramp-autoload
309 ;;;###tramp-autoload
318 ;;;###tramp-autoload
326 ;;;###tramp-autoload
330 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
334 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
335 tramp-terminal-type
336 tramp-initial-end-of-output))
341 ;;;###tramp-autoload
347 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
348 tramp-terminal-type
349 tramp-initial-end-of-output))
354 ;;;###tramp-autoload
361 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
362 tramp-terminal-type
363 tramp-initial-end-of-output))
373 ;;;###tramp-autoload
380 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
381 tramp-terminal-type
382 tramp-initial-end-of-output))
391 ;;;###tramp-autoload
403 ;;;###tramp-autoload
407 ;;;###tramp-autoload
411 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
412 ;; Do not add "plink" based methods, they ask interactively for the user.
413 ;;;###tramp-autoload
422 ;;;###tramp-autoload
428 ;;;###tramp-autoload
444 ;;;###tramp-autoload
449 ;;;###tramp-autoload
454 ;;;###tramp-autoload
459 ;;;###tramp-autoload
467 ;;;###tramp-autoload
496 ;; "getconf PATH" yields:
497 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
498 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
499 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
500 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
501 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
502 ;; IRIX64: /usr/bin
503 ;; QNAP QTS: ---
504 ;;;###tramp-autoload
510 "List of directories to search for executables on remote host.
511 For every remote host, this variable will be set buffer local,
512 keeping the list of existing directories on that host.
514 You can use `~' in this list, but when searching for a shell which groks
515 tilde expansion, all directory names starting with `~' will be ignored.
517 `Default Directories' represent the list of directories given by
519 entry on head of this list, because these are the default
520 directories for POSIX compatible commands. On remote hosts which
521 do not offer the getconf command (like cygwin), the value
523 the list by the special value `tramp-default-remote-path'.
525 `Private Directories' are the settings of the $PATH environment,
526 as given in your `~/.profile'. This entry is represented in
527 the list by the special value `tramp-own-remote-path'."
535 ;;;###tramp-autoload
542 "List of environment variables to be set on the remote host.
544 Each element should be a string of the form ENVVARNAME=VALUE. An
545 entry ENVVARNAME= disables the corresponding environment variable,
546 which might have been set in the init files like ~/.profile.
548 Special handling is applied to the PATH environment, which should
549 not be set here. Instead, it should be set via `tramp-remote-path'."
555 ;;;###tramp-autoload
557 "Alist specifying extra arguments to pass to the remote shell.
558 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
559 matching the shell file name and ARGS is a string specifying the
560 arguments.
562 This variable is only used when Tramp needs to start up another shell
563 for tilde expansion. The extra arguments should typically prevent the
564 shell from reading its init file."
566 ;; This might be the wrong way to test whether the widget type
567 ;; `alist' is available. Who knows the right way to test it?
583 "List of pattern/action pairs.
584 Whenever a pattern matches, the corresponding action is performed.
585 Each item looks like (PATTERN ACTION).
587 The PATTERN should be a symbol, a variable. The value of this
588 variable gives the regular expression to search for. Note that the
590 appended to it.
592 The ACTION should also be a symbol, but a function. When the
600 "List of pattern/action pairs.
601 This list is used for copying/renaming with out-of-band methods.
606 "(echo begin 600 %t; tail -n +2) | uudecode
607 cat %t
608 rm -f %t"
609 "Shell function to implement `uudecode' to standard output.
610 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
611 for this or `uudecode -p', but some systems don't, and for them
615 "%s -e '
616 use File::Spec;
619 sub myrealpath {
620 my ($file) = @_;
621 return realpath($file) if -e $file;
622 }
624 sub recursive {
625 my ($volume, @dirs) = @_;
626 my $real = myrealpath(File::Spec->catpath(
628 if ($real) {
629 my ($vol, $dir) = File::Spec->splitpath($real, 1);
630 return ($vol, File::Spec->splitdir($dir));
631 }
632 else {
633 my $last = pop(@dirs);
634 ($volume, @dirs) = recursive($volume, @dirs);
635 push(@dirs, $last);
636 return ($volume, @dirs);
637 }
638 }
640 $result = myrealpath($ARGV[0]);
641 if (!$result) {
642 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
643 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
646 }
651 "Perl script to produce output suitable for use with `file-truename'
652 on the remote file system.
653 Escape sequence %s is replaced with name of Perl binary.
657 "%s -e '
659 @files = readdir(d); closedir(d);
660 foreach $f (@files) {
663 }
664 else {
666 }
667 }
670 "Perl script to produce output suitable for use with
671 `file-name-all-completions' on the remote file system. Escape
672 sequence %s is replaced with name of Perl binary. This string is
675 ;; Perl script to implement `file-attributes' in a Lisp `read'able
676 ;; output. If you are hacking on this, note that you get *no* output
677 ;; unless this spits out a complete line, including the '\n' at the
678 ;; end.
679 ;; The device number is returned as "-1", because there will be a virtual
680 ;; device number set in `tramp-sh-handle-file-attributes'.
682 "%s -e '
683 @stat = lstat($ARGV[0]);
684 if (!@stat) {
686 exit 0;
687 }
688 if (($stat[2] & 0170000) == 0120000)
689 {
690 $type = readlink($ARGV[0]);
693 }
694 elsif (($stat[2] & 0170000) == 040000)
695 {
697 }
698 else
699 {
701 };
704 printf(
706 $type,
707 $stat[3],
708 $uid,
709 $gid,
710 $stat[8] >> 16 & 0xffff,
711 $stat[8] & 0xffff,
712 $stat[9] >> 16 & 0xffff,
713 $stat[9] & 0xffff,
714 $stat[10] >> 16 & 0xffff,
715 $stat[10] & 0xffff,
716 $stat[7],
717 $stat[2],
718 $stat[1] >> 16 & 0xffff,
719 $stat[1] & 0xffff
721 "Perl script to produce output suitable for use with `file-attributes'
722 on the remote file system.
723 Escape sequence %s is replaced with name of Perl binary.
727 "%s -e '
730 @list = readdir(DIR);
731 closedir(DIR);
732 $n = scalar(@list);
734 for($i = 0; $i < $n; $i++)
735 {
736 $filename = $list[$i];
737 @stat = lstat($filename);
738 if (($stat[2] & 0170000) == 0120000)
739 {
740 $type = readlink($filename);
743 }
744 elsif (($stat[2] & 0170000) == 040000)
745 {
747 }
748 else
749 {
751 };
755 printf(
756 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
757 $filename,
758 $type,
759 $stat[3],
760 $uid,
761 $gid,
762 $stat[8] >> 16 & 0xffff,
763 $stat[8] & 0xffff,
764 $stat[9] >> 16 & 0xffff,
765 $stat[9] & 0xffff,
766 $stat[10] >> 16 & 0xffff,
767 $stat[10] & 0xffff,
768 $stat[7],
769 $stat[2],
770 $stat[1] >> 16 & 0xffff,
771 $stat[1] & 0xffff,
772 $stat[0] >> 16 & 0xffff,
773 $stat[0] & 0xffff);
774 }
776 "Perl script implementing `directory-files-attributes' as Lisp `read'able
777 output.
778 Escape sequence %s is replaced with name of Perl binary.
781 ;; These two use base64 encoding.
783 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
784 "Perl program to use for encoding a file.
785 Escape sequence %s is replaced with name of Perl binary.
786 This string is passed to `format', so percent characters need to be doubled.
787 This implementation requires the MIME::Base64 Perl module to be installed
791 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
792 "Perl program to use for decoding a file.
793 Escape sequence %s is replaced with name of Perl binary.
794 This string is passed to `format', so percent characters need to be doubled.
795 This implementation requires the MIME::Base64 Perl module to be installed
799 "%s -e '
800 # This script contributed by Juanma Barranquero <lektu@terra.es>.
801 # Copyright (C) 2002-2017 Free Software Foundation, Inc.
802 use strict;
804 my %%trans = do {
805 my $i = 0;
806 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
807 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
808 };
809 my $data;
811 # We read in chunks of 54 bytes, to generate output lines
812 # of 72 chars (plus end of line)
813 while (read STDIN, $data, 54) {
814 my $pad = q();
816 # Only for the last chunk, and only if did not fill the last three-byte packet
817 if (eof) {
818 my $mod = length($data) %% 3;
819 $pad = q(=) x (3 - $mod) if $mod;
820 }
822 # Not the fastest method, but it is simple: unpack to binary string, split
823 # by groups of 6 bits and convert back from binary to byte; then map into
824 # the translation table
825 print
826 join q(),
827 map($trans{$_},
828 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
829 $pad,
831 }' 2>/dev/null"
832 "Perl program to use for encoding a file.
833 Escape sequence %s is replaced with name of Perl binary.
837 "%s -e '
838 # This script contributed by Juanma Barranquero <lektu@terra.es>.
839 # Copyright (C) 2002-2017 Free Software Foundation, Inc.
840 use strict;
842 my %%trans = do {
843 my $i = 0;
844 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
845 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
846 };
848 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
852 # We are going to accumulate into $pending to accept any line length
853 # (we do not check they are <= 76 chars as the RFC says)
854 my $pending = q();
856 while (my $data = <STDIN>) {
857 chomp $data;
859 # If we find one or two =, we have reached the end and
860 # any following data is to be discarded
861 my $finished = $data =~ s/(==?).*/$1/;
862 $pending .= $data;
864 my $len = length($pending);
865 my $chunk = substr($pending, 0, $len & ~3);
866 $pending = substr($pending, $len & ~3 + 1);
868 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
869 # split in 8-bit chunks and convert back to char.
870 print join q(),
871 map $bytes{$_},
872 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
874 last if $finished;
875 }' 2>/dev/null"
876 "Perl program to use for decoding a file.
877 Escape sequence %s is replaced with name of Perl binary.
881 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
882 "Perl program to use for encoding a file.
886 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
887 "Perl program to use for decoding a file.
892 BEGIN {
895 }
896 {
897 for (c=1; c<=length($0); c++) {
898 d=index(b16, substr($0,c,1))
899 if (d--) {
900 for (b=1; b<=4; b++) {
901 o=o*2+int(d/8); d=(d*2)%%16
902 if (++obc==6) {
903 printf substr(b64,o+1,1)
905 obc=0; o=0
906 }
907 }
908 }
909 }
910 }
911 END {
912 if (obc) {
914 while (obc++<6) { o=o*2 }
916 } else {
918 }
919 printf tail
920 }'"
921 "Awk program to use for encoding a file.
926 BEGIN {
928 }
929 {
930 for (i=1; i<=length($0); i++) {
931 c=index(b64, substr($0,i,1))
932 if(c--) {
933 for(b=0; b<6; b++) {
934 o=o*2+int(c/32); c=(c*2)%%64
935 if(++obc==8) {
936 if (o) {
938 } else {
940 }
941 obc=0; o=0
942 }
943 }
944 }
945 }
946 }'"
947 "Awk program to use for decoding a file.
951 "test -c /dev/zero && \
952 od -v -t x1 -A n </dev/null && \
953 busybox awk '{}' </dev/null"
964 while read file; do
967 else
969 fi
972 else
974 fi
975 done
977 "Script to check existence of VC related files.
978 It must be send formatted with two strings; the tests for file
979 existence, and file readability. Input shall be read via
980 here-document, otherwise the command could exceed maximum length
983 ;; New handlers should be added here.
984 ;;;###tramp-autoload
988 ;; `byte-compiler-base-file-name' performed by default handler.
993 ;; `diff-latest-backup-file' performed by default handler.
997 . tramp-sh-handle-directory-files-and-attributes)
1017 ;; `file-name-sans-versions' performed by default handler.
1031 ;; `find-file-noselect' performed by default handler.
1032 ;; `get-file-buffer' performed by default handler.
1055 "Alist of handler functions.
1058 ;;; File Name Handler Functions:
1062 "Like `make-symbolic-link' for Tramp files.
1063 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1064 the symlink. If LINKNAME is a Tramp file, only the localname component is
1065 used as the target of the symlink.
1067 If LINKNAME is a Tramp file and the localname component is relative, then
1068 it is expanded first, before the localname component is taken. Note that
1069 this can give surprising results if the user/host for the source and
1070 target of the symlink differ."
1077 l 'file-error
1080 ;; Do the 'confirm if exists' thing.
1082 ;; What to do?
1087 "File %s already exists; make it a link anyway? "
1088 l-localname)))))
1093 ;; If FILENAME is a Tramp name, use just the localname component.
1102 ;; Right, they are on the same host, regardless of user, method,
1103 ;; etc. We now make the link on the remote machine. This will
1104 ;; occur as the user that FILENAME belongs to.
1109 "%s -sf %s %s"
1110 ln
1112 ;; The command could exceed PATH_MAX, so we use
1113 ;; relative file names. However, relative file names
1114 ;; could start with "-". `tramp-shell-quote-argument'
1115 ;; does not handle this, we must do it ourselves.
1120 "Like `file-truename' for Tramp files."
1122 "%s%s"
1125 method user domain host port
1132 ;; Use GNU readlink --canonicalize-missing where available.
1135 v
1143 ;; Use Perl implementation.
1151 v
1155 ;; Do it yourself.
1159 ;; Don't make the following value larger than
1160 ;; necessary. People expect an error message in a
1161 ;; timely fashion when something is wrong;
1162 ;; otherwise they might think that Emacs is hung.
1163 ;; Of course, correctness has to come first.
1165 symlink-target)
1177 method user domain host port
1189 ;; It's a symlink, follow it.
1195 ;; If the symlink was absolute, we'll get a
1196 ;; string like "/user@host:/some/target";
1197 ;; extract the "/some/target" part from it.
1201 v 'file-error
1202 "Symlink target `%s' on wrong host"
1203 symlink-target))
1209 ;; It's a file.
1213 v 'file-error
1216 ;; Combine list to form string.
1226 result))))
1228 ;; Preserve trailing "/".
1231 ;; Basic functions.
1234 "Like `file-exists-p' for Tramp files."
1242 v
1244 "%s %s"
1249 "Like `file-attributes' for Tramp files."
1252 ;; Don't modify `last-coding-system-used' by accident.
1259 v
1267 ;; The scripts could fail, for example with huge file size.
1271 "Implement `file-attributes' for Tramp files using the ls(1) command."
1273 res-inode res-filemodes res-numlinks
1274 res-uid res-gid res-size res-symlink-target)
1276 ;; We cannot send all three commands combined, it could exceed
1277 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1279 vec
1284 vec
1289 vec
1293 ;; On systems which have no quoting style, file names
1294 ;; with special characters could fail.
1302 ;; Parse `ls -l' output ...
1306 ;; ... inode
1310 ;; This error happens in Emacs 23. Starting with
1311 ;; Emacs 24, a large integer will be converted into
1312 ;; a float automatically during `read'.
1314 ;; ... file mode flags
1316 ;; ... number links
1318 ;; ... uid and gid
1330 ;; ... size
1332 ;; From the file modes, figure out other stuff.
1335 ;; If symlink, find out file name pointed to.
1342 ;; Return data gathered.
1344 ;; 0. t for directory, string (name linked to) for symbolic
1345 ;; link, or nil.
1347 ;; 1. Number of links to file.
1348 res-numlinks
1349 ;; 2. File uid.
1350 res-uid
1351 ;; 3. File gid.
1352 res-gid
1353 ;; 4. Last access time, as a list of integers. Normally
1354 ;; this would be in the same format as `current-time', but
1355 ;; the subseconds part is not currently implemented, and
1356 ;; (0 0) denotes an unknown time.
1357 ;; 5. Last modification time, likewise.
1358 ;; 6. Last status change time, likewise.
1360 ;; 7. Size in bytes (-1, if number is out of range).
1361 res-size
1362 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1363 res-filemodes
1364 ;; 9. t if file's gid would change if file were deleted and
1365 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1366 t
1367 ;; 10. Inode number.
1368 res-inode
1369 ;; 11. Device number. Will be replaced by a virtual device number.
1374 "Implement `file-attributes' for Tramp files using a Perl script."
1379 vec
1385 "Implement `file-attributes' for Tramp files using stat(1) command."
1388 vec
1391 ;; On Opsware, pdksh (which is the true name of ksh there)
1392 ;; doesn't parse correctly the sequence "((". Therefore, we add
1393 ;; a space. Apostrophes in the stat output are masked as
1394 ;; `tramp-stat-marker', in order to make a proper shell escape of
1395 ;; them in file names.
1396 "( (%s %s || %s -h %s) && (%s -c "
1397 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1404 tramp-stat-marker tramp-stat-marker
1409 tramp-stat-marker tramp-stat-marker
1411 tramp-stat-quoted-marker)))
1414 "Like `set-visited-file-modtime' for Tramp files."
1421 coding-system-used)
1425 ;; '(-1 65535) means file doesn't exists yet.
1429 ;; We use '(0 0) as a don't-know value. See also
1430 ;; `tramp-do-file-attributes-with-ls'.
1435 v
1443 nil)))))
1445 ;; This function makes the same assumption as
1446 ;; `tramp-sh-handle-set-visited-file-modtime'.
1448 "Like `verify-visited-file-modtime' for Tramp files.
1449 At the time `verify-visited-file-modtime' calls this function, we
1450 already know that the buffer is visiting a file and that
1451 `visited-file-modtime' does not return 0. Do not call this
1452 function directly, unless those two cases are already taken care
1453 of."
1456 ;; There is no file visiting the buffer, or the buffer has no
1457 ;; recorded last modification time, or there is no established
1458 ;; connection.
1462 t
1470 ;; File exists, and has a known modtime.
1473 modtime
1474 ;; For compatibility, deal with both the old
1475 ;; (HIGH . LOW) and the new (HIGH LOW) return
1476 ;; values of `visited-file-modtime'.
1479 mt)))
1481 ;; Modtime has the don't know value.
1484 v
1491 attr
1494 ;; If file does not exist, say it is not modified if and
1495 ;; only if that agrees with the buffer's record.
1499 "Like `set-file-modes' for Tramp files."
1503 ;; FIXME: extract the proper text from chmod's stderr.
1505 v
1510 "Like `set-file-times' for Tramp files."
1517 time)))
1520 "env TZ=UTC %s %s %s"
1528 "Set the ownership for FILENAME.
1529 If UID and GID are provided, these values are used; otherwise uid
1530 and gid of the corresponding user is taken. Both parameters must
1531 be non-negative integers."
1532 ;; Modern Unices allow chown only for root. So we might need
1533 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1534 ;; working with su(do)? when it is needed, so it shall succeed in
1535 ;; the majority of cases.
1536 ;; Don't modify `last-coding-system-used' by accident.
1541 ;; If we are root on the local host, we can do it directly.
1549 "chown %d:%d %s" uid gid
1552 ;; We handle also the local part, because there doesn't exist
1553 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1554 ;; timeout for this.
1559 nil "chown" nil nil nil
1563 "Check, whether SELINUX is enabled on the remote host."
1568 "Like `file-selinux-context' for Tramp files."
1577 "%s -d -Z %s"
1585 ;; Return the context.
1586 context))))
1589 "Like `set-file-selinux-context' for Tramp files."
1609 t)))))
1612 "Check, whether ACL is enabled on the remote host."
1617 "Like `file-acl' for Tramp files."
1623 "getfacl -ac %s"
1632 "Like `set-file-acl' for Tramp files."
1639 tramp-end-of-heredoc
1640 acl-string
1641 tramp-end-of-heredoc))
1643 ;; Success.
1646 t)
1647 ;; In case of errors, we return nil.
1649 nil)))
1651 ;; Simple functions using the `test' command.
1654 "Like `file-executable-p' for Tramp files."
1657 ;; Examine `file-attributes' cache to see if request can be
1658 ;; satisfied without remote operation.
1663 "Like `file-readable-p' for Tramp files."
1666 ;; Examine `file-attributes' cache to see if request can be
1667 ;; satisfied without remote operation.
1671 ;; When the remote shell is started, it looks for a shell which groks
1672 ;; tilde expansion. Here, we assume that all shells which grok tilde
1673 ;; expansion will also provide a `test' command which groks `-nt' (for
1674 ;; newer than). If this breaks, tell me about it and I'll try to do
1675 ;; something smarter about it.
1677 "Like `file-newer-than-file-p' for Tramp files."
1679 nil)
1681 t)
1682 ;; We are sure both files exist at this point.
1685 ;; We try to get the mtime of both files. If they are not
1686 ;; equal to the "dont-know" value, then we subtract the times
1687 ;; and obtain the result.
1700 ;; If one of them is the dont-know value, then we can
1701 ;; still try to run a shell command on the remote host.
1702 ;; However, this only works if both files are Tramp
1703 ;; files and both have the same method, same user, same
1704 ;; host.
1709 v 'file-error
1710 "Files %s and %s must have same method, user, host"
1711 file1 file2)))
1716 ;; Functions implemented using the basic functions above.
1719 "Like `file-directory-p' for Tramp files."
1721 ;; `file-directory-p' is used as predicate for file name completion.
1722 ;; Sometimes, when a connection is not established yet, it is
1723 ;; desirable to return t immediately for "/method:foo:". It can
1724 ;; be expected that this is always a directory.
1730 "Like `file-writable-p' for Tramp files."
1734 ;; Examine `file-attributes' cache to see if request can be
1735 ;; satisfied without remote operation.
1738 ;; If file doesn't exist, check if directory is writable.
1743 "Like `file-ownership-preserved-p' for Tramp files."
1747 ;; Return t if the file doesn't exist, since it's true that no
1748 ;; information would be lost by an (attempted) delete and create.
1757 ;; Directory listings.
1761 "Like `directory-files-and-attributes' for Tramp files."
1769 v localname
1780 v localname id-format))
1783 v localname id-format))
1785 result item)
1795 result
1797 ;; The scripts could fail, for example with huge file size.
1799 directory full match nosort id-format)))))
1803 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1806 vec tramp-perl-directory-files-and-attributes
1810 vec
1814 object))
1818 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1821 vec
1824 ;; We must care about file names with spaces, or starting with
1825 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1826 ;; but it does not work on all remote systems. Apostrophes in
1827 ;; the stat output are masked as `tramp-stat-marker', in order to
1828 ;; make a proper shell escape of them in file names.
1830 "xargs %s -c "
1831 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1835 ;; On systems which have no quoting style, file names with special
1836 ;; characters could fail.
1844 tramp-stat-marker tramp-stat-marker
1845 tramp-stat-marker tramp-stat-marker
1850 tramp-stat-marker tramp-stat-marker
1851 tramp-stat-quoted-marker)))
1853 ;; This function should return "foo/" for directories and "bar" for
1854 ;; files.
1856 "Like `file-name-all-completions' for Tramp files."
1859 filename
1863 ;; Get a list of directories and files, including reliably
1864 ;; tagging the directories with a trailing "/". Because I
1865 ;; rock. --daniel@danann.net
1867 v
1871 v tramp-perl-file-name-all-completions
1877 "(cd %s 2>&1 && %s -a 2>/dev/null"
1878 " | while IFS= read f; do"
1886 ;; Now grab the output.
1890 ;; Check result code, found in last line of output.
1894 ;; Grab error message from line before last line
1895 ;; (it was put there by `cd 2>&1').
1898 v 'file-error
1899 "tramp-sh-handle-file-name-all-completions: %s"
1901 ;; For peace of mind, if buffer doesn't end in `fail'
1902 ;; then it should end in `ok'. If neither are in the
1903 ;; buffer something went seriously wrong on the remote
1904 ;; side.
1908 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1913 result))))))
1915 ;; cp, mv and ln
1919 "Like `add-name-to-file' for Tramp files."
1924 v 'file-error
1925 "add-name-to-file: %s"
1934 "File %s already exists; make it a new name anyway? "
1935 newname)))
1937 v2 'file-already-exists
1943 v1
1947 "error with add-name-to-file, see buffer `%s' for details"
1952 preserve-uid-gid preserve-extended-attributes)
1953 "Like `copy-file' for Tramp files."
1957 ;; At least one file a Tramp file?
1961 'copy filename newname ok-if-already-exists keep-date
1962 preserve-uid-gid preserve-extended-attributes))
1963 ;; Compat section. PRESERVE-EXTENDED-ATTRIBUTES has been
1964 ;; introduced with Emacs 24.1 (as PRESERVE-SELINUX-CONTEXT), and
1965 ;; renamed in Emacs 24.3.
1968 'copy-file
1970 preserve-uid-gid preserve-extended-attributes)))
1973 'copy-file
1978 "Like `copy-directory' for Tramp files."
1984 ;; When DIRNAME and NEWNAME are remote, they must have
1985 ;; the same method.
1991 ;; scp or rsync DTRT.
2005 ;; We must do it file-wise.
2007 'copy-directory
2012 ;; When newname did exist, we have wrong cached values.
2020 "Like `rename-file' for Tramp files."
2021 ;; Check if both files are local -- invoke normal rename-file.
2022 ;; Otherwise, use Tramp from local system.
2025 ;; At least one file a Tramp file?
2029 'rename filename newname ok-if-already-exists
2036 preserve-uid-gid preserve-extended-attributes)
2037 "Copy or rename a remote file.
2038 OP must be `copy' or `rename' and indicates the operation to perform.
2039 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2040 the new file (for copy) or the new name of the file (for rename).
2041 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2042 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2043 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2044 the uid and gid if both files are on the same host.
2045 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2047 This function is invoked by `tramp-sh-handle-copy-file' and
2048 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2049 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2050 file names."
2068 filename newname)
2071 ;; Both are Tramp files.
2076 ;; Shortcut: if method, host, user are the same for
2077 ;; both files, we invoke `cp' or `mv' on the remote
2078 ;; host directly.
2081 op filename newname
2082 ok-if-already-exists keep-date preserve-uid-gid))
2084 ;; Try out-of-band operation.
2089 op filename newname keep-date))
2091 ;; No shortcut was possible. So we copy the file
2092 ;; first. If the operation was `rename', we go back
2093 ;; and delete the original file (if the copy was
2094 ;; successful). The approach is simple-minded: we
2095 ;; create a new buffer, insert the contents of the
2096 ;; source file into it, then write out the buffer to
2097 ;; the target file. The advantage is that it doesn't
2098 ;; matter which file name handlers are used for the
2099 ;; source and target file.
2102 op filename newname keep-date))))))
2104 ;; One file is a Tramp file, the other one is local.
2107 ;; Fast track on local machine.
2110 op filename newname
2111 ok-if-already-exists keep-date preserve-uid-gid))
2113 ;; If the Tramp file has an out-of-band method, the
2114 ;; corresponding copy-program can be invoked.
2117 op filename newname keep-date))
2119 ;; Use the inline method via a Tramp buffer.
2121 op filename newname keep-date))))
2124 ;; One of them must be a Tramp file.
2127 ;; Handle `preserve-extended-attributes'. We ignore possible
2128 ;; errors, because ACL strings could be incompatible.
2133 ;; In case of `rename', we must flush the cache of the source file.
2139 ;; When newname did exist, we have wrong cached values.
2146 "Use an Emacs buffer to copy or rename a file.
2147 First arg OP is either `copy' or `rename' and indicates the operation.
2148 FILENAME is the source file, NEWNAME the target file.
2149 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2150 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2151 ;; and `find-file-noselect', but that's not called here.
2155 ;; We must disable multibyte, because binary data shall not be
2156 ;; converted. We don't want the target file to be compressed, so we
2157 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2158 ;; be called either. We remove `tramp-file-name-handler' from
2159 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2160 ;; `insert-file-contents' might be deactivated in some corner cases.
2171 ;; KEEP-DATE handling.
2174 newname
2177 ;; Set the mode.
2179 ;; If the operation was `rename', delete the original file.
2184 "Invokes `cp' or `mv' on the remote system.
2185 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2186 respectively. FILENAME specifies the file to copy or rename,
2187 NEWNAME is the name of the new file (for copy) or the new name of
2188 the file (for rename). Both files must reside on the same host.
2189 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2190 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2191 the uid and gid from FILENAME."
2202 v 'file-error
2203 "Unknown operation `%s', must be `copy' or `rename'"
2204 op))))
2208 cmd-result)
2211 ;; Both files are on a remote host, with same user.
2223 ;; Mask cp -f error.
2225 tramp-operation-not-permitted-regexp nil t))
2226 cmd-result)
2228 nil v 'file-error
2229 "Copying directly failed, see buffer `%s' for details."
2232 ;; We are on the local host.
2235 ;; We can do it directly.
2238 ;; No sticky bit when renaming.
2249 localname1 localname2 ok-if-already-exists
2250 keep-date preserve-uid-gid)
2254 ;; We can do it directly with `tramp-send-command'
2262 ok-if-already-exists keep-date t)
2263 ;; We must change the ownership to the local user.
2269 ;; We need a temporary file in between.
2271 ;; Create the temporary file.
2279 "%s %s %s" cmd
2282 "Copying directly failed, see buffer `%s' for details."
2284 ;; We must change the ownership as remote user.
2285 ;; Since this does not work reliable, we also
2286 ;; give read permissions.
2296 localname1 tmpfile t keep-date preserve-uid-gid)
2299 ;; We must change the ownership as local user.
2300 ;; Since this does not work reliable, we also
2301 ;; give read permissions.
2304 tmpfile
2308 ;; Move the temporary file to its destination.
2313 "cp -f -p %s %s"
2316 "Copying directly failed, see buffer `%s' for details."
2320 'rename-file
2323 ;; Save exit.
2326 ;; Set the time and mode. Mask possible errors.
2333 "Invoke `scp' program to copy.
2334 The method used must be an out-of-band method."
2338 copy-program copy-args copy-env copy-keep-date listener spec
2339 options source target remote-copy-program remote-copy-args)
2344 ;; Both are Tramp files. We shall optimize it when the
2345 ;; methods for FILENAME and NEWNAME are the same.
2355 op filename tmpfile keep-date)
2358 ;; Save exit.
2365 ;; Set variables for computing the prompt for reading
2366 ;; password.
2373 ;; Check which ones of source and target are Tramp files.
2377 'file-name-as-directory
2386 ;; Check for user. There might be an interactive setting.
2390 ;; Check for listener port.
2397 ;; Compose copy command.
2406 ?h host ?u user ?p port ?r listener ?c options
2412 copy-args
2414 ;; " " has either been a replacement of "%k" (when
2415 ;; keep-date argument is non-nil), or a replacement
2416 ;; for the whole keep-date sublist.
2417 " "
2422 copy-args
2426 copy-env
2428 nil
2435 remote-copy-program
2441 remote-copy-args
2445 ;; Check for local copy program.
2450 ;; Install listener on the remote side. The prompt must be
2451 ;; consumed later on, when the process does not listen anymore.
2458 v 'file-error
2462 'identity
2470 v 'file-error
2471 "Listener process not running on remote host: `%s'"
2472 remote-copy-program))
2480 ;; The default directory must be remote.
2484 ;; Set the transfer process properties.
2494 copy-args
2496 copy-args
2501 ;; Use an asynchronous process. By this, password can
2502 ;; be handled. We don't set a timeout, because the
2503 ;; copying of large files can last longer than 60 secs.
2513 command))))
2519 ;; We must adapt `tramp-local-end-of-line' for
2520 ;; sending the password.
2523 p v nil tramp-actions-copy-out-of-band))))
2525 ;; Reset the transfer process properties.
2528 ;; Clear the remote prompt.
2531 ;; Houston, we have a problem! Likely, the listener is
2532 ;; still running, so let's clear everything (but the
2533 ;; cached password).
2536 ;; Handle KEEP-DATE argument.
2539 newname
2543 ;; Set the mode.
2548 ;; If the operation was `rename', delete the original file.
2555 "Like `make-directory' for Tramp files."
2567 "Like `delete-directory' for Tramp files."
2580 "Like `delete-file' for Tramp files."
2591 ;; Dired.
2594 "Like `dired-compress-file' for Tramp files."
2595 ;; Code stolen mainly from dired-aux.el.
2600 suffix)
2601 ;; See if any suffix rule matches this file name.
2609 nil)
2611 ;; We found an uncompression rule.
2621 ;; We don't recognize the file as compressed, so compress it.
2622 ;; Try gzip.
2636 "Like `insert-directory' for Tramp files."
2643 filename switches wildcard full-directory-p)
2665 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2666 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2669 v
2672 switches
2674 localname
2677 v
2681 "Couldn't `cd %s'"
2685 v
2688 switches
2693 ""
2701 ;; We cannot use `insert-buffer-substring' because the Tramp
2702 ;; buffer changes its contents before insertion due to calling
2703 ;; `expand-file-name' and alike.
2708 ;; Check for "--dired" output.
2715 ;; Now read the numeric positions of file names.
2721 ;; End is followed by \n or by " -> ".
2723 ;; Remove trailing lines.
2729 ;; Some busyboxes are reluctant to discard colors.
2737 ;; Decode the output, it could be multibyte.
2742 ;; The inserted file could be from somewhere else.
2749 "."
2756 ;; Canonicalization of file names.
2759 "Like `expand-file-name' for Tramp files.
2761 the result will be a local, non-Tramp, file name."
2762 ;; If DIR is not given, use `default-directory' or "/".
2764 ;; Unless NAME is absolute, concat DIR and NAME.
2767 ;; If connection is not established yet, run the real handler.
2770 ;; Dissect NAME.
2774 ;; Tilde expansion if necessary. This needs a shell which
2775 ;; groks tilde expansion! The function `tramp-find-shell' is
2776 ;; supposed to find such a shell on the remote host. Please
2777 ;; tell me about it when this doesn't work on your system.
2781 ;; We cannot simply apply "~/", because under sudo "~/" is
2782 ;; expanded to the local user home directory but to the
2783 ;; root home directory. On the other hand, using always
2784 ;; the default user name for tilde expansion is not
2785 ;; appropriate either, because ssh and companions might
2786 ;; use a user name from the config file.
2798 ;; There might be a double slash, for example when "~/"
2799 ;; expands to "/". Remove this.
2802 ;; No tilde characters in file name, do normal
2803 ;; `expand-file-name' (this does "/./" and "/../").
2804 ;; `default-directory' is bound, because on Windows there would
2805 ;; be problems with UNC shares or Cygwin mounts.
2808 method user domain host port
2812 hop)))))
2814 ;;; Remote commands:
2817 "Flush file caches."
2825 ;; We use BUFFER also as connection buffer during setup. Because of
2826 ;; this, its original contents must be saved, and restored once
2827 ;; connection has been setup.
2829 "Like `start-file-process' for Tramp files."
2834 ;; BUFFER can be nil. We use a temporary buffer.
2836 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2837 ;; it might be that the arguments exceed the command line
2838 ;; length. Therefore, we modify the command.
2843 ;; When PROGRAM is nil, we just provide a tty.
2849 args
2853 ;; Use a human-friendly prompt, for example for `shell'.
2854 ;; We discard hops, if existing, that's why we cannot use
2855 ;; `file-remote-p'.
2864 tramp-initial-end-of-output))
2865 ;; We use as environment the difference to toplevel
2866 ;; `process-environment'.
2867 env uenv
2881 "unset %s &&"
2896 ;; We do not want to raise an error when
2897 ;; `start-file-process' has been started several times in
2898 ;; `eshell' and friends.
2902 ;; NAME must be unique as process name.
2906 ;; Set the new process properties.
2912 ;; We catch this event. Otherwise, `start-process' could
2913 ;; be called on the local host.
2916 ;; Activate narrowing in order to save BUFFER
2917 ;; contents. Clear also the modification time;
2918 ;; otherwise we might be interrupted by
2919 ;; `verify-visited-file-modtime'.
2925 ;; We call `tramp-maybe-open-connection', in order
2926 ;; to cleanup the prompt afterwards.
2932 ;; Now do it.
2934 ;; Send the command.
2936 ;; Check, whether a pty is associated.
2940 v 'file-error
2943 ;; Set query flag and process marker for this
2944 ;; process. We ignore errors, because the process
2945 ;; could have finished already.
2949 ;; Return process.
2950 p))))
2952 ;; Save exit.
2963 "Like `process-file' for Tramp files."
2964 ;; The implementation is not complete yet.
2970 ;; Compute command.
2973 ;; We use as environment the difference to toplevel `process-environment'.
2984 "env %s %s"
2989 "unset %s && %s"
2991 ;; Determine input.
2996 ;; INFILE is on the same remote host.
2998 ;; INFILE must be copied to remote host.
3000 tmpinput
3005 ;; Determine output.
3007 ;; Just a buffer.
3010 ;; A buffer name.
3013 ;; (REAL-DESTINATION ERROR-DESTINATION)
3015 ;; output.
3023 ;; stderr.
3028 ;; stderr is on the same remote host.
3031 ;; stderr must be copied to remote host. The temporary
3032 ;; file must be deleted after execution.
3035 method user domain host port stderr))))
3036 ;; stderr to be discarded.
3039 ;; 't
3044 ;; Send the command. It might not return in time, so we protect
3045 ;; it. Call it in a subshell, in order to preserve working
3046 ;; directory.
3053 command)
3054 t t)
3056 ;; We should add the output anyway.
3063 ;; When the user did interrupt, we should do it also. We use
3064 ;; return code -1 as marker.
3068 ;; Handle errors.
3073 ;; Provide error file.
3076 ;; Cleanup. We remove all file cache values for the connection,
3077 ;; because the remote process could have changed them.
3083 ;; Return exit status.
3086 ret))))
3089 "Like `file-local-copy' for Tramp files."
3093 v tramp-file-missing
3104 ;; `copy-file' handles direct copy and out-of-band methods.
3109 ;; Use inline encoding for file transfer.
3113 v 3
3115 filename rem-enc)
3122 tmpfile loc-dec)
3124 ;; If local decoding is a function, we call it.
3125 ;; We must disable multibyte, because
3126 ;; `uudecode-decode-region' doesn't handle it
3127 ;; correctly. Unset `file-name-handler-alist'.
3128 ;; Otherwise, epa-file gets confused.
3136 ;; If tramp-decoding-function is not defined for this
3137 ;; method, we invoke tramp-decoding-command instead.
3139 ;; Unset `file-name-handler-alist'. Otherwise,
3140 ;; epa-file gets confused.
3148 loc-dec tmpfile2 tmpfile)
3151 ;; Set proper permissions.
3153 ;; Set local user ownership.
3156 ;; Oops, I don't know what to do.
3160 ;; Error handling.
3166 tmpfile)))
3168 ;; CCC grok LOCKNAME
3171 "Like `write-region' for Tramp files."
3174 ;; Following part commented out because we don't know what to do about
3175 ;; file locking, and it does not appear to be a problem to ignore it.
3176 ;; Ange-ftp ignores it, too.
3177 ;; (when (and lockname (stringp lockname))
3178 ;; (setq lockname (expand-file-name lockname)))
3179 ;; (unless (or (eq lockname nil)
3180 ;; (string= lockname filename))
3181 ;; (error
3182 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3196 ;; `file-writable-p' calls `file-expand-file-name'. We
3197 ;; cannot use `tramp-run-real-handler' therefore.
3203 ;; Short track: if we are on the local host, we can run directly.
3205 'write-region
3209 ;; We use this to save the value of
3210 ;; `last-coding-system-used' after writing the tmp
3211 ;; file. At the end of the function, we set
3212 ;; `last-coding-system-used' to this saved value. This
3213 ;; way, any intermediary coding systems used while
3214 ;; talking to the remote shell or suchlike won't hose
3215 ;; this variable. This approach was snarfed from
3216 ;; ange-ftp.el.
3217 coding-system-used
3218 ;; Write region into a tmp file. This isn't really
3219 ;; needed if we use an encoding function, but currently
3220 ;; we use it always because this makes the logic
3221 ;; simpler. We must also set `temporary-file-directory',
3222 ;; because it could point to a remote directory.
3228 ;; If `append' is non-nil, we copy the file locally, and let
3229 ;; the native `write-region' implementation do the job.
3232 ;; We say `no-message' here because we don't want the
3233 ;; visited file modtime data to be clobbered from the temp
3234 ;; file. We call `set-visited-file-modtime' ourselves later
3235 ;; on. We must ensure that `file-coding-system-alist'
3236 ;; matches `tmpfile'.
3242 'write-region
3249 ;; Now, `last-coding-system-used' has the right value. Remember it.
3252 ;; The permissions of the temporary file should be set. If
3253 ;; FILENAME does not exist (eq modes nil) it has been
3254 ;; renamed to the backup file. This case `save-buffer'
3255 ;; handles permissions.
3256 ;; Ensure that it is still readable.
3259 tmpfile
3262 ;; This is a bit lengthy due to the different methods
3263 ;; possible for file transfer. First, we check whether the
3264 ;; method uses an scp program. If so, we call it.
3265 ;; Otherwise, both encoding and decoding command must be
3266 ;; specified. However, if the method _also_ specifies an
3267 ;; encoding function, then that is used for encoding the
3268 ;; contents of the tmp file.
3274 ;; `copy-file' handles direct copy and out-of-band methods.
3284 ;; We keep the local file for performance
3285 ;; reasons, useful for "rsync".
3292 ;; Don't rename, in order to keep context in SELinux.
3297 ;; Use inline file transfer.
3299 ;; Encode tmpfile.
3303 ;; Use encoding function or command.
3306 "Encoding local file `%s' using `%s'"
3307 tmpfile loc-enc)
3309 ;; The following `let' is a workaround for
3310 ;; the base64.el that comes with pgnus-0.84.
3311 ;; If both of the following conditions are
3312 ;; satisfied, it tries to write to a local
3313 ;; file in default-directory, but at this
3314 ;; point, default-directory is remote.
3315 ;; (`call-process-region' can't write to
3316 ;; remote files, it seems.) The file in
3317 ;; question is a tmp file anyway.
3325 loc-enc tmpfile t))
3327 v 'file-error
3330 filename loc-enc))))
3332 ;; Send buffer into remote decoding command which
3333 ;; writes to remote file. Because this happens on
3334 ;; the remote host, we cannot use the function.
3337 "Decoding remote file `%s' using `%s'"
3338 filename rem-dec)
3342 v
3346 tramp-end-of-heredoc
3348 tramp-end-of-heredoc))
3350 v nil
3351 "Couldn't write region to `%s', decode using `%s' failed"
3352 filename rem-dec)
3353 ;; When `file-precious-flag' is set, the region is
3354 ;; written to a temporary file. Check that the
3355 ;; checksum is equal to that from the local tmpfile.
3359 ;; cksum runs locally, if possible.
3361 ;; cksum runs remotely.
3363 v
3366 ;; ... they are different.
3373 v 'file-error
3376 filename rem-dec)))))
3378 ;; Save exit.
3381 ;; That's not expected.
3384 v 'file-error
3387 method))))
3389 ;; Make `last-coding-system-used' have the right value.
3396 ;; We must protect `last-coding-system-used', now we have set it
3397 ;; to its correct value.
3399 ;; Set file modification time.
3403 ;; We must pass modtime explicitly, because FILENAME can
3404 ;; be different from (buffer-file-name), f.e. if
3405 ;; `file-precious-flag' is set.
3411 ;; Set the ownership.
3421 ;; VC backends check for the existence of various different special
3422 ;; files. This is very time consuming, because every single check
3423 ;; requires a remote command (the file cache must be invalidated).
3424 ;; Therefore, we apply a kind of optimization. We install the file
3425 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3426 ;; remembers all file names for which `file-exists-p' or
3427 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3428 ;; is performed. Afterwards, a script is applied for all collected
3429 ;; file names, using just one remote command. The result of this
3430 ;; script is used to fill the file cache with actual values. Now we
3431 ;; can reset the file name handlers, and we make a second run of
3432 ;; `vc-registered', which returns the expected result without sending
3433 ;; any other remote command.
3435 "Like `vc-registered' for Tramp files."
3441 ;; There could be new files, created by the vc backend. We
3442 ;; cannot reuse the old cache entries, therefore. In
3443 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3444 ;; could also be a timestamp as `current-time' returns. This
3445 ;; means invalidate all cache entries with an older timestamp.
3451 ;; Here we collect only file names, which need an operation.
3455 ;; Send just one command, in order to fill the cache.
3458 v
3467 ;; We cannot use `tramp-send-command-and-read',
3468 ;; because this does not cooperate well with
3469 ;; heredoc documents.
3471 v
3474 tramp-end-of-heredoc
3476 tramp-vc-registered-file-names
3478 tramp-end-of-heredoc))
3480 ;; Read the expression.
3487 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3488 ;; calls shall be answered from the file cache. We unset
3489 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3490 ;; in order to keep the cache.
3492 remote-file-name-inhibit-cache process-file-side-effects)
3493 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3512 ;; Run.
3516 ;;;###tramp-autoload
3518 "Invoke remote-shell Tramp file name handler.
3519 Fall back to normal file name handler if no Tramp handler exists."
3536 ;; This must be the last entry, because `identity' always matches.
3537 ;;;###tramp-autoload
3542 "Invoke special file name handler, which collects files to be handled."
3550 ;; That's what we want: file names, for which checks are
3551 ;; applied. We assume that VC uses only `file-exists-p' and
3552 ;; `file-readable-p' checks; otherwise we must extend the
3553 ;; list. We do not perform any action, but return nil, in
3554 ;; order to keep `vc-registered' running.
3557 nil)
3558 ;; `process-file' and `start-file-process' shall be ignored.
3561 ;; Tramp file name handlers like `expand-file-name'. They
3562 ;; must still work.
3564 ;; Default file name handlers, we don't care.
3568 "Like `file-notify-add-watch' for Tramp files."
3572 command events filter p sequence)
3574 ;; gvfs-monitor-dir.
3577 events
3581 attribute-changed))
3586 ;; inotifywait.
3589 events
3599 ;; Make events a list of symbols.
3600 events
3604 ;; None.
3606 v 'file-notify-error
3607 "No file notification program found on %s"
3609 ;; Start process.
3611 'start-file-process
3615 sequence))
3616 ;; Return the process object as watch-descriptor.
3619 v 'file-notify-error
3620 "`%s' failed to start on remote host"
3624 ;; Needed for process filter.
3629 ;; There might be an error if the monitor is not supported.
3630 ;; Give the filter a chance to read the output.
3635 p))))
3639 file-notify events."
3649 ;; Attribute change is returned in unused wording.
3661 string)
3666 proc
3671 ;; File names are returned as absolute paths. We must
3672 ;; add the remote prefix.
3676 ;; Remove watch when file or directory to be watched is deleted.
3680 ;; Usually, we would add an Emacs event now. Unfortunately,
3681 ;; `unread-command-events' does not accept several events at
3682 ;; once. Therefore, we apply the handler directly.
3685 'file-notify-handle-event
3688 ;; Save rest of the string.
3698 ;; Check, whether there is a problem.
3704 line)
3709 proc
3716 ;; Remove watch when file or directory to be watched is deleted.
3719 ;; Usually, we would add an Emacs event now. Unfortunately,
3720 ;; `unread-command-events' does not accept several events at
3721 ;; once. Therefore, we apply the handler directly.
3724 'file-notify-handle-event
3727 ;;; Internal Functions:
3730 "Define in remote shell function NAME implemented as SCRIPT.
3731 Only send the definition if it has not already been done."
3732 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3733 ;; might be nil.
3739 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3740 ;; could result in unwanted command expansion. Avoid this.
3743 ;; The script could contain a call of Perl. This is masked with `%s'.
3748 vec
3756 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3757 Returns the exit code of the `test' program."
3760 v
3762 "%s %s %s"
3764 switch
3768 "Run `test'-like program on the remote system, given FILE1, FILE2.
3769 FORMAT-STRING contains the program name, switches, and place holders.
3770 Returns the exit code of the `test' program. Barfs if the methods,
3771 hosts, or files, disagree."
3775 v 'file-error
3780 v1
3787 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3788 First arg VEC specifies the connection, PROGNAME is the program
3789 to search for, and DIRLIST gives the list of directories to
3790 search. If IGNORE-TILDE is non-nil, directory names starting
3791 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3792 only in DIRLIST.
3794 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3796 This function expects to be in the right *tramp* buffer."
3799 ;; Check whether the executable is in $PATH. "which(1)" does not
3800 ;; report always a correct error code; therefore we check the
3801 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3802 ;; 5.11") have problems with this command, we disable the call
3803 ;; therefore.
3814 ;; Remove all ~/foo directories from dirlist.
3823 vec
3825 "do if test -x $d/%s && test -f $d/%s; "
3826 "then echo tramp_executable $d/%s; "
3829 progname progname progname
3830 tramp-end-of-heredoc
3832 tramp-end-of-heredoc))
3838 result)))
3841 "Sets the remote environment PATH to existing directories.
3842 I.e., for each directory in `tramp-remote-path', it is tested
3843 whether it exists and if so, it is added to the environment
3844 variable PATH."
3850 ;; ------------------------------------------------------------
3851 ;; -- Communication with external shell --
3852 ;; ------------------------------------------------------------
3855 "Find a command on the remote host for checking if a file exists.
3856 Here, we are looking for a command which has zero exit status if the
3857 file exists and nonzero exit status otherwise."
3861 result)
3862 ;; The algorithm is as follows: we try a list of several commands.
3863 ;; For each command, we first run `$cmd /' -- this should return
3864 ;; true, as the root directory always exists. And then we run
3865 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3866 ;; does not exist. This should return false. We use the first
3867 ;; command we find that seems to work.
3868 ;; The list of commands to try is as follows:
3869 ;; `ls -d' This works on most systems, but NetBSD 1.4
3870 ;; has a bug: `ls' always returns zero exit
3871 ;; status, even for files which don't exist.
3872 ;; `test -e' Some Bourne shells have a `test' builtin
3873 ;; which does not know the `-e' option.
3874 ;; `/bin/test -e' For those, the `test' binary on disk normally
3875 ;; provides the option. Alas, the binary
3876 ;; is sometimes `/bin/test' and sometimes it's
3877 ;; `/usr/bin/test'.
3878 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3906 result))
3909 "Opens shell SHELL."
3912 ;; Find arguments for this shell.
3914 item extra-args)
3919 ;; It is useful to set the prompt in the following command
3920 ;; because some people have a setting for $PS1 which /bin/sh
3921 ;; doesn't know about and thus /bin/sh will display a strange
3922 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3923 ;; ksh will display the current working directory but /bin/sh
3924 ;; will display a dollar sign. The following command line sets
3925 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3926 ;; well as csh-like shells. We also unset the variable $ENV
3927 ;; because that is read by some sh implementations (eg, bash
3928 ;; when called as sh) on startup; this way, we avoid the startup
3929 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3930 ;; the prompt in /bin/bash, it must be discarded as well.
3931 ;; $HISTFILE is set according to `tramp-histfile-override'.
3934 "exec env ENV=%s %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3940 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3944 t)
3945 ;; Check proper HISTFILE setting. We give up when not working.
3949 vec
3951 "(cd %s)"
3954 "`tramp-histfile-override' uses invalid file `%s'"
3955 tramp-histfile-override)))
3961 "Opens a shell on the remote host which groks tilde expansion."
3964 shell)
3967 ;; CCC: "root" does not exist always, see my QNAP TS-459.
3968 ;; Which check could we apply instead?
3971 ;; The default shell (ksh93) of OpenSolaris and
3972 ;; Solaris is buggy. We've got reports for
3973 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3982 ;; Maybe it works at least for some other commands.
3984 default-shell
3986 vec 2
3988 "Couldn't find a remote shell which groks tilde "
3990 default-shell)))
3992 default-shell)))
3994 ;; Open a new shell if needed.
4000 ;; Utility functions.
4003 "Wait for shell prompt and barf if none appears.
4004 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4005 seconds. If not, it produces an error message with the given ERROR-ARGS."
4009 proc timeout
4018 "Set up an interactive shell.
4019 Mainly sets the prompt and the echo correctly. PROC is the shell
4020 process to set up. VEC specifies the connection."
4025 ;; Disable echo expansion.
4029 ;; Check whether the echo has really been disabled. Some
4030 ;; implementations, like busybox of embedded GNU/Linux, don't
4031 ;; support disabling.
4038 ;; Make sure backspaces and their echo are enabled and no line
4039 ;; width magic interferes with them.
4046 t)
4048 ;; Check whether the output of "uname -sr" has been changed. If
4049 ;; yes, this is a strong indication that we must expire all
4050 ;; connection properties. We start again with
4051 ;; `tramp-maybe-open-connection', it will be caught there.
4056 vec "uname"
4060 vec 3
4061 "Connection reset, because remote host changed from `%s' to `%s'"
4062 old-uname uname)
4063 ;; We want to keep the password.
4067 ;; Try to set up the coding system correctly.
4068 ;; CCC this can't be the right way to do it. Hm.
4071 ;; Use MULE to select the right EOL convention for communicating
4072 ;; with the process.
4078 cs-decode cs-encode)
4082 cs-encode
4089 ;; Special setting for macOS.
4100 ;; Check whether the remote host suffers from buggy
4101 ;; `send-process-string'. This is known for FreeBSD (see comment
4102 ;; in `send_process', file process.c). I've tested sending 624
4103 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4104 ;; hack when this host type is detected locally. It cannot handle
4105 ;; remote hosts, though.
4109 tramp-chunksize)
4115 ;; Set remote PATH variable.
4118 ;; Search for a good shell before searching for a command which
4119 ;; checks if a file exists. This is done because Tramp wants to
4120 ;; use "test foo; echo $?" to check if various conditions hold,
4121 ;; and there are buggy /bin/sh implementations which don't execute
4122 ;; the "echo $?" part if the "test" part has an error. In
4123 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4124 ;; also other problems with /bin/sh of OpenSolaris, like
4125 ;; redirection of stderr in function declarations, or changing
4126 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4127 ;; by bash, when detected.
4130 ;; Disable unexpected output.
4133 ;; IRIX64 bash expands "!" even when in single quotes. This
4134 ;; destroys our shell functions, we must disable it. See
4135 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4139 ;; Disable tab expansion.
4144 ;; Set utf8 encoding. Needed for macOS, for example. This is
4145 ;; non-POSIX, so we must expect errors on some systems.
4148 ;; Set `remote-tty' process property.
4153 ;; Dump stty settings in the traces.
4157 ;; Set the environment.
4171 vec
4174 tramp-end-of-heredoc
4176 tramp-end-of-heredoc)
4177 t))
4182 ;; Old text from documentation of tramp-methods:
4183 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4184 ;; of the base64 methods instead since base64 encoding is much more
4185 ;; reliable and the commands are more standardized between the different
4186 ;; Unix versions. But if you can't use base64 for some reason, please
4187 ;; note that the default uudecode command does not work well for some
4188 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4189 ;; the following command for uudecode:
4190 ;;
4191 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4192 ;;
4193 ;; For Irix, no solution is known yet.
4201 "List of local coding commands for inline transfer.
4202 Each item is a list that looks like this:
4204 \(FORMAT ENCODING DECODING)
4206 FORMAT is symbol describing the encoding/decoding format. It can be
4207 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4209 ENCODING and DECODING can be strings, giving commands, or symbols,
4210 giving functions. If they are strings, then they can contain
4212 file name will be put into the command line at that spot. If the
4213 specifier is not present, the input should be read from standard
4214 input.
4216 If they are functions, they will be called with two arguments, start
4217 and end of region, and are expected to replace the region contents
4222 ;; "-i" is more robust with older base64 from GNU coreutils.
4223 ;; However, I don't know whether all base64 versions do supports
4224 ;; this option.
4232 ;; This is painful slow, so we put it on the end.
4239 "List of remote coding commands for inline transfer.
4240 Each item is a list that looks like this:
4242 \(FORMAT ENCODING DECODING [TEST])
4244 FORMAT is a symbol describing the encoding/decoding format. It can be
4245 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4247 ENCODING and DECODING can be strings, giving commands, or symbols,
4248 giving variables. If they are strings, then they can contain
4250 file name will be put into the command line at that spot. If the
4251 specifier is not present, the input should be read from standard
4252 input.
4254 If they are variables, this variable is a string containing a
4255 Perl or Shell implementation for this functionality. This
4256 program will be transferred to the remote host, and it is
4258 specifier in the variable value denotes a temporary file.
4260 The optional TEST command can be used for further tests, whether
4264 "Find an inline transfer encoding that works.
4265 Goes through the list `tramp-local-coding-commands' and
4266 `tramp-remote-coding-commands'."
4271 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4279 ;; If the local encoder or decoder is a string, the
4280 ;; corresponding command has to work locally.
4287 loc-enc nil nil))
4295 loc-dec nil nil))
4297 ;; Search for remote coding commands with the same format
4305 ;; Check the remote test command if exists.
4311 ;; Check if remote perl exists when necessary.
4316 ;; Check if remote encoding and decoding commands can be
4317 ;; called remotely with null input and output. This makes
4318 ;; sure there are no syntax errors and the command is really
4319 ;; found. Note that we do not redirect stdout to /dev/null,
4320 ;; for two reasons: when checking the decoding command, we
4321 ;; actually check the output it gives. And also, when
4322 ;; redirecting "mimencode" output to /dev/null, then as root
4323 ;; it might change the permissions of /dev/null!
4331 vec 5
4340 tmpfile)
4347 tramp-temp-name-prefix
4349 value
4351 value
4353 ?t
4358 vec 5
4361 vec
4363 t)
4371 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4377 ;; Set connection properties. Since the commands are risky
4378 ;; (due to output direction), we cache them in the process cache.
4389 "Call the local encoding or decoding command.
4391 Otherwise, INPUT is passed via standard input.
4392 INPUT can also be nil which means `/dev/null'.
4393 OUTPUT can be a string (which specifies a file name), or t (which
4394 means standard output and thus the current buffer), or nil (which
4395 means discard it)."
4397 nil tramp-encoding-shell
4400 nil
4401 tramp-encoding-command-switch
4411 "List of compress and decompress commands for inline transfer.
4412 Each item is a list that looks like this:
4414 \(COMPRESS DECOMPRESS)
4419 "Find an inline transfer compress command that works.
4420 Goes through the list `tramp-inline-compress-commands'."
4425 item compress decompress found)
4432 vec 5
4433 "Checking local compress commands `%s', `%s' for sanity"
4434 compress decompress)
4439 ;; Windows shells need the program file name after
4440 ;; the pipe symbol be quoted if they use forward
4441 ;; slashes as directory separators.
4448 vec 5
4449 "Checking remote compress commands `%s', `%s' for sanity"
4450 compress decompress)
4456 ;; Did we find something?
4459 ;; Set connection properties. Since the commands are
4460 ;; risky (due to output direction), we cache them in the
4461 ;; process cache.
4475 "Expands VEC according to `tramp-default-proxies-alist'."
4479 choices proxy)
4481 ;; Ad-hoc proxy definitions.
4491 proxy)
4492 ;; Add the hop.
4494 'tramp-default-proxies-alist
4497 proxy))
4499 ;; Save the new value.
4504 ;; Look for proxy hosts to be passed.
4510 ;; Host.
4513 ;; User.
4517 ;; No more hops needed.
4519 ;; Replace placeholders.
4522 proxy
4527 ;; Add the hop.
4529 ;; Start next search.
4532 ;; Foreign and out-of-band methods are not supported for multi-hops.
4539 vec 'file-error
4540 "Method `%s' is not supported for multi-hops."
4543 ;; In case the host name is not used for the remote shell
4544 ;; command, the user could be misguided by applying a random
4545 ;; host name.
4551 ;; There are multi-hops.
4553 ;; The host name is used for the remote shell command.
4555 ;; The host is local. We cannot use `tramp-local-host-p'
4556 ;; here, because it opens a connection as well.
4559 v 'file-error
4560 "Host `%s' looks like a remote host, `%s' can only use the local host"
4561 host method)))
4563 ;; Result.
4564 target-alist))
4567 "Return the Control* arguments of the local ssh."
4569 ;; No options to be computed.
4574 ;; There is already a value to be used.
4577 ;; Determine the options.
4592 ;; We use a non-existing IP address, in order to
4593 ;; avoid useless connections, and DNS timeouts.
4594 ;; Setting ConnectTimeout is needed since OpenSSH 7.
4596 vec "ssh" nil t nil
4602 " -o ControlPath='tramp.%%r@%%h:%%p'"
4611 tramp-ssh-controlmaster-options)))
4614 "Maybe open a connection VEC.
4615 Does not do anything if a connection is already open, but re-opens the
4616 connection if a previous connection has died for some reason."
4622 ;; If Tramp opens the same connection within a short time frame,
4623 ;; there is a problem. We shall signal this.
4632 ;; If too much time has passed since last command was sent, look
4633 ;; whether process is still alive. If it isn't, kill it. When
4634 ;; using ssh, it can sometimes happen that the remote end has hung
4635 ;; up but the local ssh client doesn't recognize this until it
4636 ;; tries to send some data to the remote end. So that's why we
4637 ;; try to send a command from time to time, then look again
4638 ;; whether the process is really alive.
4649 ;; The error will be caught locally.
4655 ;; New connection must be opened.
4659 ;; During completion, don't reopen a new connection. We
4660 ;; check this for the process related to
4661 ;; `tramp-buffer-name'; otherwise `start-file-process'
4662 ;; wouldn't run ever when `non-essential' is non-nil.
4668 vec 3
4679 ;; Start new process.
4696 ;; We will apply `tramp-ssh-controlmaster-options'
4697 ;; only for the first hop.
4701 ;; There are unfortunate settings for "cmdproxy" on
4702 ;; W32 systems.
4705 ;; This must be done in order to avoid our file
4706 ;; name handler.
4710 'start-process
4715 tramp-encoding-command-interactive)
4718 ;; Set sentinel and query flag.
4729 ;; Check whether process is alive.
4731 p 10
4734 ;; Now do all the connections as specified.
4753 ;; We don't create the temporary file. In
4754 ;; fact, it is just a prefix for the
4755 ;; ControlPath option of ssh; the real
4756 ;; temporary file has another name, and it is
4757 ;; created and protected by ssh. It is also
4758 ;; removed by ssh when the connection is
4759 ;; closed. The temporary file name is cached
4760 ;; in the main connection process, therefore
4761 ;; we cannot use `tramp-get-connection-process'.
4767 tramp-temp-name-prefix
4769 spec r-shell)
4771 ;; Add arguments for asynchronous processes.
4775 ;; Check for port number. Until now, there's no
4776 ;; need for handling like method, user, host.
4781 ;; Check, whether there is a restricted shell.
4786 ;; Set variables for computing the prompt for
4787 ;; reading password.
4789 tramp-current-user l-user
4790 tramp-current-host l-host)
4792 ;; Add login environment.
4795 login-env
4800 login-env))
4804 "%s=%s %s"
4807 command)))
4810 ;; Replace `login-args' place holders.
4818 ?h l-host ?u l-user ?p l-port ?c options)
4819 command
4821 ;; We do not want to see the trailing local
4822 ;; prompt in `start-file-process'.
4824 command " "
4830 ;; Local shell could be a Windows COMSPEC. It
4831 ;; doesn't know the ";" syntax, but we must exit
4832 ;; always for `start-file-process'. It could
4833 ;; also be a restricted shell, which does not
4834 ;; allow "exec".
4837 ;; Send the command.
4841 p vec
4844 tramp-actions-before-shell
4848 ;; Next hop.
4852 ;; Set connection-local variables.
4855 ;; Make initial shell settings.
4858 ;; Mark it as connected.
4861 ;; Cleanup, and propagate the signal.
4867 "Send the COMMAND to connection VEC.
4868 Erases temporary buffer before sending the command. If optional
4869 arg NEVEROPEN is non-nil, never try to open the connection. This
4870 is meant to be used from `tramp-maybe-open-connection' only. The
4871 function waits for output unless NOOUTPUT is set."
4875 ;; We mark the command string that it can be erased in the output buffer.
4877 ;; If we put `tramp-echo-mark' after a trailing newline (which
4878 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4879 ;; that newline and adds `tramp-rsh-end-of-line' right after
4880 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4881 ;; trailing line endings and sends two prompts after executing
4882 ;; the command, which confuses `tramp-wait-for-output'.
4886 ;; No need to restore a trailing newline here since `tramp-send-string'
4887 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4889 ;; Send the command.
4895 "Wait for output from remote command."
4901 ;; be leading escape sequences, which must be ignored.
4902 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4903 ;; option send also escape sequences, which must be
4904 ;; ignored.
4907 tramp-device-escape-sequence-regexp))
4908 ;; Sometimes, the commands do not return a newline but a
4909 ;; null byte before the shell prompt, for example "git
4910 ;; ls-files -c -z ...".
4915 ;; A simple-minded busybox has sent " ^H" sequences.
4916 ;; Delete them.
4921 ;; Delete the prompt.
4927 proc 'file-error
4928 "[[Remote prompt `%s' not found in %d secs]]"
4929 tramp-end-of-output timeout)
4931 proc 'file-error
4933 ;; Return value is whether end-of-output sentinel was found.
4934 found)))
4938 "Run COMMAND and check its exit status.
4939 Sends `echo $?' along with the COMMAND for checking the exit status.
4940 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4941 status is 0, and nil otherwise.
4943 If the optional argument SUBSHELL is non-nil, the command is
4944 executed in a subshell, ie surrounded by parentheses. If
4945 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4947 vec
4949 command
4951 "echo tramp_exit_status $?"
4965 "Run COMMAND, check exit status, throw error if exit status not okay.
4966 Similar to `tramp-send-command-and-check' but accepts two more arguments
4967 FMT and ARGS which are passed to `error'."
4972 "Run COMMAND and return the output, which must be a Lisp expression.
4973 If MARKER is a regexp, read the output after that string.
4974 In case there is no valid Lisp expression and NOERROR is nil, it
4975 raises an error."
4982 ;; Read the marker.
4988 vec 'file-error
4989 "`%s' does not return the marker `%s': `%s'"
4991 ;; Read the expression.
4994 ;; Error handling.
4999 vec 'file-error
5000 "`%s' does not return a valid Lisp expression: `%s'"
5004 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5005 Convert file mode bits to string and set virtual device number.
5006 Return ATTR."
5008 ;; Remove color escape sequences from symlink.
5012 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5013 ;; indication of unusable value.
5024 ;; Convert last access time.
5029 ;; Convert last modification time.
5034 ;; Convert last status change time.
5039 ;; Convert file size.
5045 ;; Convert file mode bits to string.
5050 ;; Convert directory indication bit.
5053 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5059 ;; Set file's gid change bit.
5067 ;; Convert inode.
5072 middle low)
5075 ;; The low 16 bits.
5080 ;; The middle 24 bits.
5084 ;; Inodes can be incredible huge. We must hide this.
5086 ;; Set virtual device number.
5089 attr))
5092 "Converts STRING to shell glob pattern which ignores case."
5098 string
5102 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5114 localname)
5120 "Return t if this is an out-of-band method, nil otherwise."
5122 ;; It shall be an out-of-band method.
5124 ;; There must be a size, otherwise the file doesn't exist.
5126 ;; Either the file size is large enough, or (in rare cases) there
5127 ;; does not exist a remote encoding.
5132 ;; Variables local to connection.
5135 "Compile list of remote directories for $PATH.
5136 Nonexistent directories are removed from spec."
5138 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5139 ;; cache the result for the session only. Otherwise, the result
5140 ;; is cached persistently.
5143 vec)
5144 "remote-path"
5153 ;; Default if "getconf" is not available.
5156 vec 3
5161 ;; The login shell could return more than just the $PATH
5162 ;; string. So we use `tramp-end-of-heredoc' as marker.
5166 vec
5171 'identity
5175 'identity
5183 nil)))))
5185 ;; Replace place holder `tramp-default-remote-path'.
5193 ;; Replace place holder `tramp-own-remote-path'.
5201 ;; Remove double entries.
5208 ;; Remove non-existing directories.
5210 nil
5222 x))
5223 x))
5224 remote-path)))))
5227 "Determine remote locale, supporting UTF8 if possible."
5231 locale)
5238 candidates nil)
5240 ;; Return value.
5244 "Determine remote `ls' command."
5251 result)
5253 ;; Check parameters. On busybox, "ls" output coloring is
5254 ;; enabled by default sometimes. So we try to disable it
5255 ;; when possible. $LS_COLORING is not supported there.
5256 ;; Some "ls" versions are sensible wrt the order of
5257 ;; arguments, they fail when "-al" is after the
5258 ;; "--color=never" argument (for example on FreeBSD).
5270 "Check, whether the remote `ls' command supports the --dired option."
5274 ;; Some "ls" versions are sensible wrt the order of arguments,
5275 ;; they fail when "-al" is after the "--dired" argument (for
5276 ;; example on FreeBSD).
5281 "Check, whether the remote `ls' command supports the --quoting-style option."
5290 "Check, whether the remote `ls' command supports the -w option."
5294 ;; Option "-w" is available on BSD systems. No argument is
5295 ;; given, because this could return wrong results in case "ls"
5296 ;; supports the "-w NUM" argument, as for busyboxes.
5301 "Determine remote `test' command."
5305 "test"
5309 "Check, whether the remote `test' command supports the -nt option."
5310 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5311 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5312 ;; for otherwise the shell crashes.
5324 vec
5331 "Determine remote command for file existing check."
5337 "Determine remote `ln' command."
5343 "Determine remote `perl' command."
5349 ;; Perform a basic check.
5354 ;; We must check also for some Perl modules.
5362 result)))
5365 "Determine remote `stat' command."
5370 tmp)
5371 ;; Check whether stat(1) returns usable syntax. "%s" does not
5372 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5373 ;; use shell quoted format for "%N", we check the boundaries "`"
5374 ;; and "'", therefore. See Bug#23422 in coreutils.
5375 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5376 ;; supported.
5385 result)))
5388 "Determine remote `readlink' command."
5396 result))))
5399 "Determine remote `trash' command.
5400 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5407 "Determine remote `touch' command."
5416 ;; Busyboxes do support the "-t" option only when they have been
5417 ;; built with the DESKTOP config option. Let's check it.
5420 vec "touch-t"
5422 vec
5424 "%s -t %s %s"
5425 result
5429 result)))
5432 "Determine remote `gvfs-monitor-dir' command."
5435 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5436 ;; establish better timeouts in filenotify-tests.el. Any better
5437 ;; distinction approach would be welcome!
5444 "Determine remote `inotifywait' command."
5450 "Determine remote `id' command."
5456 result)
5458 ;; Check POSIX parameter.
5464 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5466 vec
5474 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5476 vec
5480 "print $>"
5484 "Determine remote `python' command."
5492 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5494 vec
5498 "import os; print (os.getuid())"
5502 "The uid of the remote connection VEC, in ID-FORMAT.
5503 ID-FORMAT valid values are `string' and `integer'."
5514 ;; Ensure there is a valid result.
5517 tramp-unknown-id-integer)
5519 tramp-unknown-id-string)
5523 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5525 vec
5533 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5535 vec
5543 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5545 vec
5549 "import os; print (os.getgid())"
5553 "The gid of the remote connection VEC, in ID-FORMAT.
5554 ID-FORMAT valid values are `string' and `integer'."
5565 ;; Ensure there is a valid result.
5568 tramp-unknown-id-integer)
5570 tramp-unknown-id-string)
5574 "Check, whether the remote `env' command supports the -u option."
5577 ;; Option "-u" is a GNU extension.
5581 ;; Some predefined connection properties.
5583 "Return the compress command related to PROP.
5584 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5585 the length of the file to be compressed.
5587 If no corresponding command is found, nil is returned."
5596 "Return the coding command related to PROP.
5597 PROP is either `remote-encoding', `remote-decoding',
5598 `local-encoding' or `local-decoding'.
5600 SIZE is the length of the file to be coded. Depending on SIZE,
5601 compression might be applied.
5603 If no corresponding command is found, nil is returned.
5604 Otherwise, either a string is returned which contains a `%s' mark
5605 to be used for the respective input or output file; or a Lisp
5606 function cell is returned to be applied on a buffer."
5607 ;; We must catch the errors, because we want to return nil, when
5608 ;; no inline coding is found.
5618 compress)
5619 ;; The connection property might have been cached. So we must
5620 ;; send the script to the remote side - maybe.
5628 ;; Check for the `compress' command.
5630 ;; Return the value.
5651 coding)
5654 ;; Windows shells need the program file name after
5655 ;; the pipe symbol be quoted if they use forward
5656 ;; slashes as directory separators.
5663 coding compress))
5666 ;; Windows shells need the program file name after
5667 ;; the pipe symbol be quoted if they use forward
5668 ;; slashes as directory separators.
5673 compress coding))
5687 ;;; TODO:
5689 ;; * Don't use globbing for directories with many files, as this is
5690 ;; likely to produce long command lines, and some shells choke on
5691 ;; long command lines.
5692 ;;
5693 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5694 ;; then look if it's the right version (with `perl -v').
5695 ;;
5696 ;; * When editing a remote CVS controlled file as a different user, VC
5697 ;; gets confused about the file locking status. Try to find out why
5698 ;; the workaround doesn't work.
5699 ;;
5700 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5701 ;; until the last but one hop via `start-file-process'. Apply it
5702 ;; also for ftp and smb.
5703 ;;
5704 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5705 ;; some shell with root privileges, it would be nice if I could
5706 ;; just call
5707 ;; trampclient filename.c
5708 ;; as an editor, and the _current_ shell would connect to an Emacs
5709 ;; server and would be used in an existing non-privileged Emacs
5710 ;; session for doing the editing in question.
5711 ;; That way, I need not tell Emacs my password again and be afraid
5712 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5713 ;; once display a just typed password in the context of a keyboard
5714 ;; sequence prompt for a question immediately following in a shell
5715 ;; script run within Emacs -- nasty).
5716 ;; And if I have some ssh session running to a different computer,
5717 ;; having the possibility of passing a local file there to a local
5718 ;; Emacs session (in case I can arrange for a connection back) would
5719 ;; be nice.
5720 ;; Likely the corresponding Tramp server should not allow the
5721 ;; equivalent of the emacsclient -eval option in order to make this
5722 ;; reasonably unproblematic. And maybe trampclient should have some
5723 ;; way of passing credentials, like by using an SSL socket or
5724 ;; something. (David Kastrup)
5725 ;;
5726 ;; * Reconnect directly to a compliant shell without first going
5727 ;; through the user's default shell. (Pete Forman)
5728 ;;
5729 ;; * How can I interrupt the remote process with a signal
5730 ;; (interrupt-process seems not to work)? (Markus Triska)
5731 ;;
5732 ;; * Avoid the local shell entirely for starting remote processes. If
5733 ;; so, I think even a signal, when delivered directly to the local
5734 ;; SSH instance, would correctly be propagated to the remote process
5735 ;; automatically; possibly SSH would have to be started with
5736 ;; "-t". (Markus Triska)
5737 ;;
5738 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5739 ;; isn't on the remote host. (Mark A. Hershberger)
5740 ;;
5741 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5742 ;;
5743 ;; * Optimize out-of-band copying when both methods are scp-like (not
5744 ;; rsync).
5745 ;;
5746 ;; * Keep a second connection open for out-of-band methods like scp or
5747 ;; rsync.
5748 ;;
5749 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5750 ;;
5751 ;; * I think you could get the best of both worlds by using an
5752 ;; approach similar to Tramp but running a little tramp-daemon on
5753 ;; the other end, such that we can use a more efficient
5754 ;; communication protocol (e.g. when saving a file we could locally
5755 ;; diff it against the last version (of which the remote daemon
5756 ;; would also keep a copy), and then only send the diff).
5757 ;;
5758 ;; This said, even using such a daemon it might be difficult to get
5759 ;; good performance: part of the problem is the number of
5760 ;; round-trips. E.g. when saving a file we have to check if the
5761 ;; file was modified in the mean time and whether saving into a new
5762 ;; inode would change the owner (etc...), which each require a
5763 ;; round-trip. To get rid of these round-trips, we'd have to
5764 ;; shortcut this code and delegate the higher-level "save file"
5765 ;; operation to the remote server, which then has to perform those
5766 ;; tasks but still obeying the locally set customizations about how
5767 ;; to do each one of those tasks.
5768 ;;
5769 ;; We could either put higher-level ops in there (like
5770 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5771 ;; behavior, which is a lot of work and likely to be not 100%
5772 ;; faithful.
5773 ;;
5774 ;; Or we could introduce new low-level ops that are asynchronous,
5775 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5776 ;; start with a bunch of calls like `start-getting-file-attributes'
5777 ;; which could immediately be passed on to the remote side, and
5778 ;; later on checks the return value of those calls as and when
5779 ;; needed. (Stefan Monnier)
5781 ;;; tramp-sh.el ends here