| blob | 4d7359a4c9c22f3f0495f79bb204f35b925840d8 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections -*- lexical-binding:t -*-
3 ;; Copyright (C) 1998-2018 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 <https://www.gnu.org/licenses/>.
28 ;;; Code:
33 ;; 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
540 "List of environment variables to be set on the remote host.
542 Each element should be a string of the form ENVVARNAME=VALUE. An
543 entry ENVVARNAME= disables the corresponding environment variable,
544 which might have been set in the init files like ~/.profile.
546 Special handling is applied to some environment variables,
547 which should not be set here:
549 The PATH environment variable should be set via `tramp-remote-path'.
551 The TERM environment variable should be set via `tramp-terminal-type'.
553 The INSIDE_EMACS environment variable will automatically be set
554 based on the TRAMP and Emacs versions, and should not be set here."
560 ;;;###tramp-autoload
562 "Alist specifying extra arguments to pass to the remote shell.
563 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
564 matching the shell file name and ARGS is a string specifying the
565 arguments.
567 This variable is only used when Tramp needs to start up another shell
568 for tilde expansion. The extra arguments should typically prevent the
569 shell from reading its init file."
584 "List of pattern/action pairs.
585 Whenever a pattern matches, the corresponding action is performed.
586 Each item looks like (PATTERN ACTION).
588 The PATTERN should be a symbol, a variable. The value of this
589 variable gives the regular expression to search for. Note that the
591 appended to it.
593 The ACTION should also be a symbol, but a function. When the
601 "List of pattern/action pairs.
602 This list is used for copying/renaming with out-of-band methods.
607 "(echo begin 600 %t; tail -n +2) | uudecode
608 cat %t
609 rm -f %t"
610 "Shell function to implement `uudecode' to standard output.
611 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
612 for this or `uudecode -p', but some systems don't, and for them
616 "%s -e '
617 use File::Spec;
620 sub myrealpath {
621 my ($file) = @_;
622 return realpath($file) if (-e $file || -l $file);
623 }
625 sub recursive {
626 my ($volume, @dirs) = @_;
627 my $real = myrealpath(File::Spec->catpath(
629 if ($real) {
630 my ($vol, $dir) = File::Spec->splitpath($real, 1);
631 return ($vol, File::Spec->splitdir($dir));
632 }
633 else {
634 my $last = pop(@dirs);
635 ($volume, @dirs) = recursive($volume, @dirs);
636 push(@dirs, $last);
637 return ($volume, @dirs);
638 }
639 }
641 $result = myrealpath($ARGV[0]);
642 if (!$result) {
643 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
644 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
647 }
652 "Perl script to produce output suitable for use with `file-truename'
653 on the remote file system.
654 Escape sequence %s is replaced with name of Perl binary.
658 "%s -e '
660 @files = readdir(d); closedir(d);
661 foreach $f (@files) {
664 }
665 else {
667 }
668 }
671 "Perl script to produce output suitable for use with
672 `file-name-all-completions' on the remote file system. Escape
673 sequence %s is replaced with name of Perl binary. This string is
676 ;; Perl script to implement `file-attributes' in a Lisp `read'able
677 ;; output. If you are hacking on this, note that you get *no* output
678 ;; unless this spits out a complete line, including the '\n' at the
679 ;; end.
680 ;; The device number is returned as "-1", because there will be a virtual
681 ;; device number set in `tramp-sh-handle-file-attributes'.
683 "%s -e '
684 @stat = lstat($ARGV[0]);
685 if (!@stat) {
687 exit 0;
688 }
689 if (($stat[2] & 0170000) == 0120000)
690 {
691 $type = readlink($ARGV[0]);
694 }
695 elsif (($stat[2] & 0170000) == 040000)
696 {
698 }
699 else
700 {
702 };
705 printf(
707 $type,
708 $stat[3],
709 $uid,
710 $gid,
711 $stat[8] >> 16 & 0xffff,
712 $stat[8] & 0xffff,
713 $stat[9] >> 16 & 0xffff,
714 $stat[9] & 0xffff,
715 $stat[10] >> 16 & 0xffff,
716 $stat[10] & 0xffff,
717 $stat[7],
718 $stat[2],
719 $stat[1] >> 16 & 0xffff,
720 $stat[1] & 0xffff
722 "Perl script to produce output suitable for use with `file-attributes'
723 on the remote file system.
724 Escape sequence %s is replaced with name of Perl binary.
728 "%s -e '
731 @list = readdir(DIR);
732 closedir(DIR);
733 $n = scalar(@list);
735 for($i = 0; $i < $n; $i++)
736 {
737 $filename = $list[$i];
738 @stat = lstat($filename);
739 if (($stat[2] & 0170000) == 0120000)
740 {
741 $type = readlink($filename);
744 }
745 elsif (($stat[2] & 0170000) == 040000)
746 {
748 }
749 else
750 {
752 };
756 printf(
757 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
758 $filename,
759 $type,
760 $stat[3],
761 $uid,
762 $gid,
763 $stat[8] >> 16 & 0xffff,
764 $stat[8] & 0xffff,
765 $stat[9] >> 16 & 0xffff,
766 $stat[9] & 0xffff,
767 $stat[10] >> 16 & 0xffff,
768 $stat[10] & 0xffff,
769 $stat[7],
770 $stat[2],
771 $stat[1] >> 16 & 0xffff,
772 $stat[1] & 0xffff,
773 $stat[0] >> 16 & 0xffff,
774 $stat[0] & 0xffff);
775 }
777 "Perl script implementing `directory-files-attributes' as Lisp `read'able
778 output.
779 Escape sequence %s is replaced with name of Perl binary.
782 ;; These two use base64 encoding.
784 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
785 "Perl program to use for encoding a file.
786 Escape sequence %s is replaced with name of Perl binary.
787 This string is passed to `format', so percent characters need to be doubled.
788 This implementation requires the MIME::Base64 Perl module to be installed
792 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
793 "Perl program to use for decoding a file.
794 Escape sequence %s is replaced with name of Perl binary.
795 This string is passed to `format', so percent characters need to be doubled.
796 This implementation requires the MIME::Base64 Perl module to be installed
800 "%s -e '
801 # This script contributed by Juanma Barranquero <lektu@terra.es>.
802 # Copyright (C) 2002-2018 Free Software Foundation, Inc.
803 use strict;
805 my %%trans = do {
806 my $i = 0;
807 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
808 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
809 };
810 my $data;
812 # We read in chunks of 54 bytes, to generate output lines
813 # of 72 chars (plus end of line)
814 while (read STDIN, $data, 54) {
815 my $pad = q();
817 # Only for the last chunk, and only if did not fill the last three-byte packet
818 if (eof) {
819 my $mod = length($data) %% 3;
820 $pad = q(=) x (3 - $mod) if $mod;
821 }
823 # Not the fastest method, but it is simple: unpack to binary string, split
824 # by groups of 6 bits and convert back from binary to byte; then map into
825 # the translation table
826 print
827 join q(),
828 map($trans{$_},
829 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
830 $pad,
832 }' 2>/dev/null"
833 "Perl program to use for encoding a file.
834 Escape sequence %s is replaced with name of Perl binary.
838 "%s -e '
839 # This script contributed by Juanma Barranquero <lektu@terra.es>.
840 # Copyright (C) 2002-2018 Free Software Foundation, Inc.
841 use strict;
843 my %%trans = do {
844 my $i = 0;
845 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
846 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
847 };
849 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
853 # We are going to accumulate into $pending to accept any line length
854 # (we do not check they are <= 76 chars as the RFC says)
855 my $pending = q();
857 while (my $data = <STDIN>) {
858 chomp $data;
860 # If we find one or two =, we have reached the end and
861 # any following data is to be discarded
862 my $finished = $data =~ s/(==?).*/$1/;
863 $pending .= $data;
865 my $len = length($pending);
866 my $chunk = substr($pending, 0, $len & ~3);
867 $pending = substr($pending, $len & ~3 + 1);
869 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
870 # split in 8-bit chunks and convert back to char.
871 print join q(),
872 map $bytes{$_},
873 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
875 last if $finished;
876 }' 2>/dev/null"
877 "Perl program to use for decoding a file.
878 Escape sequence %s is replaced with name of Perl binary.
882 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
883 "Perl program to use for encoding a file.
887 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
888 "Perl program to use for decoding a file.
893 BEGIN {
896 }
897 {
898 for (c=1; c<=length($0); c++) {
899 d=index(b16, substr($0,c,1))
900 if (d--) {
901 for (b=1; b<=4; b++) {
902 o=o*2+int(d/8); d=(d*2)%%16
903 if (++obc==6) {
904 printf substr(b64,o+1,1)
906 obc=0; o=0
907 }
908 }
909 }
910 }
911 }
912 END {
913 if (obc) {
915 while (obc++<6) { o=o*2 }
917 } else {
919 }
920 printf tail
921 }'"
922 "Awk program to use for encoding a file.
927 BEGIN {
929 }
930 {
931 for (i=1; i<=length($0); i++) {
932 c=index(b64, substr($0,i,1))
933 if(c--) {
934 for(b=0; b<6; b++) {
935 o=o*2+int(c/32); c=(c*2)%%64
936 if(++obc==8) {
937 if (o) {
939 } else {
941 }
942 obc=0; o=0
943 }
944 }
945 }
946 }
947 }'"
948 "Awk program to use for decoding a file.
952 "test -c /dev/zero && \
953 od -v -t x1 -A n </dev/null && \
954 busybox awk '{}' </dev/null"
965 while read file; do
969 else
971 fi
974 else
976 fi
977 done
979 "Script to check existence of VC related files.
980 It must be send formatted with two strings; the tests for file
981 existence, and file readability. Input shall be read via
982 here-document, otherwise the command could exceed maximum length
985 ;; New handlers should be added here.
986 ;;;###tramp-autoload
990 ;; `byte-compiler-base-file-name' performed by default handler.
995 ;; `diff-latest-backup-file' performed by default handler.
999 . tramp-sh-handle-directory-files-and-attributes)
1019 ;; `file-name-sans-versions' performed by default handler.
1034 ;; `find-file-noselect' performed by default handler.
1035 ;; `get-file-buffer' performed by default handler.
1041 ;; `make-directory-internal' performed by default handler.
1059 "Alist of handler functions.
1062 ;;; File Name Handler Functions:
1066 "Like `make-symbolic-link' for Tramp files.
1067 If TARGET is a non-Tramp file, it is used verbatim as the target
1068 of the symlink. If TARGET is a Tramp file, only the localname
1069 component is used as the target of the symlink."
1075 ;; If TARGET is a Tramp name, use just the localname component.
1082 ;; If TARGET is still remote, quote it.
1086 linkname ok-if-already-exists)
1093 v 'file-error
1096 ;; Do the 'confirm if exists' thing.
1098 ;; What to do?
1104 "File %s already exists; make it a link anyway? "
1105 localname)))))
1112 ;; Right, they are on the same host, regardless of user,
1113 ;; method, etc. We now make the link on the remote
1114 ;; machine. This will occur as the user that TARGET belongs to.
1119 "%s -sf %s %s" ln
1121 ;; The command could exceed PATH_MAX, so we use
1122 ;; relative file names. However, relative file
1123 ;; names could start with "-".
1124 ;; `tramp-shell-quote-argument' does not handle
1125 ;; this, we must do it ourselves.
1130 "Like `file-truename' for Tramp files."
1132 "%s%s"
1135 method user domain host port
1142 ;; Use GNU readlink --canonicalize-missing where available.
1145 v
1153 ;; Use Perl implementation.
1161 v
1165 ;; Do it yourself.
1169 ;; Don't make the following value larger than
1170 ;; necessary. People expect an error message in a
1171 ;; timely fashion when something is wrong;
1172 ;; otherwise they might think that Emacs is hung.
1173 ;; Of course, correctness has to come first.
1175 symlink-target)
1187 method user domain host port
1199 ;; It's a symlink, follow it.
1209 ;; It's a file.
1213 v 'file-error
1216 ;; Combine list to form string.
1224 ;; Detect cycle.
1228 v 'file-error
1230 ;; If the resulting localname looks remote, we must quote it
1231 ;; for security reasons.
1236 result))))
1238 ;; Preserve trailing "/".
1241 ;; Basic functions.
1244 "Like `file-exists-p' for Tramp files."
1252 v
1254 "%s %s"
1259 "Like `file-attributes' for Tramp files."
1262 ;; Don't modify `last-coding-system-used' by accident.
1269 v
1277 ;; The scripts could fail, for example with huge file size.
1281 "Implement `file-attributes' for Tramp files using the ls(1) command."
1283 res-inode res-filemodes res-numlinks
1284 res-uid res-gid res-size res-symlink-target)
1286 ;; We cannot send all three commands combined, it could exceed
1287 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1289 vec
1294 vec
1299 vec
1303 ;; On systems which have no quoting style, file names
1304 ;; with special characters could fail.
1312 ;; Parse `ls -l' output ...
1316 ;; ... inode
1318 ;; ... file mode flags
1320 ;; ... number links
1322 ;; ... uid and gid
1334 ;; ... size
1336 ;; From the file modes, figure out other stuff.
1339 ;; If symlink, find out file name pointed to.
1346 ;; Return data gathered.
1348 ;; 0. t for directory, string (name linked to) for symbolic
1349 ;; link, or nil.
1351 ;; 1. Number of links to file.
1352 res-numlinks
1353 ;; 2. File uid.
1354 res-uid
1355 ;; 3. File gid.
1356 res-gid
1357 ;; 4. Last access time, as a list of integers. Normally
1358 ;; this would be in the same format as `current-time', but
1359 ;; the subseconds part is not currently implemented, and
1360 ;; (0 0) denotes an unknown time.
1361 ;; 5. Last modification time, likewise.
1362 ;; 6. Last status change time, likewise.
1364 ;; 7. Size in bytes (-1, if number is out of range).
1365 res-size
1366 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1367 res-filemodes
1368 ;; 9. t if file's gid would change if file were deleted and
1369 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1370 t
1371 ;; 10. Inode number.
1372 res-inode
1373 ;; 11. Device number. Will be replaced by a virtual device number.
1378 "Implement `file-attributes' for Tramp files using a Perl script."
1383 vec
1389 "Implement `file-attributes' for Tramp files using stat(1) command."
1392 vec
1395 ;; On Opsware, pdksh (which is the true name of ksh there)
1396 ;; doesn't parse correctly the sequence "((". Therefore, we add
1397 ;; a space. Apostrophes in the stat output are masked as
1398 ;; `tramp-stat-marker', in order to make a proper shell escape of
1399 ;; them in file names.
1400 "( (%s %s || %s -h %s) && (%s -c "
1401 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1408 tramp-stat-marker tramp-stat-marker
1413 tramp-stat-marker tramp-stat-marker
1415 tramp-stat-quoted-marker)))
1418 "Like `set-visited-file-modtime' for Tramp files."
1425 coding-system-used)
1429 ;; '(-1 65535) means file doesn't exists yet.
1433 ;; We use '(0 0) as a don't-know value. See also
1434 ;; `tramp-do-file-attributes-with-ls'.
1439 v
1447 nil)))))
1449 ;; This function makes the same assumption as
1450 ;; `tramp-sh-handle-set-visited-file-modtime'.
1452 "Like `verify-visited-file-modtime' for Tramp files.
1453 At the time `verify-visited-file-modtime' calls this function, we
1454 already know that the buffer is visiting a file and that
1455 `visited-file-modtime' does not return 0. Do not call this
1456 function directly, unless those two cases are already taken care
1457 of."
1460 ;; There is no file visiting the buffer, or the buffer has no
1461 ;; recorded last modification time, or there is no established
1462 ;; connection.
1466 t
1474 ;; File exists, and has a known modtime.
1477 modtime
1478 ;; For compatibility, deal with both the old
1479 ;; (HIGH . LOW) and the new (HIGH LOW) return
1480 ;; values of `visited-file-modtime'.
1483 mt)))
1485 ;; Modtime has the don't know value.
1488 v
1495 attr
1498 ;; If file does not exist, say it is not modified if and
1499 ;; only if that agrees with the buffer's record.
1503 "Like `set-file-modes' for Tramp files."
1507 ;; FIXME: extract the proper text from chmod's stderr.
1509 v
1514 "Like `set-file-times' for Tramp files."
1521 time)))
1524 "env TZ=UTC %s %s %s"
1532 "Set the ownership for FILENAME.
1533 If UID and GID are provided, these values are used; otherwise uid
1534 and gid of the corresponding user is taken. Both parameters must
1535 be non-negative integers."
1536 ;; Modern Unices allow chown only for root. So we might need
1537 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1538 ;; working with su(do)? when it is needed, so it shall succeed in
1539 ;; the majority of cases.
1540 ;; Don't modify `last-coding-system-used' by accident.
1545 ;; If we are root on the local host, we can do it directly.
1553 "chown %d:%d %s" uid gid
1556 ;; We handle also the local part, because there doesn't exist
1557 ;; `set-file-uid-gid'. On W32 "chown" does not work.
1562 nil "chown" nil nil nil
1566 "Check, whether SELINUX is enabled on the remote host."
1571 "Like `file-selinux-context' for Tramp files."
1580 "%s -d -Z %s"
1588 ;; Return the context.
1589 context))))
1592 "Like `set-file-selinux-context' for Tramp files."
1611 t)))))
1614 "Check, whether ACL is enabled on the remote host."
1619 "Like `file-acl' for Tramp files."
1625 "getfacl -ac %s"
1634 "Like `set-file-acl' for Tramp files."
1641 tramp-end-of-heredoc
1642 acl-string
1643 tramp-end-of-heredoc))
1645 ;; Success.
1648 t)
1649 ;; In case of errors, we return nil.
1651 nil)))
1653 ;; Simple functions using the `test' command.
1656 "Like `file-executable-p' for Tramp files."
1659 ;; Examine `file-attributes' cache to see if request can be
1660 ;; satisfied without remote operation.
1665 "Like `file-readable-p' for Tramp files."
1668 ;; Examine `file-attributes' cache to see if request can be
1669 ;; satisfied without remote operation.
1673 ;; When the remote shell is started, it looks for a shell which groks
1674 ;; tilde expansion. Here, we assume that all shells which grok tilde
1675 ;; expansion will also provide a `test' command which groks `-nt' (for
1676 ;; newer than). If this breaks, tell me about it and I'll try to do
1677 ;; something smarter about it.
1679 "Like `file-newer-than-file-p' for Tramp files."
1681 nil)
1683 t)
1684 ;; We are sure both files exist at this point.
1687 ;; We try to get the mtime of both files. If they are not
1688 ;; equal to the "dont-know" value, then we subtract the times
1689 ;; and obtain the result.
1702 ;; If one of them is the dont-know value, then we can
1703 ;; still try to run a shell command on the remote host.
1704 ;; However, this only works if both files are Tramp
1705 ;; files and both have the same method, same user, same
1706 ;; host.
1711 v 'file-error
1712 "Files %s and %s must have same method, user, host"
1713 file1 file2)))
1718 ;; Functions implemented using the basic functions above.
1721 "Like `file-directory-p' for Tramp files."
1723 ;; `file-directory-p' is used as predicate for file name completion.
1724 ;; Sometimes, when a connection is not established yet, it is
1725 ;; desirable to return t immediately for "/method:foo:". It can
1726 ;; be expected that this is always a directory.
1732 "Like `file-writable-p' for Tramp files."
1736 ;; Examine `file-attributes' cache to see if request can be
1737 ;; satisfied without remote operation.
1740 ;; If file doesn't exist, check if directory is writable.
1745 "Like `file-ownership-preserved-p' for Tramp files."
1749 ;; Return t if the file doesn't exist, since it's true that no
1750 ;; information would be lost by an (attempted) delete and create.
1759 ;; Directory listings.
1763 "Like `directory-files-and-attributes' for Tramp files."
1771 v localname
1782 v localname id-format))
1785 v localname id-format))
1787 result item)
1797 result
1799 ;; The scripts could fail, for example with huge file size.
1801 directory full match nosort id-format)))))
1805 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1808 vec tramp-perl-directory-files-and-attributes
1812 vec
1816 object))
1820 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1823 vec
1826 ;; We must care about file names with spaces, or starting with
1827 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1828 ;; but it does not work on all remote systems. Apostrophes in
1829 ;; the stat output are masked as `tramp-stat-marker', in order to
1830 ;; make a proper shell escape of them in file names.
1832 "xargs %s -c "
1833 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1837 ;; On systems which have no quoting style, file names with special
1838 ;; characters could fail.
1846 tramp-stat-marker tramp-stat-marker
1847 tramp-stat-marker tramp-stat-marker
1852 tramp-stat-marker tramp-stat-marker
1853 tramp-stat-quoted-marker)))
1855 ;; This function should return "foo/" for directories and "bar" for
1856 ;; files.
1858 "Like `file-name-all-completions' for Tramp files."
1861 filename
1865 ;; Get a list of directories and files, including reliably
1866 ;; tagging the directories with a trailing "/". Because I
1867 ;; rock. --daniel@danann.net
1869 v
1873 v tramp-perl-file-name-all-completions
1879 "(cd %s 2>&1 && %s -a 2>/dev/null"
1880 " | while IFS= read f; do"
1888 ;; Now grab the output.
1892 ;; Check result code, found in last line of output.
1896 ;; Grab error message from line before last line
1897 ;; (it was put there by `cd 2>&1').
1900 v 'file-error
1901 "tramp-sh-handle-file-name-all-completions: %s"
1903 ;; For peace of mind, if buffer doesn't end in `fail'
1904 ;; then it should end in `ok'. If neither are in the
1905 ;; buffer something went seriously wrong on the remote
1906 ;; side.
1910 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1915 result))))))
1917 ;; cp, mv and ln
1921 "Like `add-name-to-file' for Tramp files."
1926 v 'file-error
1927 "add-name-to-file: %s"
1933 ;; Do the 'confirm if exists' thing.
1935 ;; What to do?
1940 "File %s already exists; make it a link anyway? "
1941 v2-localname)))))
1947 v1
1951 "error with add-name-to-file, see buffer `%s' for details"
1956 preserve-uid-gid preserve-extended-attributes)
1957 "Like `copy-file' for Tramp files."
1963 'copy filename newname ok-if-already-exists keep-date
1964 preserve-uid-gid preserve-extended-attributes)
1966 'copy-file
1968 preserve-uid-gid preserve-extended-attributes))))
1972 "Like `copy-directory' for Tramp files."
1978 ;; When DIRNAME and NEWNAME are remote, they must have
1979 ;; the same method.
1985 ;; scp or rsync DTRT.
2003 ;; We must do it file-wise.
2005 'copy-directory
2008 ;; When newname did exist, we have wrong cached values.
2016 "Like `rename-file' for Tramp files."
2017 ;; Check if both files are local -- invoke normal rename-file.
2018 ;; Otherwise, use Tramp from local system.
2021 ;; At least one file a Tramp file?
2025 'rename filename newname ok-if-already-exists
2032 preserve-uid-gid preserve-extended-attributes)
2033 "Copy or rename a remote file.
2034 OP must be `copy' or `rename' and indicates the operation to perform.
2035 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2036 the new file (for copy) or the new name of the file (for rename).
2037 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2038 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2039 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2040 the uid and gid if both files are on the same host.
2041 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2043 This function is invoked by `tramp-sh-handle-copy-file' and
2044 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2045 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2046 file names."
2059 ;; `file-extended-attributes' exists since Emacs 24.4.
2070 filename newname)
2073 ;; Both are Tramp files.
2078 ;; Shortcut: if method, host, user are the same for
2079 ;; both files, we invoke `cp' or `mv' on the remote
2080 ;; host directly.
2083 op filename newname
2084 ok-if-already-exists keep-date preserve-uid-gid))
2086 ;; Try out-of-band operation.
2091 op filename newname keep-date))
2093 ;; No shortcut was possible. So we copy the file
2094 ;; first. If the operation was `rename', we go back
2095 ;; and delete the original file (if the copy was
2096 ;; successful). The approach is simple-minded: we
2097 ;; create a new buffer, insert the contents of the
2098 ;; source file into it, then write out the buffer to
2099 ;; the target file. The advantage is that it doesn't
2100 ;; matter which file name handlers are used for the
2101 ;; source and target file.
2104 op filename newname keep-date))))))
2106 ;; One file is a Tramp file, the other one is local.
2109 ;; Fast track on local machine.
2112 op filename newname
2113 ok-if-already-exists keep-date preserve-uid-gid))
2115 ;; If the Tramp file has an out-of-band method, the
2116 ;; corresponding copy-program can be invoked.
2119 op filename newname keep-date))
2121 ;; Use the inline method via a Tramp buffer.
2123 op filename newname keep-date))))
2126 ;; One of them must be a Tramp file.
2129 ;; Handle `preserve-extended-attributes'. We ignore possible
2130 ;; errors, because ACL strings could be incompatible.
2135 ;; In case of `rename', we must flush the cache of the source file.
2142 ;; When newname did exist, we have wrong cached values.
2150 "Use an Emacs buffer to copy or rename a file.
2151 First arg OP is either `copy' or `rename' and indicates the operation.
2152 FILENAME is the source file, NEWNAME the target file.
2153 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2154 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2155 ;; and `find-file-noselect', but that's not called here.
2159 ;; We must disable multibyte, because binary data shall not be
2160 ;; converted. We don't want the target file to be compressed, so we
2161 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2162 ;; be called either. We remove `tramp-file-name-handler' from
2163 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2164 ;; `insert-file-contents' might be deactivated in some corner cases.
2175 ;; KEEP-DATE handling.
2178 newname
2181 ;; Set the mode.
2183 ;; If the operation was `rename', delete the original file.
2188 "Invokes `cp' or `mv' on the remote system.
2189 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2190 respectively. FILENAME specifies the file to copy or rename,
2191 NEWNAME is the name of the new file (for copy) or the new name of
2192 the file (for rename). Both files must reside on the same host.
2193 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2194 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2195 the uid and gid from FILENAME."
2206 v 'file-error
2207 "Unknown operation `%s', must be `copy' or `rename'"
2208 op))))
2212 cmd-result)
2215 ;; Both files are on a remote host, with same user.
2227 ;; Mask cp -f error.
2229 tramp-operation-not-permitted-regexp nil t))
2230 cmd-result)
2232 nil v 'file-error
2233 "Copying directly failed, see buffer `%s' for details."
2236 ;; We are on the local host.
2239 ;; We can do it directly.
2242 ;; No sticky bit when renaming.
2253 localname1 localname2 ok-if-already-exists
2254 keep-date preserve-uid-gid)
2258 ;; We can do it directly with `tramp-send-command'
2266 ok-if-already-exists keep-date t)
2267 ;; We must change the ownership to the local user.
2273 ;; We need a temporary file in between.
2275 ;; Create the temporary file.
2283 "%s %s %s" cmd
2286 "Copying directly failed, see buffer `%s' for details."
2288 ;; We must change the ownership as remote user.
2289 ;; Since this does not work reliable, we also
2290 ;; give read permissions.
2300 localname1 tmpfile t keep-date preserve-uid-gid)
2303 ;; We must change the ownership as local user.
2304 ;; Since this does not work reliable, we also
2305 ;; give read permissions.
2308 tmpfile
2312 ;; Move the temporary file to its destination.
2317 "cp -f -p %s %s"
2320 "Copying directly failed, see buffer `%s' for details."
2324 'rename-file
2327 ;; Save exit.
2330 ;; Set the time and mode. Mask possible errors.
2337 "Invoke `scp' program to copy.
2338 The method used must be an out-of-band method."
2342 copy-program copy-args copy-env copy-keep-date listener spec
2343 options source target remote-copy-program remote-copy-args)
2348 ;; Both are Tramp files. We shall optimize it when the
2349 ;; methods for FILENAME and NEWNAME are the same.
2359 op filename tmpfile keep-date)
2362 ;; Save exit.
2369 ;; Check which ones of source and target are Tramp files.
2373 'file-name-as-directory
2382 ;; Check for user. There might be an interactive setting.
2386 ;; Check for listener port.
2393 ;; Compose copy command.
2402 ?h host ?u user ?p port ?r listener ?c options
2408 copy-args
2410 ;; " " has either been a replacement of "%k" (when
2411 ;; keep-date argument is non-nil), or a replacement
2412 ;; for the whole keep-date sublist.
2413 " "
2418 copy-args
2422 copy-env
2424 nil
2431 remote-copy-program
2437 remote-copy-args
2441 ;; Check for local copy program.
2446 ;; Install listener on the remote side. The prompt must be
2447 ;; consumed later on, when the process does not listen anymore.
2454 v 'file-error
2458 'identity
2466 v 'file-error
2467 "Listener process not running on remote host: `%s'"
2468 remote-copy-program))
2476 ;; The default directory must be remote.
2480 ;; We do not want to run timers.
2481 timer-list timer-idle-list)
2482 ;; Set the transfer process properties.
2492 copy-args
2494 copy-args
2499 ;; Use an asynchronous process. By this, password can
2500 ;; be handled. We don't set a timeout, because the
2501 ;; copying of large files can last longer than 60 secs.
2511 command))))
2517 ;; We must adapt `tramp-local-end-of-line' for
2518 ;; sending the password.
2521 p v nil tramp-actions-copy-out-of-band))))
2523 ;; Reset the transfer process properties.
2526 ;; Clear the remote prompt.
2529 ;; Houston, we have a problem! Likely, the listener is
2530 ;; still running, so let's clear everything (but the
2531 ;; cached password).
2534 ;; Handle KEEP-DATE argument.
2537 newname
2541 ;; Set the mode.
2546 ;; If the operation was `rename', delete the original file.
2553 "Like `make-directory' for Tramp files."
2565 "Like `delete-directory' for Tramp files."
2578 "Like `delete-file' for Tramp files."
2589 ;; Dired.
2592 "Like `dired-compress-file' for Tramp files."
2593 ;; Code stolen mainly from dired-aux.el.
2598 suffix)
2599 ;; See if any suffix rule matches this file name.
2607 nil)
2609 ;; We found an uncompression rule.
2619 ;; We don't recognize the file as compressed, so compress it.
2620 ;; Try gzip.
2634 "Like `insert-directory' for Tramp files."
2641 filename switches wildcard full-directory-p)
2663 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2664 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2667 v
2670 switches
2672 localname
2675 v
2679 "Couldn't `cd %s'"
2683 v
2686 switches
2691 ""
2699 ;; We cannot use `insert-buffer-substring' because the Tramp
2700 ;; buffer changes its contents before insertion due to calling
2701 ;; `expand-file-name' and alike.
2706 ;; Check for "--dired" output.
2713 ;; Now read the numeric positions of file names.
2719 ;; End is followed by \n or by " -> ".
2721 ;; Remove trailing lines.
2727 ;; Some busyboxes are reluctant to discard colors.
2735 ;; Decode the output, it could be multibyte.
2740 ;; The inserted file could be from somewhere else.
2747 "."
2752 ;; Try to insert the amount of free space.
2754 ;; First find the line to put it on.
2758 ;; Replace "total" with "total used", to avoid confusion.
2765 ;; Canonicalization of file names.
2768 "Like `expand-file-name' for Tramp files.
2770 the result will be a local, non-Tramp, file name."
2771 ;; If DIR is not given, use `default-directory' or "/".
2773 ;; Unless NAME is absolute, concat DIR and NAME.
2776 ;; If connection is not established yet, run the real handler.
2779 ;; Dissect NAME.
2783 ;; Tilde expansion if necessary. This needs a shell which
2784 ;; groks tilde expansion! The function `tramp-find-shell' is
2785 ;; supposed to find such a shell on the remote host. Please
2786 ;; tell me about it when this doesn't work on your system.
2790 ;; We cannot simply apply "~/", because under sudo "~/" is
2791 ;; expanded to the local user home directory but to the
2792 ;; root home directory. On the other hand, using always
2793 ;; the default user name for tilde expansion is not
2794 ;; appropriate either, because ssh and companions might
2795 ;; use a user name from the config file.
2807 ;; There might be a double slash, for example when "~/"
2808 ;; expands to "/". Remove this.
2811 ;; No tilde characters in file name, do normal
2812 ;; `expand-file-name' (this does "/./" and "/../").
2813 ;; `default-directory' is bound, because on Windows there would
2814 ;; be problems with UNC shares or Cygwin mounts.
2817 method user domain host port
2821 hop)))))
2823 ;;; Remote commands:
2826 "Flush file caches."
2834 ;; We use BUFFER also as connection buffer during setup. Because of
2835 ;; this, its original contents must be saved, and restored once
2836 ;; connection has been setup.
2838 "Like `start-file-process' for Tramp files."
2843 ;; BUFFER can be nil. We use a temporary buffer.
2845 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2846 ;; it might be that the arguments exceed the command line
2847 ;; length. Therefore, we modify the command.
2852 ;; When PROGRAM is nil, we just provide a tty.
2858 args
2862 ;; Use a human-friendly prompt, for example for `shell'.
2863 ;; We discard hops, if existing, that's why we cannot use
2864 ;; `file-remote-p'.
2867 tramp-initial-end-of-output))
2868 ;; We use as environment the difference to toplevel
2869 ;; `process-environment'.
2870 env uenv
2884 "unset %s &&"
2899 ;; We do not want to raise an error when
2900 ;; `start-file-process' has been started several times in
2901 ;; `eshell' and friends.
2902 tramp-current-connection
2903 ;; We do not want to run timers.
2904 timer-list timer-idle-list
2905 p)
2908 ;; NAME must be unique as process name.
2912 ;; Set the new process properties.
2918 ;; We catch this event. Otherwise, `start-process' could
2919 ;; be called on the local host.
2922 ;; Activate narrowing in order to save BUFFER
2923 ;; contents. Clear also the modification time;
2924 ;; otherwise we might be interrupted by
2925 ;; `verify-visited-file-modtime'.
2931 ;; We call `tramp-maybe-open-connection', in order
2932 ;; to cleanup the prompt afterwards.
2936 ;; Set the pid of the remote shell. This is
2937 ;; needed when sending signals remotely.
2944 ;; Now do it.
2946 ;; Send the command.
2948 ;; Check, whether a pty is associated.
2951 v 'file-error
2953 ;; Set query flag and process marker for this
2954 ;; process. We ignore errors, because the process
2955 ;; could have finished already.
2959 ;; Return process.
2960 p)))
2962 ;; Save exit.
2973 "Like `process-file' for Tramp files."
2974 ;; The implementation is not complete yet.
2980 ;; Compute command.
2983 ;; We use as environment the difference to toplevel `process-environment'.
2994 "env %s %s"
2999 "unset %s && %s"
3001 ;; Determine input.
3006 ;; INFILE is on the same remote host.
3008 ;; INFILE must be copied to remote host.
3010 tmpinput
3015 ;; Determine output.
3017 ;; Just a buffer.
3020 ;; A buffer name.
3023 ;; (REAL-DESTINATION ERROR-DESTINATION)
3025 ;; output.
3033 ;; stderr.
3038 ;; stderr is on the same remote host.
3041 ;; stderr must be copied to remote host. The temporary
3042 ;; file must be deleted after execution.
3045 method user domain host port stderr))))
3046 ;; stderr to be discarded.
3049 ;; 't
3054 ;; Send the command. It might not return in time, so we protect
3055 ;; it. Call it in a subshell, in order to preserve working
3056 ;; directory.
3063 command)
3064 t t)
3066 ;; We should add the output anyway.
3073 ;; When the user did interrupt, we should do it also. We use
3074 ;; return code -1 as marker.
3078 ;; Handle errors.
3083 ;; Provide error file.
3086 ;; Cleanup. We remove all file cache values for the connection,
3087 ;; because the remote process could have changed them.
3093 ;; Return exit status.
3096 ret))))
3099 "Like `file-local-copy' for Tramp files."
3103 v tramp-file-missing
3114 ;; `copy-file' handles direct copy and out-of-band methods.
3119 ;; Use inline encoding for file transfer.
3123 v 3
3125 filename rem-enc)
3132 tmpfile loc-dec)
3134 ;; If local decoding is a function, we call it.
3135 ;; We must disable multibyte, because
3136 ;; `uudecode-decode-region' doesn't handle it
3137 ;; correctly. Unset `file-name-handler-alist'.
3138 ;; Otherwise, epa-file gets confused.
3146 ;; If tramp-decoding-function is not defined for this
3147 ;; method, we invoke tramp-decoding-command instead.
3149 ;; Unset `file-name-handler-alist'. Otherwise,
3150 ;; epa-file gets confused.
3158 loc-dec tmpfile2 tmpfile)
3161 ;; Set proper permissions.
3163 ;; Set local user ownership.
3166 ;; Oops, I don't know what to do.
3170 ;; Error handling.
3176 tmpfile)))
3178 ;; CCC grok LOCKNAME
3181 "Like `write-region' for Tramp files."
3199 ;; `file-writable-p' calls `file-expand-file-name'. We
3200 ;; cannot use `tramp-run-real-handler' therefore.
3206 ;; Short track: if we are on the local host, we can run directly.
3211 ;; We use this to save the value of
3212 ;; `last-coding-system-used' after writing the tmp
3213 ;; file. At the end of the function, we set
3214 ;; `last-coding-system-used' to this saved value. This
3215 ;; way, any intermediary coding systems used while
3216 ;; talking to the remote shell or suchlike won't hose
3217 ;; this variable. This approach was snarfed from
3218 ;; ange-ftp.el.
3219 coding-system-used
3220 ;; Write region into a tmp file. This isn't really
3221 ;; needed if we use an encoding function, but currently
3222 ;; we use it always because this makes the logic
3223 ;; simpler. We must also set `temporary-file-directory',
3224 ;; because it could point to a remote directory.
3230 ;; If `append' is non-nil, we copy the file locally, and let
3231 ;; the native `write-region' implementation do the job.
3234 ;; We say `no-message' here because we don't want the
3235 ;; visited file modtime data to be clobbered from the temp
3236 ;; file. We call `set-visited-file-modtime' ourselves later
3237 ;; on. We must ensure that `file-coding-system-alist'
3238 ;; matches `tmpfile'.
3244 'write-region
3251 ;; Now, `last-coding-system-used' has the right value. Remember it.
3254 ;; The permissions of the temporary file should be set. If
3255 ;; FILENAME does not exist (eq modes nil) it has been
3256 ;; renamed to the backup file. This case `save-buffer'
3257 ;; handles permissions.
3258 ;; Ensure that it is still readable.
3261 tmpfile
3264 ;; This is a bit lengthy due to the different methods
3265 ;; possible for file transfer. First, we check whether the
3266 ;; method uses an scp program. If so, we call it.
3267 ;; Otherwise, both encoding and decoding command must be
3268 ;; specified. However, if the method _also_ specifies an
3269 ;; encoding function, then that is used for encoding the
3270 ;; contents of the tmp file.
3276 ;; `copy-file' handles direct copy and out-of-band methods.
3286 ;; We keep the local file for performance
3287 ;; reasons, useful for "rsync".
3294 ;; Don't rename, in order to keep context in SELinux.
3299 ;; Use inline file transfer.
3301 ;; Encode tmpfile.
3305 ;; Use encoding function or command.
3308 "Encoding local file `%s' using `%s'"
3309 tmpfile loc-enc)
3311 ;; The following `let' is a workaround for
3312 ;; the base64.el that comes with pgnus-0.84.
3313 ;; If both of the following conditions are
3314 ;; satisfied, it tries to write to a local
3315 ;; file in default-directory, but at this
3316 ;; point, default-directory is remote.
3317 ;; (`call-process-region' can't write to
3318 ;; remote files, it seems.) The file in
3319 ;; question is a tmp file anyway.
3327 loc-enc tmpfile t))
3329 v 'file-error
3332 filename loc-enc))))
3334 ;; Send buffer into remote decoding command which
3335 ;; writes to remote file. Because this happens on
3336 ;; the remote host, we cannot use the function.
3339 "Decoding remote file `%s' using `%s'"
3340 filename rem-dec)
3344 v
3348 tramp-end-of-heredoc
3350 tramp-end-of-heredoc))
3352 v nil
3353 "Couldn't write region to `%s', decode using `%s' failed"
3354 filename rem-dec)
3355 ;; When `file-precious-flag' is set, the region is
3356 ;; written to a temporary file. Check that the
3357 ;; checksum is equal to that from the local tmpfile.
3361 ;; cksum runs locally, if possible.
3363 ;; cksum runs remotely.
3365 v
3368 ;; ... they are different.
3375 v 'file-error
3378 filename rem-dec)))))
3380 ;; Save exit.
3383 ;; That's not expected.
3386 v 'file-error
3389 method))))
3391 ;; Make `last-coding-system-used' have the right value.
3398 ;; We must protect `last-coding-system-used', now we have set it
3399 ;; to its correct value.
3401 ;; Set file modification time.
3405 ;; We must pass modtime explicitly, because FILENAME can
3406 ;; be different from (buffer-file-name), f.e. if
3407 ;; `file-precious-flag' is set.
3413 ;; Set the ownership.
3424 ;; VC backends check for the existence of various different special
3425 ;; files. This is very time consuming, because every single check
3426 ;; requires a remote command (the file cache must be invalidated).
3427 ;; Therefore, we apply a kind of optimization. We install the file
3428 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3429 ;; remembers all file names for which `file-exists-p' or
3430 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3431 ;; is performed. Afterwards, a script is applied for all collected
3432 ;; file names, using just one remote command. The result of this
3433 ;; script is used to fill the file cache with actual values. Now we
3434 ;; can reset the file name handlers, and we make a second run of
3435 ;; `vc-registered', which returns the expected result without sending
3436 ;; any other remote command.
3438 "Like `vc-registered' for Tramp files."
3444 ;; There could be new files, created by the vc backend. We
3445 ;; cannot reuse the old cache entries, therefore. In
3446 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3447 ;; could also be a timestamp as `current-time' returns. This
3448 ;; means invalidate all cache entries with an older timestamp.
3454 ;; Here we collect only file names, which need an operation.
3456 v "Error in 1st pass of `vc-registered': %s"
3460 ;; Send just one command, in order to fill the cache.
3463 v
3472 ;; We cannot use `tramp-send-command-and-read',
3473 ;; because this does not cooperate well with
3474 ;; heredoc documents.
3476 v
3479 tramp-end-of-heredoc
3481 tramp-vc-registered-file-names
3483 tramp-end-of-heredoc))
3485 ;; Read the expression.
3492 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3493 ;; calls shall be answered from the file cache. We unset
3494 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3495 ;; in order to keep the cache.
3497 remote-file-name-inhibit-cache process-file-side-effects)
3498 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3517 ;; Run.
3519 v "Error in 2nd pass of `vc-registered': %s"
3522 ;;;###tramp-autoload
3524 "Invoke remote-shell Tramp file name handler.
3525 Fall back to normal file name handler if no Tramp handler exists."
3531 ;; This must be the last entry, because `identity' always matches.
3532 ;;;###tramp-autoload
3537 "Invoke special file name handler, which collects files to be handled."
3545 ;; That's what we want: file names, for which checks are
3546 ;; applied. We assume that VC uses only `file-exists-p' and
3547 ;; `file-readable-p' checks; otherwise we must extend the
3548 ;; list. We do not perform any action, but return nil, in
3549 ;; order to keep `vc-registered' running.
3552 nil)
3553 ;; `process-file' and `start-file-process' shall be ignored.
3556 ;; Tramp file name handlers like `expand-file-name'. They
3557 ;; must still work.
3559 ;; Default file name handlers, we don't care.
3563 "Like `file-notify-add-watch' for Tramp files."
3567 command events filter p sequence)
3569 ;; "inotifywait".
3572 events
3582 ;; Make events a list of symbols.
3583 events
3587 ;; "gio monitor".
3590 events
3594 attribute-changed))
3599 ;; "gvfs-monitor-dir".
3602 events
3606 attribute-changed))
3611 ;; None.
3613 v 'file-notify-error
3614 "No file notification program found on %s"
3616 ;; Start process.
3618 'start-file-process
3622 sequence))
3623 ;; Return the process object as watch-descriptor.
3626 v 'file-notify-error
3627 "`%s' failed to start on remote host"
3631 ;; Needed for process filter.
3636 ;; There might be an error if the monitor is not supported.
3637 ;; Give the filter a chance to read the output.
3642 p))))
3655 ;; Fix action names.
3662 ;; https://bugs.launchpad.net/bugs/1742946
3671 string)
3677 proc
3680 ;; File names are returned as absolute paths. We must
3681 ;; add the remote prefix.
3685 ;; Remove watch when file or directory to be watched is deleted.
3689 ;; Usually, we would add an Emacs event now. Unfortunately,
3690 ;; `unread-command-events' does not accept several events at
3691 ;; once. Therefore, we apply the handler directly.
3694 'file-notify-handle-event
3697 ;; Save rest of the string.
3704 file-notify events."
3714 ;; Attribute change is returned in unused wording.
3724 string)
3729 proc
3734 ;; File names are returned as absolute paths. We must
3735 ;; add the remote prefix.
3739 ;; Remove watch when file or directory to be watched is deleted.
3743 ;; Usually, we would add an Emacs event now. Unfortunately,
3744 ;; `unread-command-events' does not accept several events at
3745 ;; once. Therefore, we apply the handler directly.
3748 'file-notify-handle-event
3751 ;; Save rest of the string.
3761 ;; Check, whether there is a problem.
3766 line)
3771 proc
3778 ;; Remove watch when file or directory to be watched is deleted.
3781 ;; Usually, we would add an Emacs event now. Unfortunately,
3782 ;; `unread-command-events' does not accept several events at
3783 ;; once. Therefore, we apply the handler directly.
3786 'file-notify-handle-event
3790 "Like `file-system-info' for Tramp files."
3797 "%s --block-size=1 --output=size,used,avail %s"
3807 ;; The second value is the used size. We need the
3808 ;; free size.
3813 ;;; Internal Functions:
3816 "Define in remote shell function NAME implemented as SCRIPT.
3817 Only send the definition if it has not already been done."
3818 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3819 ;; might be nil.
3825 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3826 ;; could result in unwanted command expansion. Avoid this.
3829 ;; The script could contain a call of Perl. This is masked with `%s'.
3834 vec
3842 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3843 Returns the exit code of the `test' program."
3846 v
3848 "%s %s %s"
3850 switch
3854 "Run `test'-like program on the remote system, given FILE1, FILE2.
3855 FORMAT-STRING contains the program name, switches, and place holders.
3856 Returns the exit code of the `test' program. Barfs if the methods,
3857 hosts, or files, disagree."
3861 v 'file-error
3866 v1
3873 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3874 First arg VEC specifies the connection, PROGNAME is the program
3875 to search for, and DIRLIST gives the list of directories to
3876 search. If IGNORE-TILDE is non-nil, directory names starting
3877 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3878 only in DIRLIST.
3880 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3882 This function expects to be in the right *tramp* buffer."
3885 ;; Check whether the executable is in $PATH. "which(1)" does not
3886 ;; report always a correct error code; therefore we check the
3887 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3888 ;; 5.11") have problems with this command, we disable the call
3889 ;; therefore.
3900 ;; Remove all ~/foo directories from dirlist.
3909 vec
3911 "do if test -x $d/%s && test -f $d/%s; "
3912 "then echo tramp_executable $d/%s; "
3915 progname progname progname
3916 tramp-end-of-heredoc
3918 tramp-end-of-heredoc))
3924 result)))
3927 "Sets the remote environment PATH to existing directories.
3928 I.e., for each directory in `tramp-remote-path', it is tested
3929 whether it exists and if so, it is added to the environment
3930 variable PATH."
3936 ;; ------------------------------------------------------------
3937 ;; -- Communication with external shell --
3938 ;; ------------------------------------------------------------
3941 "Find a command on the remote host for checking if a file exists.
3942 Here, we are looking for a command which has zero exit status if the
3943 file exists and nonzero exit status otherwise."
3947 result)
3948 ;; The algorithm is as follows: we try a list of several commands.
3949 ;; For each command, we first run `$cmd /' -- this should return
3950 ;; true, as the root directory always exists. And then we run
3951 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3952 ;; does not exist. This should return false. We use the first
3953 ;; command we find that seems to work.
3954 ;; The list of commands to try is as follows:
3955 ;; `ls -d' This works on most systems, but NetBSD 1.4
3956 ;; has a bug: `ls' always returns zero exit
3957 ;; status, even for files which don't exist.
3958 ;; `test -e' Some Bourne shells have a `test' builtin
3959 ;; which does not know the `-e' option.
3960 ;; `/bin/test -e' For those, the `test' binary on disk normally
3961 ;; provides the option. Alas, the binary
3962 ;; is sometimes `/bin/test' and sometimes it's
3963 ;; `/usr/bin/test'.
3964 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3992 result))
3995 "Opens shell SHELL."
3998 ;; Find arguments for this shell.
4000 item extra-args)
4005 ;; It is useful to set the prompt in the following command
4006 ;; because some people have a setting for $PS1 which /bin/sh
4007 ;; doesn't know about and thus /bin/sh will display a strange
4008 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4009 ;; ksh will display the current working directory but /bin/sh
4010 ;; will display a dollar sign. The following command line sets
4011 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4012 ;; well as csh-like shells. We also unset the variable $ENV
4013 ;; because that is read by some sh implementations (eg, bash
4014 ;; when called as sh) on startup; this way, we avoid the startup
4015 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4016 ;; the prompt in /bin/bash, it must be discarded as well.
4017 ;; $HISTFILE is set according to `tramp-histfile-override'.
4018 ;; $TERM and $INSIDE_EMACS set here to ensure they have the
4019 ;; correct values when the shell starts, not just processes
4020 ;; run within the shell. (Which processes include our
4021 ;; initial probes to ensure the remote shell is usable.)
4025 "exec env TERM='%s' INSIDE_EMACS='%s,tramp:%s' "
4027 tramp-terminal-type
4028 emacs-version tramp-version ; INSIDE_EMACS
4034 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4038 t)
4039 ;; Check proper HISTFILE setting. We give up when not working.
4043 vec
4045 "(cd %s)"
4048 "`tramp-histfile-override' uses invalid file `%s'"
4049 tramp-histfile-override)))
4055 "Opens a shell on the remote host which groks tilde expansion."
4058 shell)
4061 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4062 ;; Which check could we apply instead?
4065 ;; The default shell (ksh93) of OpenSolaris and
4066 ;; Solaris is buggy. We've got reports for
4067 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4076 ;; Maybe it works at least for some other commands.
4078 default-shell
4080 vec 2
4082 "Couldn't find a remote shell which groks tilde "
4084 default-shell)))
4086 default-shell)))
4088 ;; Open a new shell if needed.
4094 ;; Utility functions.
4097 "Wait for shell prompt and barf if none appears.
4098 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4099 seconds. If not, it produces an error message with the given ERROR-ARGS."
4103 proc timeout
4112 "Set up an interactive shell.
4113 Mainly sets the prompt and the echo correctly. PROC is the shell
4114 process to set up. VEC specifies the connection."
4119 ;; Disable echo expansion.
4123 ;; Check whether the echo has really been disabled. Some
4124 ;; implementations, like busybox of embedded GNU/Linux, don't
4125 ;; support disabling.
4132 ;; Make sure backspaces and their echo are enabled and no line
4133 ;; width magic interferes with them.
4140 t)
4142 ;; Check whether the output of "uname -sr" has been changed. If
4143 ;; yes, this is a strong indication that we must expire all
4144 ;; connection properties. We start again with
4145 ;; `tramp-maybe-open-connection', it will be caught there.
4150 vec "uname"
4154 vec 3
4155 "Connection reset, because remote host changed from `%s' to `%s'"
4156 old-uname uname)
4157 ;; We want to keep the password.
4161 ;; Try to set up the coding system correctly.
4162 ;; CCC this can't be the right way to do it. Hm.
4165 ;; Use MULE to select the right EOL convention for communicating
4166 ;; with the process.
4172 cs-decode cs-encode)
4176 cs-encode
4183 ;; Special setting for macOS.
4194 ;; Check whether the remote host suffers from buggy
4195 ;; `send-process-string'. This is known for FreeBSD (see comment
4196 ;; in `send_process', file process.c). I've tested sending 624
4197 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4198 ;; hack when this host type is detected locally. It cannot handle
4199 ;; remote hosts, though.
4203 tramp-chunksize)
4209 ;; Set remote PATH variable.
4212 ;; Search for a good shell before searching for a command which
4213 ;; checks if a file exists. This is done because Tramp wants to
4214 ;; use "test foo; echo $?" to check if various conditions hold,
4215 ;; and there are buggy /bin/sh implementations which don't execute
4216 ;; the "echo $?" part if the "test" part has an error. In
4217 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4218 ;; also other problems with /bin/sh of OpenSolaris, like
4219 ;; redirection of stderr in function declarations, or changing
4220 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4221 ;; by bash, when detected.
4224 ;; Disable unexpected output.
4227 ;; IRIX64 bash expands "!" even when in single quotes. This
4228 ;; destroys our shell functions, we must disable it. See
4229 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4233 ;; Disable tab expansion.
4238 ;; Set utf8 encoding. Needed for macOS, for example. This is
4239 ;; non-POSIX, so we must expect errors on some systems.
4242 ;; Set `remote-tty' process property.
4248 ;; Dump stty settings in the traces.
4252 ;; Set the environment.
4266 vec
4269 tramp-end-of-heredoc
4271 tramp-end-of-heredoc)
4272 t))
4277 ;; Old text from documentation of tramp-methods:
4278 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4279 ;; of the base64 methods instead since base64 encoding is much more
4280 ;; reliable and the commands are more standardized between the different
4281 ;; Unix versions. But if you can't use base64 for some reason, please
4282 ;; note that the default uudecode command does not work well for some
4283 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4284 ;; the following command for uudecode:
4285 ;;
4286 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4287 ;;
4288 ;; For Irix, no solution is known yet.
4296 "List of local coding commands for inline transfer.
4297 Each item is a list that looks like this:
4299 \(FORMAT ENCODING DECODING)
4301 FORMAT is symbol describing the encoding/decoding format. It can be
4302 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4304 ENCODING and DECODING can be strings, giving commands, or symbols,
4305 giving functions. If they are strings, then they can contain
4307 file name will be put into the command line at that spot. If the
4308 specifier is not present, the input should be read from standard
4309 input.
4311 If they are functions, they will be called with two arguments, start
4312 and end of region, and are expected to replace the region contents
4317 ;; "-i" is more robust with older base64 from GNU coreutils.
4318 ;; However, I don't know whether all base64 versions do supports
4319 ;; this option.
4327 ;; This is painful slow, so we put it on the end.
4334 "List of remote coding commands for inline transfer.
4335 Each item is a list that looks like this:
4337 \(FORMAT ENCODING DECODING [TEST])
4339 FORMAT is a symbol describing the encoding/decoding format. It can be
4340 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4342 ENCODING and DECODING can be strings, giving commands, or symbols,
4343 giving variables. If they are strings, then they can contain
4345 file name will be put into the command line at that spot. If the
4346 specifier is not present, the input should be read from standard
4347 input.
4349 If they are variables, this variable is a string containing a
4350 Perl or Shell implementation for this functionality. This
4351 program will be transferred to the remote host, and it is
4353 specifier in the variable value denotes a temporary file.
4355 The optional TEST command can be used for further tests, whether
4359 "Find an inline transfer encoding that works.
4360 Goes through the list `tramp-local-coding-commands' and
4361 `tramp-remote-coding-commands'."
4366 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4374 ;; If the local encoder or decoder is a string, the
4375 ;; corresponding command has to work locally.
4382 loc-enc nil nil))
4390 loc-dec nil nil))
4392 ;; Search for remote coding commands with the same format
4400 ;; Check the remote test command if exists.
4406 ;; Check if remote perl exists when necessary.
4411 ;; Check if remote encoding and decoding commands can be
4412 ;; called remotely with null input and output. This makes
4413 ;; sure there are no syntax errors and the command is really
4414 ;; found. Note that we do not redirect stdout to /dev/null,
4415 ;; for two reasons: when checking the decoding command, we
4416 ;; actually check the output it gives. And also, when
4417 ;; redirecting "mimencode" output to /dev/null, then as root
4418 ;; it might change the permissions of /dev/null!
4426 vec 5
4435 tmpfile)
4442 tramp-temp-name-prefix
4444 value
4446 value
4448 ?t
4453 vec 5
4456 vec
4458 t)
4466 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4472 ;; Set connection properties. Since the commands are risky
4473 ;; (due to output direction), we cache them in the process cache.
4484 "Call the local encoding or decoding command.
4486 Otherwise, INPUT is passed via standard input.
4487 INPUT can also be nil which means `/dev/null'.
4488 OUTPUT can be a string (which specifies a file name), or t (which
4489 means standard output and thus the current buffer), or nil (which
4490 means discard it)."
4492 nil tramp-encoding-shell
4495 nil
4496 tramp-encoding-command-switch
4506 "List of compress and decompress commands for inline transfer.
4507 Each item is a list that looks like this:
4509 \(COMPRESS DECOMPRESS)
4514 "Find an inline transfer compress command that works.
4515 Goes through the list `tramp-inline-compress-commands'."
4520 item compress decompress found)
4527 vec 5
4528 "Checking local compress commands `%s', `%s' for sanity"
4529 compress decompress)
4534 "echo %s | %s | %s" magic
4535 ;; Windows shells need the program file name after
4536 ;; the pipe symbol be quoted if they use forward
4537 ;; slashes as directory separators.
4542 nil nil))
4545 vec 5
4546 "Checking remote compress commands `%s', `%s' for sanity"
4547 compress decompress)
4553 ;; Did we find something?
4556 ;; Set connection properties. Since the commands are
4557 ;; risky (due to output direction), we cache them in the
4558 ;; process cache.
4572 "Expands VEC according to `tramp-default-proxies-alist'."
4576 choices proxy)
4578 ;; Ad-hoc proxy definitions.
4583 tramp-prefix-format proxy tramp-postfix-host-format)))
4588 proxy)
4589 ;; Add the hop.
4591 'tramp-default-proxies-alist
4594 proxy))
4596 ;; Save the new value.
4601 ;; Look for proxy hosts to be passed.
4607 ;; Host.
4610 ;; User.
4614 ;; No more hops needed.
4616 ;; Replace placeholders.
4619 proxy
4624 ;; Add the hop.
4626 ;; Start next search.
4629 ;; Foreign and out-of-band methods are not supported for multi-hops.
4636 vec 'file-error
4637 "Method `%s' is not supported for multi-hops."
4640 ;; In case the host name is not used for the remote shell
4641 ;; command, the user could be misguided by applying a random
4642 ;; host name.
4648 ;; There are multi-hops.
4650 ;; The host name is used for the remote shell command.
4652 ;; The host is local. We cannot use `tramp-local-host-p'
4653 ;; here, because it opens a connection as well.
4656 v 'file-error
4657 "Host `%s' looks like a remote host, `%s' can only use the local host"
4658 host method)))
4660 ;; Result.
4661 target-alist))
4664 "Return the Control* arguments of the local ssh."
4666 ;; No options to be computed.
4671 ;; There is already a value to be used.
4674 ;; Determine the options.
4689 ;; We use a non-existing IP address, in order to
4690 ;; avoid useless connections, and DNS timeouts.
4691 ;; Setting ConnectTimeout is needed since OpenSSH 7.
4693 vec "ssh" nil t nil
4699 " -o ControlPath='tramp.%%r@%%h:%%p'"
4708 tramp-ssh-controlmaster-options)))
4711 "Maybe open a connection VEC.
4712 Does not do anything if a connection is already open, but re-opens the
4713 connection if a previous connection has died for some reason."
4719 ;; If Tramp opens the same connection within a short time frame,
4720 ;; there is a problem. We shall signal this.
4729 ;; If too much time has passed since last command was sent, look
4730 ;; whether process is still alive. If it isn't, kill it. When
4731 ;; using ssh, it can sometimes happen that the remote end has hung
4732 ;; up but the local ssh client doesn't recognize this until it
4733 ;; tries to send some data to the remote end. So that's why we
4734 ;; try to send a command from time to time, then look again
4735 ;; whether the process is really alive.
4746 ;; The error will be caught locally.
4752 ;; New connection must be opened.
4756 ;; During completion, don't reopen a new connection. We
4757 ;; check this for the process related to
4758 ;; `tramp-buffer-name'; otherwise `start-file-process'
4759 ;; wouldn't run ever when `non-essential' is non-nil.
4765 vec 3
4776 ;; Start new process.
4794 ;; We will apply `tramp-ssh-controlmaster-options'
4795 ;; only for the first hop.
4799 ;; There are unfortunate settings for "cmdproxy" on
4800 ;; W32 systems.
4803 ;; This must be done in order to avoid our file
4804 ;; name handler.
4808 'start-process
4813 tramp-encoding-command-interactive)
4816 ;; Set sentinel and query flag. Initialize variables.
4826 ;; Check whether process is alive.
4828 p 10
4831 ;; Now do all the connections as specified.
4851 ;; We don't create the temporary file. In
4852 ;; fact, it is just a prefix for the
4853 ;; ControlPath option of ssh; the real
4854 ;; temporary file has another name, and it is
4855 ;; created and protected by ssh. It is also
4856 ;; removed by ssh when the connection is
4857 ;; closed. The temporary file name is cached
4858 ;; in the main connection process, therefore
4859 ;; we cannot use `tramp-get-connection-process'.
4865 tramp-temp-name-prefix
4867 spec r-shell)
4869 ;; Add arguments for asynchronous processes.
4873 ;; Check, whether there is a restricted shell.
4879 ;; Set password prompt vector.
4881 p "password-vector"
4886 ;; Add login environment.
4889 login-env
4894 login-env))
4898 "%s=%s %s"
4901 command)))
4904 ;; Replace `login-args' place holders.
4912 ?h l-host ?u l-user ?p l-port ?c options)
4913 command
4915 ;; We do not want to see the trailing local
4916 ;; prompt in `start-file-process'.
4918 command " "
4924 ;; Local shell could be a Windows COMSPEC. It
4925 ;; doesn't know the ";" syntax, but we must exit
4926 ;; always for `start-file-process'. It could
4927 ;; also be a restricted shell, which does not
4928 ;; allow "exec".
4931 ;; Send the command.
4935 p vec
4938 tramp-actions-before-shell
4942 ;; Next hop.
4946 ;; Set connection-local variables.
4949 ;; Make initial shell settings.
4952 ;; Mark it as connected.
4955 ;; Cleanup, and propagate the signal.
4961 "Send the COMMAND to connection VEC.
4962 Erases temporary buffer before sending the command. If optional
4963 arg NEVEROPEN is non-nil, never try to open the connection. This
4964 is meant to be used from `tramp-maybe-open-connection' only. The
4965 function waits for output unless NOOUTPUT is set."
4969 ;; We mark the command string that it can be erased in the output buffer.
4971 ;; If we put `tramp-echo-mark' after a trailing newline (which
4972 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4973 ;; that newline and adds `tramp-rsh-end-of-line' right after
4974 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4975 ;; trailing line endings and sends two prompts after executing
4976 ;; the command, which confuses `tramp-wait-for-output'.
4980 ;; No need to restore a trailing newline here since `tramp-send-string'
4981 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4983 ;; Send the command.
4989 "Wait for output from remote command."
4995 ;; be leading escape sequences, which must be ignored.
4996 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4997 ;; option send also escape sequences, which must be
4998 ;; ignored.
5001 tramp-device-escape-sequence-regexp))
5002 ;; Sometimes, the commands do not return a newline but a
5003 ;; null byte before the shell prompt, for example "git
5004 ;; ls-files -c -z ...".
5009 ;; A simple-minded busybox has sent " ^H" sequences.
5010 ;; Delete them.
5015 ;; Delete the prompt.
5021 proc 'file-error
5022 "[[Remote prompt `%s' not found in %d secs]]"
5023 tramp-end-of-output timeout)
5025 proc 'file-error
5027 ;; Return value is whether end-of-output sentinel was found.
5028 found)))
5032 "Run COMMAND and check its exit status.
5033 Sends `echo $?' along with the COMMAND for checking the exit status.
5034 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5035 status is 0, and nil otherwise.
5037 If the optional argument SUBSHELL is non-nil, the command is
5038 executed in a subshell, ie surrounded by parentheses. If
5039 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5041 vec
5043 command
5045 "echo tramp_exit_status $?"
5059 "Run COMMAND, check exit status, throw error if exit status not okay.
5060 Similar to `tramp-send-command-and-check' but accepts two more arguments
5061 FMT and ARGS which are passed to `error'."
5066 "Run COMMAND and return the output, which must be a Lisp expression.
5067 If MARKER is a regexp, read the output after that string.
5068 In case there is no valid Lisp expression and NOERROR is nil, it
5069 raises an error."
5076 ;; Read the marker.
5082 vec 'file-error
5083 "`%s' does not return the marker `%s': `%s'"
5085 ;; Read the expression.
5088 ;; Error handling.
5093 vec 'file-error
5094 "`%s' does not return a valid Lisp expression: `%s'"
5098 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5099 Convert file mode bits to string and set virtual device number.
5100 Return ATTR."
5102 ;; Remove color escape sequences from symlink.
5106 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5107 ;; indication of unusable value.
5118 ;; Convert last access time.
5123 ;; Convert last modification time.
5128 ;; Convert last status change time.
5133 ;; Convert file size.
5139 ;; Convert file mode bits to string.
5144 ;; Convert directory indication bit.
5147 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5153 ;; Set file's gid change bit.
5161 ;; Convert inode.
5166 middle low)
5169 ;; The low 16 bits.
5174 ;; The middle 24 bits.
5178 ;; Inodes can be incredible huge. We must hide this.
5180 ;; Set virtual device number.
5183 attr))
5186 "Converts STRING to shell glob pattern which ignores case."
5192 string
5196 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5208 localname)
5214 "Return t if this is an out-of-band method, nil otherwise."
5216 ;; It shall be an out-of-band method.
5218 ;; There must be a size, otherwise the file doesn't exist.
5220 ;; Either the file size is large enough, or (in rare cases) there
5221 ;; does not exist a remote encoding.
5226 ;; Variables local to connection.
5229 "Compile list of remote directories for $PATH.
5230 Nonexistent directories are removed from spec."
5232 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5233 ;; cache the result for the session only. Otherwise, the result
5234 ;; is cached persistently.
5237 vec)
5238 "remote-path"
5247 ;; Default if "getconf" is not available.
5250 vec 3
5255 ;; The login shell could return more than just the $PATH
5256 ;; string. So we use `tramp-end-of-heredoc' as marker.
5260 vec
5265 'identity
5269 'identity
5277 nil)))))
5279 ;; Replace place holder `tramp-default-remote-path'.
5287 ;; Replace place holder `tramp-own-remote-path'.
5295 ;; Remove double entries.
5302 ;; Remove non-existing directories.
5304 nil
5310 x))
5311 remote-path)))))
5314 "Determine remote locale, supporting UTF8 if possible."
5318 locale)
5325 candidates nil)
5327 ;; Return value.
5331 "Determine remote `ls' command."
5338 result)
5340 ;; Check parameters. On busybox, "ls" output coloring is
5341 ;; enabled by default sometimes. So we try to disable it
5342 ;; when possible. $LS_COLORING is not supported there.
5343 ;; Some "ls" versions are sensible wrt the order of
5344 ;; arguments, they fail when "-al" is after the
5345 ;; "--color=never" argument (for example on FreeBSD).
5357 "Check, whether the remote `ls' command supports the --dired option."
5361 ;; Some "ls" versions are sensible wrt the order of arguments,
5362 ;; they fail when "-al" is after the "--dired" argument (for
5363 ;; example on FreeBSD).
5368 "Check, whether the remote `ls' command supports the --quoting-style option."
5377 "Check, whether the remote `ls' command supports the -w option."
5381 ;; Option "-w" is available on BSD systems. No argument is
5382 ;; given, because this could return wrong results in case "ls"
5383 ;; supports the "-w NUM" argument, as for busyboxes.
5388 "Determine remote `test' command."
5392 "test"
5396 "Check, whether the remote `test' command supports the -nt option."
5397 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5398 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5399 ;; for otherwise the shell crashes.
5411 vec
5418 "Determine remote command for file existing check."
5424 "Determine remote `ln' command."
5430 "Determine remote `perl' command."
5436 ;; Perform a basic check.
5441 ;; We must check also for some Perl modules.
5449 result)))
5452 "Determine remote `stat' command."
5457 tmp)
5458 ;; Check whether stat(1) returns usable syntax. "%s" does not
5459 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5460 ;; use shell quoted format for "%N", we check the boundaries "`"
5461 ;; and "'", therefore. See Bug#23422 in coreutils.
5462 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5463 ;; supported.
5472 result)))
5475 "Determine remote `readlink' command."
5483 result))))
5486 "Determine remote `trash' command.
5487 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5494 "Determine remote `touch' command."
5503 ;; Busyboxes do support the "-t" option only when they have been
5504 ;; built with the DESKTOP config option. Let's check it.
5507 vec "touch-t"
5509 vec
5511 "%s -t %s %s"
5512 result
5516 result)))
5519 "Determine remote `df' command."
5524 result
5527 result))))
5530 "Determine remote `gio-monitor' command."
5536 "Determine remote `gvfs-monitor-dir' command."
5539 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5540 ;; establish better timeouts in filenotify-tests.el. Any better
5541 ;; distinction approach would be welcome!
5548 "Determine remote `inotifywait' command."
5554 "Determine remote `id' command."
5560 result)
5562 ;; Check POSIX parameter.
5568 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5570 vec
5578 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5580 vec
5584 "print $>"
5588 "Determine remote `python' command."
5596 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5598 vec
5602 "import os; print (os.getuid())"
5606 "The uid of the remote connection VEC, in ID-FORMAT.
5607 ID-FORMAT valid values are `string' and `integer'."
5618 ;; Ensure there is a valid result.
5621 tramp-unknown-id-integer)
5623 tramp-unknown-id-string)
5627 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5629 vec
5637 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5639 vec
5647 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5649 vec
5653 "import os; print (os.getgid())"
5657 "The gid of the remote connection VEC, in ID-FORMAT.
5658 ID-FORMAT valid values are `string' and `integer'."
5669 ;; Ensure there is a valid result.
5672 tramp-unknown-id-integer)
5674 tramp-unknown-id-string)
5678 "Check, whether the remote `env' command supports the -u option."
5681 ;; Option "-u" is a GNU extension.
5685 ;; Some predefined connection properties.
5687 "Return the compress command related to PROP.
5688 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5689 the length of the file to be compressed.
5691 If no corresponding command is found, nil is returned."
5700 "Return the coding command related to PROP.
5701 PROP is either `remote-encoding', `remote-decoding',
5702 `local-encoding' or `local-decoding'.
5704 SIZE is the length of the file to be coded. Depending on SIZE,
5705 compression might be applied.
5707 If no corresponding command is found, nil is returned.
5708 Otherwise, either a string is returned which contains a `%s' mark
5709 to be used for the respective input or output file; or a Lisp
5710 function cell is returned to be applied on a buffer."
5711 ;; We must catch the errors, because we want to return nil, when
5712 ;; no inline coding is found.
5722 compress)
5723 ;; The connection property might have been cached. So we must
5724 ;; send the script to the remote side - maybe.
5732 ;; Check for the `compress' command.
5734 ;; Return the value.
5755 coding)
5758 ;; Windows shells need the program file name after
5759 ;; the pipe symbol be quoted if they use forward
5760 ;; slashes as directory separators.
5767 coding compress))
5770 ;; Windows shells need the program file name after
5771 ;; the pipe symbol be quoted if they use forward
5772 ;; slashes as directory separators.
5777 compress coding))
5791 ;;; TODO:
5793 ;; * Don't use globbing for directories with many files, as this is
5794 ;; likely to produce long command lines, and some shells choke on
5795 ;; long command lines.
5796 ;;
5797 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5798 ;; then look if it's the right version (with `perl -v').
5799 ;;
5800 ;; * When editing a remote CVS controlled file as a different user, VC
5801 ;; gets confused about the file locking status. Try to find out why
5802 ;; the workaround doesn't work.
5803 ;;
5804 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5805 ;; until the last but one hop via `start-file-process'. Apply it
5806 ;; also for ftp and smb.
5807 ;;
5808 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5809 ;; some shell with root privileges, it would be nice if I could
5810 ;; just call
5811 ;; trampclient filename.c
5812 ;; as an editor, and the _current_ shell would connect to an Emacs
5813 ;; server and would be used in an existing non-privileged Emacs
5814 ;; session for doing the editing in question.
5815 ;; That way, I need not tell Emacs my password again and be afraid
5816 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5817 ;; once display a just typed password in the context of a keyboard
5818 ;; sequence prompt for a question immediately following in a shell
5819 ;; script run within Emacs -- nasty).
5820 ;; And if I have some ssh session running to a different computer,
5821 ;; having the possibility of passing a local file there to a local
5822 ;; Emacs session (in case I can arrange for a connection back) would
5823 ;; be nice.
5824 ;; Likely the corresponding Tramp server should not allow the
5825 ;; equivalent of the emacsclient -eval option in order to make this
5826 ;; reasonably unproblematic. And maybe trampclient should have some
5827 ;; way of passing credentials, like by using an SSL socket or
5828 ;; something. (David Kastrup)
5829 ;;
5830 ;; * Reconnect directly to a compliant shell without first going
5831 ;; through the user's default shell. (Pete Forman)
5832 ;;
5833 ;; * Avoid the local shell entirely for starting remote processes. If
5834 ;; so, I think even a signal, when delivered directly to the local
5835 ;; SSH instance, would correctly be propagated to the remote process
5836 ;; automatically; possibly SSH would have to be started with
5837 ;; "-t". (Markus Triska)
5838 ;;
5839 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5840 ;; isn't on the remote host. (Mark A. Hershberger)
5841 ;;
5842 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5843 ;;
5844 ;; * Optimize out-of-band copying when both methods are scp-like (not
5845 ;; rsync).
5846 ;;
5847 ;; * Keep a second connection open for out-of-band methods like scp or
5848 ;; rsync.
5849 ;;
5850 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5851 ;;
5852 ;; * I think you could get the best of both worlds by using an
5853 ;; approach similar to Tramp but running a little tramp-daemon on
5854 ;; the other end, such that we can use a more efficient
5855 ;; communication protocol (e.g. when saving a file we could locally
5856 ;; diff it against the last version (of which the remote daemon
5857 ;; would also keep a copy), and then only send the diff).
5858 ;;
5859 ;; This said, even using such a daemon it might be difficult to get
5860 ;; good performance: part of the problem is the number of
5861 ;; round-trips. E.g. when saving a file we have to check if the
5862 ;; file was modified in the mean time and whether saving into a new
5863 ;; inode would change the owner (etc...), which each require a
5864 ;; round-trip. To get rid of these round-trips, we'd have to
5865 ;; shortcut this code and delegate the higher-level "save file"
5866 ;; operation to the remote server, which then has to perform those
5867 ;; tasks but still obeying the locally set customizations about how
5868 ;; to do each one of those tasks.
5869 ;;
5870 ;; We could either put higher-level ops in there (like
5871 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5872 ;; behavior, which is a lot of work and likely to be not 100%
5873 ;; faithful.
5874 ;;
5875 ;; Or we could introduce new low-level ops that are asynchronous,
5876 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5877 ;; start with a bunch of calls like `start-getting-file-attributes'
5878 ;; which could immediately be passed on to the remote side, and
5879 ;; later on checks the return value of those calls as and when
5880 ;; needed. (Stefan Monnier)
5882 ;;; tramp-sh.el ends here