| blob | 0cdf42de68a24a6d794d8fa043b779c3229f7672 |
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:
32 ;; Pacify byte-compiler.
43 ;;;###tramp-autoload
45 "The minimum size of compressing where inline transfer.
46 When inline transfer, compress transferred data of file
47 whose size is this value or above (up to `tramp-copy-size-limit').
48 If it is nil, no compression at all will be applied."
53 ;;;###tramp-autoload
55 "The maximum file size where inline copying is preferred over an \
56 out-of-the-band copy.
57 If it is nil, out-of-the-band copy will be used without a check."
62 ;;;###tramp-autoload
64 "Value of TERM environment variable for logging in to remote host.
65 Because Tramp wants to parse the output of the remote shell, it is easily
66 confused by ANSI color escape sequences and suchlike. Often, shell init
67 files conditionalize this setup based on the TERM environment variable."
72 ;;;###tramp-autoload
74 "When invoking a shell, override the HISTFILE with this value.
75 When setting to a string, it redirects the shell history to that
79 The value t unsets any setting of HISTFILE, and sets both
80 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
81 however, the *override* is disabled, so the history will go to
90 ;;;###tramp-autoload
94 ;;;###tramp-autoload
98 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
99 ;; root users. It uses the `$' character for other users. In order
100 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
104 "///%s#$"
106 "String used to recognize end of output.
107 The `$' character at the end is quoted; the string cannot be
110 ;;;###tramp-autoload
117 ;;;###tramp-autoload
119 "Whether to use `tramp-ssh-controlmaster-options'."
126 "Which ssh Control* arguments to use.
128 If it is a string, it should have the form
131 spec must be doubled, because the string is used as format string.
133 Otherwise, it will be auto-detected by Tramp, if
134 `tramp-use-ssh-controlmaster-options' is non-nil. The value
135 depends on the installed local ssh version.
139 ;; Initialize `tramp-methods' with the supported methods.
140 ;;;###tramp-autoload
152 ;;;###tramp-autoload
163 ;;;###tramp-autoload
177 ;;;###tramp-autoload
192 ;;;###tramp-autoload
208 ;;;###tramp-autoload
216 ;;;###tramp-autoload
224 ;;;###tramp-autoload
234 ;;;###tramp-autoload
244 ;;;###tramp-autoload
252 ;;;###tramp-autoload
261 ;; We use "-v" for better error tracking.
264 ;; We use "-p" as required for newer busyboxes. For older
265 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
266 ;; can be achieved by tweaking `tramp-connection-properties'.
268 ;;;###tramp-autoload
277 ;;;###tramp-autoload
279 'tramp-methods
286 ;;;###tramp-autoload
290 ;; The password template must be masked. Otherwise, it could be
291 ;; interpreted as password prompt if the remote host echoes the command.
294 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
300 ;;;###tramp-autoload
308 ;;;###tramp-autoload
317 ;;;###tramp-autoload
325 ;;;###tramp-autoload
329 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
333 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
334 tramp-terminal-type
335 tramp-initial-end-of-output))
340 ;;;###tramp-autoload
346 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
347 tramp-terminal-type
348 tramp-initial-end-of-output))
353 ;;;###tramp-autoload
360 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
361 tramp-terminal-type
362 tramp-initial-end-of-output))
372 ;;;###tramp-autoload
379 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
380 tramp-terminal-type
381 tramp-initial-end-of-output))
390 ;;;###tramp-autoload
402 ;;;###tramp-autoload
406 ;;;###tramp-autoload
410 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
411 ;; Do not add "plink" based methods, they ask interactively for the user.
412 ;;;###tramp-autoload
421 ;;;###tramp-autoload
427 ;;;###tramp-autoload
443 ;;;###tramp-autoload
448 ;;;###tramp-autoload
453 ;;;###tramp-autoload
458 ;;;###tramp-autoload
466 ;;;###tramp-autoload
495 ;; "getconf PATH" yields:
496 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
497 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
498 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
499 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
500 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
501 ;; IRIX64: /usr/bin
502 ;; QNAP QTS: ---
503 ;;;###tramp-autoload
509 "List of directories to search for executables on remote host.
510 For every remote host, this variable will be set buffer local,
511 keeping the list of existing directories on that host.
513 You can use `~' in this list, but when searching for a shell which groks
514 tilde expansion, all directory names starting with `~' will be ignored.
516 `Default Directories' represent the list of directories given by
518 entry on head of this list, because these are the default
519 directories for POSIX compatible commands. On remote hosts which
520 do not offer the getconf command (like cygwin), the value
522 the list by the special value `tramp-default-remote-path'.
524 `Private Directories' are the settings of the $PATH environment,
525 as given in your `~/.profile'. This entry is represented in
526 the list by the special value `tramp-own-remote-path'."
534 ;;;###tramp-autoload
539 "List of environment variables to be set on the remote host.
541 Each element should be a string of the form ENVVARNAME=VALUE. An
542 entry ENVVARNAME= disables the corresponding environment variable,
543 which might have been set in the init files like ~/.profile.
545 Special handling is applied to some environment variables,
546 which should not be set here:
548 The PATH environment variable should be set via `tramp-remote-path'.
550 The TERM environment variable should be set via `tramp-terminal-type'.
552 The INSIDE_EMACS environment variable will automatically be set
553 based on the TRAMP and Emacs versions, and should not be set here."
559 ;;;###tramp-autoload
561 "Alist specifying extra arguments to pass to the remote shell.
562 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
563 matching the shell file name and ARGS is a string specifying the
564 arguments.
566 This variable is only used when Tramp needs to start up another shell
567 for tilde expansion. The extra arguments should typically prevent the
568 shell from reading its init file."
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 || -l $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-2018 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-2018 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
968 else
970 fi
973 else
975 fi
976 done
978 "Script to check existence of VC related files.
979 It must be send formatted with two strings; the tests for file
980 existence, and file readability. Input shall be read via
981 here-document, otherwise the command could exceed maximum length
984 ;; New handlers should be added here.
985 ;;;###tramp-autoload
989 ;; `byte-compiler-base-file-name' performed by default handler.
994 ;; `diff-latest-backup-file' performed by default handler.
998 . tramp-sh-handle-directory-files-and-attributes)
1018 ;; `file-name-sans-versions' performed by default handler.
1033 ;; `find-file-noselect' performed by default handler.
1034 ;; `get-file-buffer' performed by default handler.
1040 ;; `make-directory-internal' performed by default handler.
1058 "Alist of handler functions.
1061 ;;; File Name Handler Functions:
1065 "Like `make-symbolic-link' for Tramp files.
1066 If TARGET is a non-Tramp file, it is used verbatim as the target
1067 of the symlink. If TARGET is a Tramp file, only the localname
1068 component is used as the target of the symlink."
1074 ;; If TARGET is a Tramp name, use just the localname component.
1081 ;; If TARGET is still remote, quote it.
1085 linkname ok-if-already-exists)
1092 v 'file-error
1095 ;; Do the 'confirm if exists' thing.
1097 ;; What to do?
1103 "File %s already exists; make it a link anyway? "
1104 localname)))))
1111 ;; Right, they are on the same host, regardless of user,
1112 ;; method, etc. We now make the link on the remote
1113 ;; machine. This will occur as the user that TARGET belongs to.
1118 "%s -sf %s %s" ln
1120 ;; The command could exceed PATH_MAX, so we use
1121 ;; relative file names. However, relative file
1122 ;; names could start with "-".
1123 ;; `tramp-shell-quote-argument' does not handle
1124 ;; this, we must do it ourselves.
1129 "Like `file-truename' for Tramp files."
1131 "%s%s"
1134 method user domain host port
1141 ;; Use GNU readlink --canonicalize-missing where available.
1144 v
1152 ;; Use Perl implementation.
1160 v
1164 ;; Do it yourself.
1168 ;; Don't make the following value larger than
1169 ;; necessary. People expect an error message in a
1170 ;; timely fashion when something is wrong;
1171 ;; otherwise they might think that Emacs is hung.
1172 ;; Of course, correctness has to come first.
1174 symlink-target)
1186 method user domain host port
1198 ;; It's a symlink, follow it.
1208 ;; It's a file.
1212 v 'file-error
1215 ;; Combine list to form string.
1223 ;; Detect cycle.
1227 v 'file-error
1229 ;; If the resulting localname looks remote, we must quote it
1230 ;; for security reasons.
1235 result))))
1237 ;; Preserve trailing "/".
1240 ;; Basic functions.
1243 "Like `file-exists-p' for Tramp files."
1251 v
1253 "%s %s"
1258 "Like `file-attributes' for Tramp files."
1261 ;; Don't modify `last-coding-system-used' by accident.
1268 v
1276 ;; The scripts could fail, for example with huge file size.
1280 "Implement `file-attributes' for Tramp files using the ls(1) command."
1282 res-inode res-filemodes res-numlinks
1283 res-uid res-gid res-size res-symlink-target)
1285 ;; We cannot send all three commands combined, it could exceed
1286 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1288 vec
1293 vec
1298 vec
1302 ;; On systems which have no quoting style, file names
1303 ;; with special characters could fail.
1311 ;; Parse `ls -l' output ...
1315 ;; ... inode
1317 ;; ... file mode flags
1319 ;; ... number links
1321 ;; ... uid and gid
1333 ;; ... size
1335 ;; From the file modes, figure out other stuff.
1338 ;; If symlink, find out file name pointed to.
1345 ;; Return data gathered.
1347 ;; 0. t for directory, string (name linked to) for symbolic
1348 ;; link, or nil.
1350 ;; 1. Number of links to file.
1351 res-numlinks
1352 ;; 2. File uid.
1353 res-uid
1354 ;; 3. File gid.
1355 res-gid
1356 ;; 4. Last access time, as a list of integers. Normally
1357 ;; this would be in the same format as `current-time', but
1358 ;; the subseconds part is not currently implemented, and
1359 ;; (0 0) denotes an unknown time.
1360 ;; 5. Last modification time, likewise.
1361 ;; 6. Last status change time, likewise.
1363 ;; 7. Size in bytes (-1, if number is out of range).
1364 res-size
1365 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1366 res-filemodes
1367 ;; 9. t if file's gid would change if file were deleted and
1368 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1369 t
1370 ;; 10. Inode number.
1371 res-inode
1372 ;; 11. Device number. Will be replaced by a virtual device number.
1377 "Implement `file-attributes' for Tramp files using a Perl script."
1382 vec
1388 "Implement `file-attributes' for Tramp files using stat(1) command."
1391 vec
1394 ;; On Opsware, pdksh (which is the true name of ksh there)
1395 ;; doesn't parse correctly the sequence "((". Therefore, we add
1396 ;; a space. Apostrophes in the stat output are masked as
1397 ;; `tramp-stat-marker', in order to make a proper shell escape of
1398 ;; them in file names.
1399 "( (%s %s || %s -h %s) && (%s -c "
1400 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1407 tramp-stat-marker tramp-stat-marker
1412 tramp-stat-marker tramp-stat-marker
1414 tramp-stat-quoted-marker)))
1417 "Like `set-visited-file-modtime' for Tramp files."
1424 coding-system-used)
1428 ;; '(-1 65535) means file doesn't exists yet.
1432 ;; We use '(0 0) as a don't-know value. See also
1433 ;; `tramp-do-file-attributes-with-ls'.
1438 v
1446 nil)))))
1448 ;; This function makes the same assumption as
1449 ;; `tramp-sh-handle-set-visited-file-modtime'.
1451 "Like `verify-visited-file-modtime' for Tramp files.
1452 At the time `verify-visited-file-modtime' calls this function, we
1453 already know that the buffer is visiting a file and that
1454 `visited-file-modtime' does not return 0. Do not call this
1455 function directly, unless those two cases are already taken care
1456 of."
1459 ;; There is no file visiting the buffer, or the buffer has no
1460 ;; recorded last modification time, or there is no established
1461 ;; connection.
1465 t
1473 ;; File exists, and has a known modtime.
1476 modtime
1477 ;; For compatibility, deal with both the old
1478 ;; (HIGH . LOW) and the new (HIGH LOW) return
1479 ;; values of `visited-file-modtime'.
1482 mt)))
1484 ;; Modtime has the don't know value.
1487 v
1494 attr
1497 ;; If file does not exist, say it is not modified if and
1498 ;; only if that agrees with the buffer's record.
1502 "Like `set-file-modes' for Tramp files."
1506 ;; FIXME: extract the proper text from chmod's stderr.
1508 v
1513 "Like `set-file-times' for Tramp files."
1520 time)))
1523 "env TZ=UTC %s %s %s"
1531 "Set the ownership for FILENAME.
1532 If UID and GID are provided, these values are used; otherwise uid
1533 and gid of the corresponding user is taken. Both parameters must
1534 be non-negative integers."
1535 ;; Modern Unices allow chown only for root. So we might need
1536 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1537 ;; working with su(do)? when it is needed, so it shall succeed in
1538 ;; the majority of cases.
1539 ;; Don't modify `last-coding-system-used' by accident.
1544 ;; If we are root on the local host, we can do it directly.
1552 "chown %d:%d %s" uid gid
1555 ;; We handle also the local part, because there doesn't exist
1556 ;; `set-file-uid-gid'. On W32 "chown" does not work.
1561 nil "chown" nil nil nil
1565 "Check, whether SELINUX is enabled on the remote host."
1570 "Like `file-selinux-context' for Tramp files."
1579 "%s -d -Z %s"
1587 ;; Return the context.
1588 context))))
1591 "Like `set-file-selinux-context' for Tramp files."
1610 t)))))
1613 "Check, whether ACL is enabled on the remote host."
1618 "Like `file-acl' for Tramp files."
1624 "getfacl -ac %s"
1633 "Like `set-file-acl' for Tramp files."
1640 tramp-end-of-heredoc
1641 acl-string
1642 tramp-end-of-heredoc))
1644 ;; Success.
1647 t)
1648 ;; In case of errors, we return nil.
1650 nil)))
1652 ;; Simple functions using the `test' command.
1655 "Like `file-executable-p' for Tramp files."
1658 ;; Examine `file-attributes' cache to see if request can be
1659 ;; satisfied without remote operation.
1664 "Like `file-readable-p' for Tramp files."
1667 ;; Examine `file-attributes' cache to see if request can be
1668 ;; satisfied without remote operation.
1672 ;; When the remote shell is started, it looks for a shell which groks
1673 ;; tilde expansion. Here, we assume that all shells which grok tilde
1674 ;; expansion will also provide a `test' command which groks `-nt' (for
1675 ;; newer than). If this breaks, tell me about it and I'll try to do
1676 ;; something smarter about it.
1678 "Like `file-newer-than-file-p' for Tramp files."
1680 nil)
1682 t)
1683 ;; We are sure both files exist at this point.
1686 ;; We try to get the mtime of both files. If they are not
1687 ;; equal to the "dont-know" value, then we subtract the times
1688 ;; and obtain the result.
1701 ;; If one of them is the dont-know value, then we can
1702 ;; still try to run a shell command on the remote host.
1703 ;; However, this only works if both files are Tramp
1704 ;; files and both have the same method, same user, same
1705 ;; host.
1710 v 'file-error
1711 "Files %s and %s must have same method, user, host"
1712 file1 file2)))
1717 ;; Functions implemented using the basic functions above.
1720 "Like `file-directory-p' for Tramp files."
1722 ;; `file-directory-p' is used as predicate for file name completion.
1723 ;; Sometimes, when a connection is not established yet, it is
1724 ;; desirable to return t immediately for "/method:foo:". It can
1725 ;; be expected that this is always a directory.
1731 "Like `file-writable-p' for Tramp files."
1735 ;; Examine `file-attributes' cache to see if request can be
1736 ;; satisfied without remote operation.
1739 ;; If file doesn't exist, check if directory is writable.
1744 "Like `file-ownership-preserved-p' for Tramp files."
1748 ;; Return t if the file doesn't exist, since it's true that no
1749 ;; information would be lost by an (attempted) delete and create.
1758 ;; Directory listings.
1762 "Like `directory-files-and-attributes' for Tramp files."
1770 v localname
1781 v localname id-format))
1784 v localname id-format))
1786 result item)
1796 result
1798 ;; The scripts could fail, for example with huge file size.
1800 directory full match nosort id-format)))))
1804 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1807 vec tramp-perl-directory-files-and-attributes
1811 vec
1815 object))
1819 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1822 vec
1825 ;; We must care about file names with spaces, or starting with
1826 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1827 ;; but it does not work on all remote systems. Apostrophes in
1828 ;; the stat output are masked as `tramp-stat-marker', in order to
1829 ;; make a proper shell escape of them in file names.
1831 "xargs %s -c "
1832 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1836 ;; On systems which have no quoting style, file names with special
1837 ;; characters could fail.
1845 tramp-stat-marker tramp-stat-marker
1846 tramp-stat-marker tramp-stat-marker
1851 tramp-stat-marker tramp-stat-marker
1852 tramp-stat-quoted-marker)))
1854 ;; This function should return "foo/" for directories and "bar" for
1855 ;; files.
1857 "Like `file-name-all-completions' for Tramp files."
1860 filename
1864 ;; Get a list of directories and files, including reliably
1865 ;; tagging the directories with a trailing "/". Because I
1866 ;; rock. --daniel@danann.net
1868 v
1872 v tramp-perl-file-name-all-completions
1878 "(cd %s 2>&1 && %s -a 2>/dev/null"
1879 " | while IFS= read f; do"
1887 ;; Now grab the output.
1891 ;; Check result code, found in last line of output.
1895 ;; Grab error message from line before last line
1896 ;; (it was put there by `cd 2>&1').
1899 v 'file-error
1900 "tramp-sh-handle-file-name-all-completions: %s"
1902 ;; For peace of mind, if buffer doesn't end in `fail'
1903 ;; then it should end in `ok'. If neither are in the
1904 ;; buffer something went seriously wrong on the remote
1905 ;; side.
1909 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1914 result))))))
1916 ;; cp, mv and ln
1920 "Like `add-name-to-file' for Tramp files."
1925 v 'file-error
1926 "add-name-to-file: %s"
1932 ;; Do the 'confirm if exists' thing.
1934 ;; What to do?
1939 "File %s already exists; make it a link anyway? "
1940 v2-localname)))))
1946 v1
1950 "error with add-name-to-file, see buffer `%s' for details"
1955 preserve-uid-gid preserve-extended-attributes)
1956 "Like `copy-file' for Tramp files."
1962 'copy filename newname ok-if-already-exists keep-date
1963 preserve-uid-gid preserve-extended-attributes)
1965 'copy-file
1967 preserve-uid-gid preserve-extended-attributes))))
1971 "Like `copy-directory' for Tramp files."
1977 ;; When DIRNAME and NEWNAME are remote, they must have
1978 ;; the same method.
1984 ;; scp or rsync DTRT.
2002 ;; We must do it file-wise.
2004 'copy-directory
2007 ;; When newname did exist, we have wrong cached values.
2015 "Like `rename-file' for Tramp files."
2016 ;; Check if both files are local -- invoke normal rename-file.
2017 ;; Otherwise, use Tramp from local system.
2020 ;; At least one file a Tramp file?
2024 'rename filename newname ok-if-already-exists
2031 preserve-uid-gid preserve-extended-attributes)
2032 "Copy or rename a remote file.
2033 OP must be `copy' or `rename' and indicates the operation to perform.
2034 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2035 the new file (for copy) or the new name of the file (for rename).
2036 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2037 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2038 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2039 the uid and gid if both files are on the same host.
2040 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2042 This function is invoked by `tramp-sh-handle-copy-file' and
2043 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2044 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2045 file names."
2058 ;; `file-extended-attributes' exists since Emacs 24.4.
2069 filename newname)
2072 ;; Both are Tramp files.
2077 ;; Shortcut: if method, host, user are the same for
2078 ;; both files, we invoke `cp' or `mv' on the remote
2079 ;; host directly.
2082 op filename newname
2083 ok-if-already-exists keep-date preserve-uid-gid))
2085 ;; Try out-of-band operation.
2090 op filename newname keep-date))
2092 ;; No shortcut was possible. So we copy the file
2093 ;; first. If the operation was `rename', we go back
2094 ;; and delete the original file (if the copy was
2095 ;; successful). The approach is simple-minded: we
2096 ;; create a new buffer, insert the contents of the
2097 ;; source file into it, then write out the buffer to
2098 ;; the target file. The advantage is that it doesn't
2099 ;; matter which file name handlers are used for the
2100 ;; source and target file.
2103 op filename newname keep-date))))))
2105 ;; One file is a Tramp file, the other one is local.
2108 ;; Fast track on local machine.
2111 op filename newname
2112 ok-if-already-exists keep-date preserve-uid-gid))
2114 ;; If the Tramp file has an out-of-band method, the
2115 ;; corresponding copy-program can be invoked.
2118 op filename newname keep-date))
2120 ;; Use the inline method via a Tramp buffer.
2122 op filename newname keep-date))))
2125 ;; One of them must be a Tramp file.
2128 ;; Handle `preserve-extended-attributes'. We ignore possible
2129 ;; errors, because ACL strings could be incompatible.
2134 ;; In case of `rename', we must flush the cache of the source file.
2141 ;; When newname did exist, we have wrong cached values.
2149 "Use an Emacs buffer to copy or rename a file.
2150 First arg OP is either `copy' or `rename' and indicates the operation.
2151 FILENAME is the source file, NEWNAME the target file.
2152 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2153 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2154 ;; and `find-file-noselect', but that's not called here.
2158 ;; We must disable multibyte, because binary data shall not be
2159 ;; converted. We don't want the target file to be compressed, so we
2160 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2161 ;; be called either. We remove `tramp-file-name-handler' from
2162 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2163 ;; `insert-file-contents' might be deactivated in some corner cases.
2174 ;; KEEP-DATE handling.
2177 newname
2180 ;; Set the mode.
2182 ;; If the operation was `rename', delete the original file.
2187 "Invokes `cp' or `mv' on the remote system.
2188 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2189 respectively. FILENAME specifies the file to copy or rename,
2190 NEWNAME is the name of the new file (for copy) or the new name of
2191 the file (for rename). Both files must reside on the same host.
2192 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2193 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2194 the uid and gid from FILENAME."
2205 v 'file-error
2206 "Unknown operation `%s', must be `copy' or `rename'"
2207 op))))
2211 cmd-result)
2214 ;; Both files are on a remote host, with same user.
2226 ;; Mask cp -f error.
2228 tramp-operation-not-permitted-regexp nil t))
2229 cmd-result)
2231 nil v 'file-error
2232 "Copying directly failed, see buffer `%s' for details."
2235 ;; We are on the local host.
2238 ;; We can do it directly.
2241 ;; No sticky bit when renaming.
2252 localname1 localname2 ok-if-already-exists
2253 keep-date preserve-uid-gid)
2257 ;; We can do it directly with `tramp-send-command'
2265 ok-if-already-exists keep-date t)
2266 ;; We must change the ownership to the local user.
2272 ;; We need a temporary file in between.
2274 ;; Create the temporary file.
2282 "%s %s %s" cmd
2285 "Copying directly failed, see buffer `%s' for details."
2287 ;; We must change the ownership as remote user.
2288 ;; Since this does not work reliable, we also
2289 ;; give read permissions.
2299 localname1 tmpfile t keep-date preserve-uid-gid)
2302 ;; We must change the ownership as local user.
2303 ;; Since this does not work reliable, we also
2304 ;; give read permissions.
2307 tmpfile
2311 ;; Move the temporary file to its destination.
2316 "cp -f -p %s %s"
2319 "Copying directly failed, see buffer `%s' for details."
2323 'rename-file
2326 ;; Save exit.
2329 ;; Set the time and mode. Mask possible errors.
2336 "Invoke `scp' program to copy.
2337 The method used must be an out-of-band method."
2341 copy-program copy-args copy-env copy-keep-date listener spec
2342 options source target remote-copy-program remote-copy-args)
2347 ;; Both are Tramp files. We shall optimize it when the
2348 ;; methods for FILENAME and NEWNAME are the same.
2358 op filename tmpfile keep-date)
2361 ;; Save exit.
2368 ;; Check which ones of source and target are Tramp files.
2372 'file-name-as-directory
2381 ;; Check for user. There might be an interactive setting.
2385 ;; Check for listener port.
2392 ;; Compose copy command.
2401 ?h host ?u user ?p port ?r listener ?c options
2407 copy-args
2409 ;; " " has either been a replacement of "%k" (when
2410 ;; keep-date argument is non-nil), or a replacement
2411 ;; for the whole keep-date sublist.
2412 " "
2417 copy-args
2421 copy-env
2423 nil
2430 remote-copy-program
2436 remote-copy-args
2440 ;; Check for local copy program.
2445 ;; Install listener on the remote side. The prompt must be
2446 ;; consumed later on, when the process does not listen anymore.
2453 v 'file-error
2457 'identity
2465 v 'file-error
2466 "Listener process not running on remote host: `%s'"
2467 remote-copy-program))
2475 ;; The default directory must be remote.
2479 ;; We do not want to run timers.
2480 timer-list timer-idle-list)
2481 ;; Set the transfer process properties.
2491 copy-args
2493 copy-args
2498 ;; Use an asynchronous process. By this, password can
2499 ;; be handled. We don't set a timeout, because the
2500 ;; copying of large files can last longer than 60 secs.
2510 command))))
2516 ;; We must adapt `tramp-local-end-of-line' for
2517 ;; sending the password.
2520 p v nil tramp-actions-copy-out-of-band))))
2522 ;; Reset the transfer process properties.
2525 ;; Clear the remote prompt.
2528 ;; Houston, we have a problem! Likely, the listener is
2529 ;; still running, so let's clear everything (but the
2530 ;; cached password).
2533 ;; Handle KEEP-DATE argument.
2536 newname
2540 ;; Set the mode.
2545 ;; If the operation was `rename', delete the original file.
2552 "Like `make-directory' for Tramp files."
2564 "Like `delete-directory' for Tramp files."
2577 "Like `delete-file' for Tramp files."
2588 ;; Dired.
2591 "Like `dired-compress-file' for Tramp files."
2592 ;; Code stolen mainly from dired-aux.el.
2597 suffix)
2598 ;; See if any suffix rule matches this file name.
2606 nil)
2608 ;; We found an uncompression rule.
2618 ;; We don't recognize the file as compressed, so compress it.
2619 ;; Try gzip.
2633 "Like `insert-directory' for Tramp files."
2640 filename switches wildcard full-directory-p)
2662 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2663 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2666 v
2669 switches
2671 localname
2674 v
2678 "Couldn't `cd %s'"
2682 v
2685 switches
2690 ""
2698 ;; We cannot use `insert-buffer-substring' because the Tramp
2699 ;; buffer changes its contents before insertion due to calling
2700 ;; `expand-file-name' and alike.
2705 ;; Check for "--dired" output.
2712 ;; Now read the numeric positions of file names.
2718 ;; End is followed by \n or by " -> ".
2720 ;; Remove trailing lines.
2726 ;; Some busyboxes are reluctant to discard colors.
2734 ;; Decode the output, it could be multibyte.
2739 ;; The inserted file could be from somewhere else.
2746 "."
2751 ;; Try to insert the amount of free space.
2753 ;; First find the line to put it on.
2757 ;; Replace "total" with "total used", to avoid confusion.
2764 ;; Canonicalization of file names.
2767 "Like `expand-file-name' for Tramp files.
2769 the result will be a local, non-Tramp, file name."
2770 ;; If DIR is not given, use `default-directory' or "/".
2772 ;; Unless NAME is absolute, concat DIR and NAME.
2775 ;; If connection is not established yet, run the real handler.
2778 ;; Dissect NAME.
2782 ;; Tilde expansion if necessary. This needs a shell which
2783 ;; groks tilde expansion! The function `tramp-find-shell' is
2784 ;; supposed to find such a shell on the remote host. Please
2785 ;; tell me about it when this doesn't work on your system.
2789 ;; We cannot simply apply "~/", because under sudo "~/" is
2790 ;; expanded to the local user home directory but to the
2791 ;; root home directory. On the other hand, using always
2792 ;; the default user name for tilde expansion is not
2793 ;; appropriate either, because ssh and companions might
2794 ;; use a user name from the config file.
2806 ;; There might be a double slash, for example when "~/"
2807 ;; expands to "/". Remove this.
2810 ;; No tilde characters in file name, do normal
2811 ;; `expand-file-name' (this does "/./" and "/../").
2812 ;; `default-directory' is bound, because on Windows there would
2813 ;; be problems with UNC shares or Cygwin mounts.
2816 method user domain host port
2820 hop)))))
2822 ;;; Remote commands:
2825 "Flush file caches."
2833 ;; We use BUFFER also as connection buffer during setup. Because of
2834 ;; this, its original contents must be saved, and restored once
2835 ;; connection has been setup.
2837 "Like `start-file-process' for Tramp files."
2842 ;; BUFFER can be nil. We use a temporary buffer.
2844 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2845 ;; it might be that the arguments exceed the command line
2846 ;; length. Therefore, we modify the command.
2851 ;; When PROGRAM is nil, we just provide a tty.
2857 args
2861 ;; Use a human-friendly prompt, for example for `shell'.
2862 ;; We discard hops, if existing, that's why we cannot use
2863 ;; `file-remote-p'.
2866 tramp-initial-end-of-output))
2867 ;; We use as environment the difference to toplevel
2868 ;; `process-environment'.
2869 env uenv
2883 "unset %s &&"
2898 ;; We do not want to raise an error when
2899 ;; `start-file-process' has been started several times in
2900 ;; `eshell' and friends.
2901 tramp-current-connection
2902 ;; We do not want to run timers.
2903 timer-list timer-idle-list
2904 p)
2907 ;; NAME must be unique as process name.
2911 ;; Set the new process properties.
2917 ;; We catch this event. Otherwise, `start-process' could
2918 ;; be called on the local host.
2921 ;; Activate narrowing in order to save BUFFER
2922 ;; contents. Clear also the modification time;
2923 ;; otherwise we might be interrupted by
2924 ;; `verify-visited-file-modtime'.
2930 ;; We call `tramp-maybe-open-connection', in order
2931 ;; to cleanup the prompt afterwards.
2935 ;; Set the pid of the remote shell. This is
2936 ;; needed when sending signals remotely.
2943 ;; Now do it.
2945 ;; Send the command.
2947 ;; Check, whether a pty is associated.
2950 v 'file-error
2952 ;; Set query flag and process marker for this
2953 ;; process. We ignore errors, because the process
2954 ;; could have finished already.
2958 ;; Return process.
2959 p)))
2961 ;; Save exit.
2972 "Like `process-file' for Tramp files."
2973 ;; The implementation is not complete yet.
2979 ;; Compute command.
2982 ;; We use as environment the difference to toplevel `process-environment'.
2993 "env %s %s"
2998 "unset %s && %s"
3000 ;; Determine input.
3005 ;; INFILE is on the same remote host.
3007 ;; INFILE must be copied to remote host.
3009 tmpinput
3014 ;; Determine output.
3016 ;; Just a buffer.
3019 ;; A buffer name.
3022 ;; (REAL-DESTINATION ERROR-DESTINATION)
3024 ;; output.
3032 ;; stderr.
3037 ;; stderr is on the same remote host.
3040 ;; stderr must be copied to remote host. The temporary
3041 ;; file must be deleted after execution.
3044 method user domain host port stderr))))
3045 ;; stderr to be discarded.
3048 ;; 't
3053 ;; Send the command. It might not return in time, so we protect
3054 ;; it. Call it in a subshell, in order to preserve working
3055 ;; directory.
3062 command)
3063 t t)
3065 ;; We should add the output anyway.
3072 ;; When the user did interrupt, we should do it also. We use
3073 ;; return code -1 as marker.
3077 ;; Handle errors.
3082 ;; Provide error file.
3085 ;; Cleanup. We remove all file cache values for the connection,
3086 ;; because the remote process could have changed them.
3092 ;; Return exit status.
3095 ret))))
3098 "Like `file-local-copy' for Tramp files."
3102 v tramp-file-missing
3113 ;; `copy-file' handles direct copy and out-of-band methods.
3118 ;; Use inline encoding for file transfer.
3122 v 3
3124 filename rem-enc)
3131 tmpfile loc-dec)
3133 ;; If local decoding is a function, we call it.
3134 ;; We must disable multibyte, because
3135 ;; `uudecode-decode-region' doesn't handle it
3136 ;; correctly. Unset `file-name-handler-alist'.
3137 ;; Otherwise, epa-file gets confused.
3145 ;; If tramp-decoding-function is not defined for this
3146 ;; method, we invoke tramp-decoding-command instead.
3148 ;; Unset `file-name-handler-alist'. Otherwise,
3149 ;; epa-file gets confused.
3157 loc-dec tmpfile2 tmpfile)
3160 ;; Set proper permissions.
3162 ;; Set local user ownership.
3165 ;; Oops, I don't know what to do.
3169 ;; Error handling.
3175 tmpfile)))
3177 ;; CCC grok LOCKNAME
3180 "Like `write-region' for Tramp files."
3198 ;; `file-writable-p' calls `file-expand-file-name'. We
3199 ;; cannot use `tramp-run-real-handler' therefore.
3205 ;; Short track: if we are on the local host, we can run directly.
3210 ;; We use this to save the value of
3211 ;; `last-coding-system-used' after writing the tmp
3212 ;; file. At the end of the function, we set
3213 ;; `last-coding-system-used' to this saved value. This
3214 ;; way, any intermediary coding systems used while
3215 ;; talking to the remote shell or suchlike won't hose
3216 ;; this variable. This approach was snarfed from
3217 ;; ange-ftp.el.
3218 coding-system-used
3219 ;; Write region into a tmp file. This isn't really
3220 ;; needed if we use an encoding function, but currently
3221 ;; we use it always because this makes the logic
3222 ;; simpler. We must also set `temporary-file-directory',
3223 ;; because it could point to a remote directory.
3229 ;; If `append' is non-nil, we copy the file locally, and let
3230 ;; the native `write-region' implementation do the job.
3233 ;; We say `no-message' here because we don't want the
3234 ;; visited file modtime data to be clobbered from the temp
3235 ;; file. We call `set-visited-file-modtime' ourselves later
3236 ;; on. We must ensure that `file-coding-system-alist'
3237 ;; matches `tmpfile'.
3243 'write-region
3250 ;; Now, `last-coding-system-used' has the right value. Remember it.
3253 ;; The permissions of the temporary file should be set. If
3254 ;; FILENAME does not exist (eq modes nil) it has been
3255 ;; renamed to the backup file. This case `save-buffer'
3256 ;; handles permissions.
3257 ;; Ensure that it is still readable.
3260 tmpfile
3263 ;; This is a bit lengthy due to the different methods
3264 ;; possible for file transfer. First, we check whether the
3265 ;; method uses an scp program. If so, we call it.
3266 ;; Otherwise, both encoding and decoding command must be
3267 ;; specified. However, if the method _also_ specifies an
3268 ;; encoding function, then that is used for encoding the
3269 ;; contents of the tmp file.
3275 ;; `copy-file' handles direct copy and out-of-band methods.
3285 ;; We keep the local file for performance
3286 ;; reasons, useful for "rsync".
3293 ;; Don't rename, in order to keep context in SELinux.
3298 ;; Use inline file transfer.
3300 ;; Encode tmpfile.
3304 ;; Use encoding function or command.
3307 "Encoding local file `%s' using `%s'"
3308 tmpfile loc-enc)
3310 ;; The following `let' is a workaround for
3311 ;; the base64.el that comes with pgnus-0.84.
3312 ;; If both of the following conditions are
3313 ;; satisfied, it tries to write to a local
3314 ;; file in default-directory, but at this
3315 ;; point, default-directory is remote.
3316 ;; (`call-process-region' can't write to
3317 ;; remote files, it seems.) The file in
3318 ;; question is a tmp file anyway.
3326 loc-enc tmpfile t))
3328 v 'file-error
3331 filename loc-enc))))
3333 ;; Send buffer into remote decoding command which
3334 ;; writes to remote file. Because this happens on
3335 ;; the remote host, we cannot use the function.
3338 "Decoding remote file `%s' using `%s'"
3339 filename rem-dec)
3343 v
3347 tramp-end-of-heredoc
3349 tramp-end-of-heredoc))
3351 v nil
3352 "Couldn't write region to `%s', decode using `%s' failed"
3353 filename rem-dec)
3354 ;; When `file-precious-flag' is set, the region is
3355 ;; written to a temporary file. Check that the
3356 ;; checksum is equal to that from the local tmpfile.
3360 ;; cksum runs locally, if possible.
3362 ;; cksum runs remotely.
3364 v
3367 ;; ... they are different.
3374 v 'file-error
3377 filename rem-dec)))))
3379 ;; Save exit.
3382 ;; That's not expected.
3385 v 'file-error
3388 method))))
3390 ;; Make `last-coding-system-used' have the right value.
3397 ;; We must protect `last-coding-system-used', now we have set it
3398 ;; to its correct value.
3400 ;; Set file modification time.
3404 ;; We must pass modtime explicitly, because FILENAME can
3405 ;; be different from (buffer-file-name), f.e. if
3406 ;; `file-precious-flag' is set.
3412 ;; Set the ownership.
3423 ;; VC backends check for the existence of various different special
3424 ;; files. This is very time consuming, because every single check
3425 ;; requires a remote command (the file cache must be invalidated).
3426 ;; Therefore, we apply a kind of optimization. We install the file
3427 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3428 ;; remembers all file names for which `file-exists-p' or
3429 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3430 ;; is performed. Afterwards, a script is applied for all collected
3431 ;; file names, using just one remote command. The result of this
3432 ;; script is used to fill the file cache with actual values. Now we
3433 ;; can reset the file name handlers, and we make a second run of
3434 ;; `vc-registered', which returns the expected result without sending
3435 ;; any other remote command.
3437 "Like `vc-registered' for Tramp files."
3443 ;; There could be new files, created by the vc backend. We
3444 ;; cannot reuse the old cache entries, therefore. In
3445 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3446 ;; could also be a timestamp as `current-time' returns. This
3447 ;; means invalidate all cache entries with an older timestamp.
3453 ;; Here we collect only file names, which need an operation.
3455 v "Error in 1st pass of `vc-registered': %s"
3459 ;; Send just one command, in order to fill the cache.
3462 v
3471 ;; We cannot use `tramp-send-command-and-read',
3472 ;; because this does not cooperate well with
3473 ;; heredoc documents.
3475 v
3478 tramp-end-of-heredoc
3480 tramp-vc-registered-file-names
3482 tramp-end-of-heredoc))
3484 ;; Read the expression.
3491 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3492 ;; calls shall be answered from the file cache. We unset
3493 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3494 ;; in order to keep the cache.
3496 remote-file-name-inhibit-cache process-file-side-effects)
3497 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3516 ;; Run.
3518 v "Error in 2nd pass of `vc-registered': %s"
3521 ;;;###tramp-autoload
3523 "Invoke remote-shell Tramp file name handler.
3524 Fall back to normal file name handler if no Tramp handler exists."
3530 ;; This must be the last entry, because `identity' always matches.
3531 ;;;###tramp-autoload
3536 "Invoke special file name handler, which collects files to be handled."
3544 ;; That's what we want: file names, for which checks are
3545 ;; applied. We assume that VC uses only `file-exists-p' and
3546 ;; `file-readable-p' checks; otherwise we must extend the
3547 ;; list. We do not perform any action, but return nil, in
3548 ;; order to keep `vc-registered' running.
3551 nil)
3552 ;; `process-file' and `start-file-process' shall be ignored.
3555 ;; Tramp file name handlers like `expand-file-name'. They
3556 ;; must still work.
3558 ;; Default file name handlers, we don't care.
3562 "Like `file-notify-add-watch' for Tramp files."
3566 command events filter p sequence)
3568 ;; "inotifywait".
3571 events
3581 ;; Make events a list of symbols.
3582 events
3586 ;; "gio monitor".
3589 events
3593 attribute-changed))
3598 ;; "gvfs-monitor-dir".
3601 events
3605 attribute-changed))
3610 ;; None.
3612 v 'file-notify-error
3613 "No file notification program found on %s"
3615 ;; Start process.
3617 'start-file-process
3621 sequence))
3622 ;; Return the process object as watch-descriptor.
3625 v 'file-notify-error
3626 "`%s' failed to start on remote host"
3630 ;; Needed for process filter.
3635 ;; There might be an error if the monitor is not supported.
3636 ;; Give the filter a chance to read the output.
3641 p))))
3654 ;; Fix action names.
3661 ;; https://bugs.launchpad.net/bugs/1742946
3670 string)
3676 proc
3679 ;; File names are returned as absolute paths. We must
3680 ;; add the remote prefix.
3684 ;; Remove watch when file or directory to be watched is deleted.
3688 ;; Usually, we would add an Emacs event now. Unfortunately,
3689 ;; `unread-command-events' does not accept several events at
3690 ;; once. Therefore, we apply the handler directly.
3693 'file-notify-handle-event
3696 ;; Save rest of the string.
3703 file-notify events."
3713 ;; Attribute change is returned in unused wording.
3723 string)
3728 proc
3733 ;; File names are returned as absolute paths. We must
3734 ;; add the remote prefix.
3738 ;; Remove watch when file or directory to be watched is deleted.
3742 ;; Usually, we would add an Emacs event now. Unfortunately,
3743 ;; `unread-command-events' does not accept several events at
3744 ;; once. Therefore, we apply the handler directly.
3747 'file-notify-handle-event
3750 ;; Save rest of the string.
3760 ;; Check, whether there is a problem.
3765 line)
3770 proc
3777 ;; Remove watch when file or directory to be watched is deleted.
3780 ;; Usually, we would add an Emacs event now. Unfortunately,
3781 ;; `unread-command-events' does not accept several events at
3782 ;; once. Therefore, we apply the handler directly.
3785 'file-notify-handle-event
3789 "Like `file-system-info' for Tramp files."
3796 "%s --block-size=1 --output=size,used,avail %s"
3806 ;; The second value is the used size. We need the
3807 ;; free size.
3812 ;;; Internal Functions:
3815 "Define in remote shell function NAME implemented as SCRIPT.
3816 Only send the definition if it has not already been done."
3817 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3818 ;; might be nil.
3824 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3825 ;; could result in unwanted command expansion. Avoid this.
3828 ;; The script could contain a call of Perl. This is masked with `%s'.
3833 vec
3841 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3842 Returns the exit code of the `test' program."
3845 v
3847 "%s %s %s"
3849 switch
3853 "Run `test'-like program on the remote system, given FILE1, FILE2.
3854 FORMAT-STRING contains the program name, switches, and place holders.
3855 Returns the exit code of the `test' program. Barfs if the methods,
3856 hosts, or files, disagree."
3860 v 'file-error
3865 v1
3872 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3873 First arg VEC specifies the connection, PROGNAME is the program
3874 to search for, and DIRLIST gives the list of directories to
3875 search. If IGNORE-TILDE is non-nil, directory names starting
3876 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3877 only in DIRLIST.
3879 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3881 This function expects to be in the right *tramp* buffer."
3884 ;; Check whether the executable is in $PATH. "which(1)" does not
3885 ;; report always a correct error code; therefore we check the
3886 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3887 ;; 5.11") have problems with this command, we disable the call
3888 ;; therefore.
3899 ;; Remove all ~/foo directories from dirlist.
3908 vec
3910 "do if test -x $d/%s && test -f $d/%s; "
3911 "then echo tramp_executable $d/%s; "
3914 progname progname progname
3915 tramp-end-of-heredoc
3917 tramp-end-of-heredoc))
3923 result)))
3926 "Sets the remote environment PATH to existing directories.
3927 I.e., for each directory in `tramp-remote-path', it is tested
3928 whether it exists and if so, it is added to the environment
3929 variable PATH."
3935 ;; ------------------------------------------------------------
3936 ;; -- Communication with external shell --
3937 ;; ------------------------------------------------------------
3940 "Find a command on the remote host for checking if a file exists.
3941 Here, we are looking for a command which has zero exit status if the
3942 file exists and nonzero exit status otherwise."
3946 result)
3947 ;; The algorithm is as follows: we try a list of several commands.
3948 ;; For each command, we first run `$cmd /' -- this should return
3949 ;; true, as the root directory always exists. And then we run
3950 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3951 ;; does not exist. This should return false. We use the first
3952 ;; command we find that seems to work.
3953 ;; The list of commands to try is as follows:
3954 ;; `ls -d' This works on most systems, but NetBSD 1.4
3955 ;; has a bug: `ls' always returns zero exit
3956 ;; status, even for files which don't exist.
3957 ;; `test -e' Some Bourne shells have a `test' builtin
3958 ;; which does not know the `-e' option.
3959 ;; `/bin/test -e' For those, the `test' binary on disk normally
3960 ;; provides the option. Alas, the binary
3961 ;; is sometimes `/bin/test' and sometimes it's
3962 ;; `/usr/bin/test'.
3963 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3991 result))
3994 "Opens shell SHELL."
3997 ;; Find arguments for this shell.
3999 item extra-args)
4004 ;; It is useful to set the prompt in the following command
4005 ;; because some people have a setting for $PS1 which /bin/sh
4006 ;; doesn't know about and thus /bin/sh will display a strange
4007 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4008 ;; ksh will display the current working directory but /bin/sh
4009 ;; will display a dollar sign. The following command line sets
4010 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4011 ;; well as csh-like shells. We also unset the variable $ENV
4012 ;; because that is read by some sh implementations (eg, bash
4013 ;; when called as sh) on startup; this way, we avoid the startup
4014 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4015 ;; the prompt in /bin/bash, it must be discarded as well.
4016 ;; $HISTFILE is set according to `tramp-histfile-override'.
4017 ;; $TERM and $INSIDE_EMACS set here to ensure they have the
4018 ;; correct values when the shell starts, not just processes
4019 ;; run within the shell. (Which processes include our
4020 ;; initial probes to ensure the remote shell is usable.)
4024 "exec env TERM='%s' INSIDE_EMACS='%s,tramp:%s' "
4026 tramp-terminal-type
4027 emacs-version tramp-version ; INSIDE_EMACS
4033 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4037 t)
4038 ;; Check proper HISTFILE setting. We give up when not working.
4042 vec
4044 "(cd %s)"
4047 "`tramp-histfile-override' uses invalid file `%s'"
4048 tramp-histfile-override)))
4054 "Opens a shell on the remote host which groks tilde expansion."
4057 shell)
4060 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4061 ;; Which check could we apply instead?
4064 ;; The default shell (ksh93) of OpenSolaris and
4065 ;; Solaris is buggy. We've got reports for
4066 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4075 ;; Maybe it works at least for some other commands.
4077 default-shell
4079 vec 2
4081 "Couldn't find a remote shell which groks tilde "
4083 default-shell)))
4085 default-shell)))
4087 ;; Open a new shell if needed.
4093 ;; Utility functions.
4096 "Wait for shell prompt and barf if none appears.
4097 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4098 seconds. If not, it produces an error message with the given ERROR-ARGS."
4102 proc timeout
4111 "Set up an interactive shell.
4112 Mainly sets the prompt and the echo correctly. PROC is the shell
4113 process to set up. VEC specifies the connection."
4118 ;; Disable echo expansion.
4122 ;; Check whether the echo has really been disabled. Some
4123 ;; implementations, like busybox of embedded GNU/Linux, don't
4124 ;; support disabling.
4131 ;; Make sure backspaces and their echo are enabled and no line
4132 ;; width magic interferes with them.
4139 t)
4141 ;; Check whether the output of "uname -sr" has been changed. If
4142 ;; yes, this is a strong indication that we must expire all
4143 ;; connection properties. We start again with
4144 ;; `tramp-maybe-open-connection', it will be caught there.
4149 vec "uname"
4153 vec 3
4154 "Connection reset, because remote host changed from `%s' to `%s'"
4155 old-uname uname)
4156 ;; We want to keep the password.
4160 ;; Try to set up the coding system correctly.
4161 ;; CCC this can't be the right way to do it. Hm.
4164 ;; Use MULE to select the right EOL convention for communicating
4165 ;; with the process.
4171 cs-decode cs-encode)
4175 cs-encode
4182 ;; Special setting for macOS.
4193 ;; Check whether the remote host suffers from buggy
4194 ;; `send-process-string'. This is known for FreeBSD (see comment
4195 ;; in `send_process', file process.c). I've tested sending 624
4196 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4197 ;; hack when this host type is detected locally. It cannot handle
4198 ;; remote hosts, though.
4202 tramp-chunksize)
4208 ;; Set remote PATH variable.
4211 ;; Search for a good shell before searching for a command which
4212 ;; checks if a file exists. This is done because Tramp wants to
4213 ;; use "test foo; echo $?" to check if various conditions hold,
4214 ;; and there are buggy /bin/sh implementations which don't execute
4215 ;; the "echo $?" part if the "test" part has an error. In
4216 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4217 ;; also other problems with /bin/sh of OpenSolaris, like
4218 ;; redirection of stderr in function declarations, or changing
4219 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4220 ;; by bash, when detected.
4223 ;; Disable unexpected output.
4226 ;; IRIX64 bash expands "!" even when in single quotes. This
4227 ;; destroys our shell functions, we must disable it. See
4228 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4232 ;; Disable tab expansion.
4237 ;; Set utf8 encoding. Needed for macOS, for example. This is
4238 ;; non-POSIX, so we must expect errors on some systems.
4241 ;; Set `remote-tty' process property.
4247 ;; Dump stty settings in the traces.
4251 ;; Set the environment.
4265 vec
4268 tramp-end-of-heredoc
4270 tramp-end-of-heredoc)
4271 t))
4276 ;; Old text from documentation of tramp-methods:
4277 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4278 ;; of the base64 methods instead since base64 encoding is much more
4279 ;; reliable and the commands are more standardized between the different
4280 ;; Unix versions. But if you can't use base64 for some reason, please
4281 ;; note that the default uudecode command does not work well for some
4282 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4283 ;; the following command for uudecode:
4284 ;;
4285 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4286 ;;
4287 ;; For Irix, no solution is known yet.
4295 "List of local coding commands for inline transfer.
4296 Each item is a list that looks like this:
4298 \(FORMAT ENCODING DECODING)
4300 FORMAT is symbol describing the encoding/decoding format. It can be
4301 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4303 ENCODING and DECODING can be strings, giving commands, or symbols,
4304 giving functions. If they are strings, then they can contain
4306 file name will be put into the command line at that spot. If the
4307 specifier is not present, the input should be read from standard
4308 input.
4310 If they are functions, they will be called with two arguments, start
4311 and end of region, and are expected to replace the region contents
4316 ;; "-i" is more robust with older base64 from GNU coreutils.
4317 ;; However, I don't know whether all base64 versions do supports
4318 ;; this option.
4326 ;; This is painful slow, so we put it on the end.
4333 "List of remote coding commands for inline transfer.
4334 Each item is a list that looks like this:
4336 \(FORMAT ENCODING DECODING [TEST])
4338 FORMAT is a symbol describing the encoding/decoding format. It can be
4339 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4341 ENCODING and DECODING can be strings, giving commands, or symbols,
4342 giving variables. If they are strings, then they can contain
4344 file name will be put into the command line at that spot. If the
4345 specifier is not present, the input should be read from standard
4346 input.
4348 If they are variables, this variable is a string containing a
4349 Perl or Shell implementation for this functionality. This
4350 program will be transferred to the remote host, and it is
4352 specifier in the variable value denotes a temporary file.
4354 The optional TEST command can be used for further tests, whether
4358 "Find an inline transfer encoding that works.
4359 Goes through the list `tramp-local-coding-commands' and
4360 `tramp-remote-coding-commands'."
4365 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4373 ;; If the local encoder or decoder is a string, the
4374 ;; corresponding command has to work locally.
4381 loc-enc nil nil))
4389 loc-dec nil nil))
4391 ;; Search for remote coding commands with the same format
4399 ;; Check the remote test command if exists.
4405 ;; Check if remote perl exists when necessary.
4410 ;; Check if remote encoding and decoding commands can be
4411 ;; called remotely with null input and output. This makes
4412 ;; sure there are no syntax errors and the command is really
4413 ;; found. Note that we do not redirect stdout to /dev/null,
4414 ;; for two reasons: when checking the decoding command, we
4415 ;; actually check the output it gives. And also, when
4416 ;; redirecting "mimencode" output to /dev/null, then as root
4417 ;; it might change the permissions of /dev/null!
4425 vec 5
4434 tmpfile)
4441 tramp-temp-name-prefix
4443 value
4445 value
4447 ?t
4452 vec 5
4455 vec
4457 t)
4465 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4471 ;; Set connection properties. Since the commands are risky
4472 ;; (due to output direction), we cache them in the process cache.
4483 "Call the local encoding or decoding command.
4485 Otherwise, INPUT is passed via standard input.
4486 INPUT can also be nil which means `/dev/null'.
4487 OUTPUT can be a string (which specifies a file name), or t (which
4488 means standard output and thus the current buffer), or nil (which
4489 means discard it)."
4491 nil tramp-encoding-shell
4494 nil
4495 tramp-encoding-command-switch
4505 "List of compress and decompress commands for inline transfer.
4506 Each item is a list that looks like this:
4508 \(COMPRESS DECOMPRESS)
4513 "Find an inline transfer compress command that works.
4514 Goes through the list `tramp-inline-compress-commands'."
4519 item compress decompress found)
4526 vec 5
4527 "Checking local compress commands `%s', `%s' for sanity"
4528 compress decompress)
4533 "echo %s | %s | %s" magic
4534 ;; Windows shells need the program file name after
4535 ;; the pipe symbol be quoted if they use forward
4536 ;; slashes as directory separators.
4541 nil nil))
4544 vec 5
4545 "Checking remote compress commands `%s', `%s' for sanity"
4546 compress decompress)
4552 ;; Did we find something?
4555 ;; Set connection properties. Since the commands are
4556 ;; risky (due to output direction), we cache them in the
4557 ;; process cache.
4571 "Expands VEC according to `tramp-default-proxies-alist'."
4575 choices proxy)
4577 ;; Ad-hoc proxy definitions.
4582 tramp-prefix-format proxy tramp-postfix-host-format)))
4587 proxy)
4588 ;; Add the hop.
4590 'tramp-default-proxies-alist
4593 proxy))
4595 ;; Save the new value.
4600 ;; Look for proxy hosts to be passed.
4606 ;; Host.
4609 ;; User.
4613 ;; No more hops needed.
4615 ;; Replace placeholders.
4618 proxy
4623 ;; Add the hop.
4625 ;; Start next search.
4628 ;; Foreign and out-of-band methods are not supported for multi-hops.
4635 vec 'file-error
4636 "Method `%s' is not supported for multi-hops."
4639 ;; In case the host name is not used for the remote shell
4640 ;; command, the user could be misguided by applying a random
4641 ;; host name.
4647 ;; There are multi-hops.
4649 ;; The host name is used for the remote shell command.
4651 ;; The host is local. We cannot use `tramp-local-host-p'
4652 ;; here, because it opens a connection as well.
4655 v 'file-error
4656 "Host `%s' looks like a remote host, `%s' can only use the local host"
4657 host method)))
4659 ;; Result.
4660 target-alist))
4663 "Return the Control* arguments of the local ssh."
4665 ;; No options to be computed.
4670 ;; There is already a value to be used.
4673 ;; Determine the options.
4688 ;; We use a non-existing IP address, in order to
4689 ;; avoid useless connections, and DNS timeouts.
4690 ;; Setting ConnectTimeout is needed since OpenSSH 7.
4692 vec "ssh" nil t nil
4698 " -o ControlPath='tramp.%%r@%%h:%%p'"
4707 tramp-ssh-controlmaster-options)))
4710 "Maybe open a connection VEC.
4711 Does not do anything if a connection is already open, but re-opens the
4712 connection if a previous connection has died for some reason."
4718 ;; If Tramp opens the same connection within a short time frame,
4719 ;; there is a problem. We shall signal this.
4728 ;; If too much time has passed since last command was sent, look
4729 ;; whether process is still alive. If it isn't, kill it. When
4730 ;; using ssh, it can sometimes happen that the remote end has hung
4731 ;; up but the local ssh client doesn't recognize this until it
4732 ;; tries to send some data to the remote end. So that's why we
4733 ;; try to send a command from time to time, then look again
4734 ;; whether the process is really alive.
4745 ;; The error will be caught locally.
4751 ;; New connection must be opened.
4755 ;; During completion, don't reopen a new connection. We
4756 ;; check this for the process related to
4757 ;; `tramp-buffer-name'; otherwise `start-file-process'
4758 ;; wouldn't run ever when `non-essential' is non-nil.
4764 vec 3
4775 ;; Start new process.
4793 ;; We will apply `tramp-ssh-controlmaster-options'
4794 ;; only for the first hop.
4798 ;; There are unfortunate settings for "cmdproxy" on
4799 ;; W32 systems.
4802 ;; This must be done in order to avoid our file
4803 ;; name handler.
4807 'start-process
4812 tramp-encoding-command-interactive)
4815 ;; Set sentinel and query flag. Initialize variables.
4825 ;; Check whether process is alive.
4827 p 10
4830 ;; Now do all the connections as specified.
4850 ;; We don't create the temporary file. In
4851 ;; fact, it is just a prefix for the
4852 ;; ControlPath option of ssh; the real
4853 ;; temporary file has another name, and it is
4854 ;; created and protected by ssh. It is also
4855 ;; removed by ssh when the connection is
4856 ;; closed. The temporary file name is cached
4857 ;; in the main connection process, therefore
4858 ;; we cannot use `tramp-get-connection-process'.
4864 tramp-temp-name-prefix
4866 spec r-shell)
4868 ;; Add arguments for asynchronous processes.
4872 ;; Check, whether there is a restricted shell.
4878 ;; Set password prompt vector.
4880 p "password-vector"
4885 ;; Add login environment.
4888 login-env
4893 login-env))
4897 "%s=%s %s"
4900 command)))
4903 ;; Replace `login-args' place holders.
4911 ?h l-host ?u l-user ?p l-port ?c options)
4912 command
4914 ;; We do not want to see the trailing local
4915 ;; prompt in `start-file-process'.
4917 command " "
4923 ;; Local shell could be a Windows COMSPEC. It
4924 ;; doesn't know the ";" syntax, but we must exit
4925 ;; always for `start-file-process'. It could
4926 ;; also be a restricted shell, which does not
4927 ;; allow "exec".
4930 ;; Send the command.
4934 p vec
4937 tramp-actions-before-shell
4941 ;; Next hop.
4945 ;; Set connection-local variables.
4948 ;; Make initial shell settings.
4951 ;; Mark it as connected.
4954 ;; Cleanup, and propagate the signal.
4960 "Send the COMMAND to connection VEC.
4961 Erases temporary buffer before sending the command. If optional
4962 arg NEVEROPEN is non-nil, never try to open the connection. This
4963 is meant to be used from `tramp-maybe-open-connection' only. The
4964 function waits for output unless NOOUTPUT is set."
4968 ;; We mark the command string that it can be erased in the output buffer.
4970 ;; If we put `tramp-echo-mark' after a trailing newline (which
4971 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4972 ;; that newline and adds `tramp-rsh-end-of-line' right after
4973 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4974 ;; trailing line endings and sends two prompts after executing
4975 ;; the command, which confuses `tramp-wait-for-output'.
4979 ;; No need to restore a trailing newline here since `tramp-send-string'
4980 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4982 ;; Send the command.
4988 "Wait for output from remote command."
4994 ;; be leading escape sequences, which must be ignored.
4995 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4996 ;; option send also escape sequences, which must be
4997 ;; ignored.
5000 tramp-device-escape-sequence-regexp))
5001 ;; Sometimes, the commands do not return a newline but a
5002 ;; null byte before the shell prompt, for example "git
5003 ;; ls-files -c -z ...".
5008 ;; A simple-minded busybox has sent " ^H" sequences.
5009 ;; Delete them.
5014 ;; Delete the prompt.
5020 proc 'file-error
5021 "[[Remote prompt `%s' not found in %d secs]]"
5022 tramp-end-of-output timeout)
5024 proc 'file-error
5026 ;; Return value is whether end-of-output sentinel was found.
5027 found)))
5031 "Run COMMAND and check its exit status.
5032 Sends `echo $?' along with the COMMAND for checking the exit status.
5033 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5034 status is 0, and nil otherwise.
5036 If the optional argument SUBSHELL is non-nil, the command is
5037 executed in a subshell, ie surrounded by parentheses. If
5038 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5040 vec
5042 command
5044 "echo tramp_exit_status $?"
5058 "Run COMMAND, check exit status, throw error if exit status not okay.
5059 Similar to `tramp-send-command-and-check' but accepts two more arguments
5060 FMT and ARGS which are passed to `error'."
5065 "Run COMMAND and return the output, which must be a Lisp expression.
5066 If MARKER is a regexp, read the output after that string.
5067 In case there is no valid Lisp expression and NOERROR is nil, it
5068 raises an error."
5075 ;; Read the marker.
5081 vec 'file-error
5082 "`%s' does not return the marker `%s': `%s'"
5084 ;; Read the expression.
5087 ;; Error handling.
5092 vec 'file-error
5093 "`%s' does not return a valid Lisp expression: `%s'"
5097 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5098 Convert file mode bits to string and set virtual device number.
5099 Return ATTR."
5101 ;; Remove color escape sequences from symlink.
5105 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5106 ;; indication of unusable value.
5117 ;; Convert last access time.
5122 ;; Convert last modification time.
5127 ;; Convert last status change time.
5132 ;; Convert file size.
5138 ;; Convert file mode bits to string.
5143 ;; Convert directory indication bit.
5146 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5152 ;; Set file's gid change bit.
5160 ;; Convert inode.
5165 middle low)
5168 ;; The low 16 bits.
5173 ;; The middle 24 bits.
5177 ;; Inodes can be incredible huge. We must hide this.
5179 ;; Set virtual device number.
5182 attr))
5185 "Converts STRING to shell glob pattern which ignores case."
5191 string
5195 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5207 localname)
5213 "Return t if this is an out-of-band method, nil otherwise."
5215 ;; It shall be an out-of-band method.
5217 ;; There must be a size, otherwise the file doesn't exist.
5219 ;; Either the file size is large enough, or (in rare cases) there
5220 ;; does not exist a remote encoding.
5225 ;; Variables local to connection.
5228 "Compile list of remote directories for $PATH.
5229 Nonexistent directories are removed from spec."
5231 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5232 ;; cache the result for the session only. Otherwise, the result
5233 ;; is cached persistently.
5236 vec)
5237 "remote-path"
5246 ;; Default if "getconf" is not available.
5249 vec 3
5254 ;; The login shell could return more than just the $PATH
5255 ;; string. So we use `tramp-end-of-heredoc' as marker.
5259 vec
5264 'identity
5268 'identity
5276 nil)))))
5278 ;; Replace place holder `tramp-default-remote-path'.
5286 ;; Replace place holder `tramp-own-remote-path'.
5294 ;; Remove double entries.
5301 ;; Remove non-existing directories.
5303 nil
5309 x))
5310 remote-path)))))
5313 "Determine remote locale, supporting UTF8 if possible."
5317 locale)
5324 candidates nil)
5326 ;; Return value.
5330 "Determine remote `ls' command."
5337 result)
5339 ;; Check parameters. On busybox, "ls" output coloring is
5340 ;; enabled by default sometimes. So we try to disable it
5341 ;; when possible. $LS_COLORING is not supported there.
5342 ;; Some "ls" versions are sensible wrt the order of
5343 ;; arguments, they fail when "-al" is after the
5344 ;; "--color=never" argument (for example on FreeBSD).
5356 "Check, whether the remote `ls' command supports the --dired option."
5360 ;; Some "ls" versions are sensible wrt the order of arguments,
5361 ;; they fail when "-al" is after the "--dired" argument (for
5362 ;; example on FreeBSD).
5367 "Check, whether the remote `ls' command supports the --quoting-style option."
5376 "Check, whether the remote `ls' command supports the -w option."
5380 ;; Option "-w" is available on BSD systems. No argument is
5381 ;; given, because this could return wrong results in case "ls"
5382 ;; supports the "-w NUM" argument, as for busyboxes.
5387 "Determine remote `test' command."
5391 "test"
5395 "Check, whether the remote `test' command supports the -nt option."
5396 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5397 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5398 ;; for otherwise the shell crashes.
5410 vec
5417 "Determine remote command for file existing check."
5423 "Determine remote `ln' command."
5429 "Determine remote `perl' command."
5435 ;; Perform a basic check.
5440 ;; We must check also for some Perl modules.
5448 result)))
5451 "Determine remote `stat' command."
5456 tmp)
5457 ;; Check whether stat(1) returns usable syntax. "%s" does not
5458 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5459 ;; use shell quoted format for "%N", we check the boundaries "`"
5460 ;; and "'", therefore. See Bug#23422 in coreutils.
5461 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5462 ;; supported.
5471 result)))
5474 "Determine remote `readlink' command."
5482 result))))
5485 "Determine remote `trash' command.
5486 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5493 "Determine remote `touch' command."
5502 ;; Busyboxes do support the "-t" option only when they have been
5503 ;; built with the DESKTOP config option. Let's check it.
5506 vec "touch-t"
5508 vec
5510 "%s -t %s %s"
5511 result
5515 result)))
5518 "Determine remote `df' command."
5523 result
5526 result))))
5529 "Determine remote `gio-monitor' command."
5535 "Determine remote `gvfs-monitor-dir' command."
5538 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5539 ;; establish better timeouts in filenotify-tests.el. Any better
5540 ;; distinction approach would be welcome!
5547 "Determine remote `inotifywait' command."
5553 "Determine remote `id' command."
5559 result)
5561 ;; Check POSIX parameter.
5567 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5569 vec
5577 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5579 vec
5583 "print $>"
5587 "Determine remote `python' command."
5595 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5597 vec
5601 "import os; print (os.getuid())"
5605 "The uid of the remote connection VEC, in ID-FORMAT.
5606 ID-FORMAT valid values are `string' and `integer'."
5617 ;; Ensure there is a valid result.
5620 tramp-unknown-id-integer)
5622 tramp-unknown-id-string)
5626 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5628 vec
5636 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5638 vec
5646 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5648 vec
5652 "import os; print (os.getgid())"
5656 "The gid of the remote connection VEC, in ID-FORMAT.
5657 ID-FORMAT valid values are `string' and `integer'."
5668 ;; Ensure there is a valid result.
5671 tramp-unknown-id-integer)
5673 tramp-unknown-id-string)
5677 "Check, whether the remote `env' command supports the -u option."
5680 ;; Option "-u" is a GNU extension.
5684 ;; Some predefined connection properties.
5686 "Return the compress command related to PROP.
5687 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5688 the length of the file to be compressed.
5690 If no corresponding command is found, nil is returned."
5699 "Return the coding command related to PROP.
5700 PROP is either `remote-encoding', `remote-decoding',
5701 `local-encoding' or `local-decoding'.
5703 SIZE is the length of the file to be coded. Depending on SIZE,
5704 compression might be applied.
5706 If no corresponding command is found, nil is returned.
5707 Otherwise, either a string is returned which contains a `%s' mark
5708 to be used for the respective input or output file; or a Lisp
5709 function cell is returned to be applied on a buffer."
5710 ;; We must catch the errors, because we want to return nil, when
5711 ;; no inline coding is found.
5721 compress)
5722 ;; The connection property might have been cached. So we must
5723 ;; send the script to the remote side - maybe.
5731 ;; Check for the `compress' command.
5733 ;; Return the value.
5754 coding)
5757 ;; Windows shells need the program file name after
5758 ;; the pipe symbol be quoted if they use forward
5759 ;; slashes as directory separators.
5766 coding compress))
5769 ;; Windows shells need the program file name after
5770 ;; the pipe symbol be quoted if they use forward
5771 ;; slashes as directory separators.
5776 compress coding))
5790 ;;; TODO:
5792 ;; * Don't use globbing for directories with many files, as this is
5793 ;; likely to produce long command lines, and some shells choke on
5794 ;; long command lines.
5795 ;;
5796 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5797 ;; then look if it's the right version (with `perl -v').
5798 ;;
5799 ;; * When editing a remote CVS controlled file as a different user, VC
5800 ;; gets confused about the file locking status. Try to find out why
5801 ;; the workaround doesn't work.
5802 ;;
5803 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5804 ;; until the last but one hop via `start-file-process'. Apply it
5805 ;; also for ftp and smb.
5806 ;;
5807 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5808 ;; some shell with root privileges, it would be nice if I could
5809 ;; just call
5810 ;; trampclient filename.c
5811 ;; as an editor, and the _current_ shell would connect to an Emacs
5812 ;; server and would be used in an existing non-privileged Emacs
5813 ;; session for doing the editing in question.
5814 ;; That way, I need not tell Emacs my password again and be afraid
5815 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5816 ;; once display a just typed password in the context of a keyboard
5817 ;; sequence prompt for a question immediately following in a shell
5818 ;; script run within Emacs -- nasty).
5819 ;; And if I have some ssh session running to a different computer,
5820 ;; having the possibility of passing a local file there to a local
5821 ;; Emacs session (in case I can arrange for a connection back) would
5822 ;; be nice.
5823 ;; Likely the corresponding Tramp server should not allow the
5824 ;; equivalent of the emacsclient -eval option in order to make this
5825 ;; reasonably unproblematic. And maybe trampclient should have some
5826 ;; way of passing credentials, like by using an SSL socket or
5827 ;; something. (David Kastrup)
5828 ;;
5829 ;; * Reconnect directly to a compliant shell without first going
5830 ;; through the user's default shell. (Pete Forman)
5831 ;;
5832 ;; * Avoid the local shell entirely for starting remote processes. If
5833 ;; so, I think even a signal, when delivered directly to the local
5834 ;; SSH instance, would correctly be propagated to the remote process
5835 ;; automatically; possibly SSH would have to be started with
5836 ;; "-t". (Markus Triska)
5837 ;;
5838 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5839 ;; isn't on the remote host. (Mark A. Hershberger)
5840 ;;
5841 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5842 ;;
5843 ;; * Optimize out-of-band copying when both methods are scp-like (not
5844 ;; rsync).
5845 ;;
5846 ;; * Keep a second connection open for out-of-band methods like scp or
5847 ;; rsync.
5848 ;;
5849 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5850 ;;
5851 ;; * I think you could get the best of both worlds by using an
5852 ;; approach similar to Tramp but running a little tramp-daemon on
5853 ;; the other end, such that we can use a more efficient
5854 ;; communication protocol (e.g. when saving a file we could locally
5855 ;; diff it against the last version (of which the remote daemon
5856 ;; would also keep a copy), and then only send the diff).
5857 ;;
5858 ;; This said, even using such a daemon it might be difficult to get
5859 ;; good performance: part of the problem is the number of
5860 ;; round-trips. E.g. when saving a file we have to check if the
5861 ;; file was modified in the mean time and whether saving into a new
5862 ;; inode would change the owner (etc...), which each require a
5863 ;; round-trip. To get rid of these round-trips, we'd have to
5864 ;; shortcut this code and delegate the higher-level "save file"
5865 ;; operation to the remote server, which then has to perform those
5866 ;; tasks but still obeying the locally set customizations about how
5867 ;; to do each one of those tasks.
5868 ;;
5869 ;; We could either put higher-level ops in there (like
5870 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5871 ;; behavior, which is a lot of work and likely to be not 100%
5872 ;; faithful.
5873 ;;
5874 ;; Or we could introduce new low-level ops that are asynchronous,
5875 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5876 ;; start with a bunch of calls like `start-getting-file-attributes'
5877 ;; which could immediately be passed on to the remote side, and
5878 ;; later on checks the return value of those calls as and when
5879 ;; needed. (Stefan Monnier)
5881 ;;; tramp-sh.el ends here