| blob | 3ba3d956efca031e255885eec73e64b2c5369069 |
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
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."
1130 ;; Preserve trailing "/".
1136 method user domain host port
1143 ;; Use GNU readlink --canonicalize-missing where available.
1146 v
1154 ;; Use Perl implementation.
1162 v
1166 ;; Do it yourself.
1170 ;; Don't make the following value larger than
1171 ;; necessary. People expect an error message in a
1172 ;; timely fashion when something is wrong;
1173 ;; otherwise they might think that Emacs is hung.
1174 ;; Of course, correctness has to come first.
1176 symlink-target)
1188 method user domain host port
1200 ;; It's a symlink, follow it.
1210 ;; It's a file.
1214 v 'file-error
1217 ;; Combine list to form string.
1225 ;; Detect cycle.
1229 v 'file-error
1231 ;; If the resulting localname looks remote, we must quote it
1232 ;; for security reasons.
1237 result))))))
1239 ;; Basic functions.
1242 "Like `file-exists-p' for Tramp files."
1250 v
1252 "%s %s"
1257 "Like `file-attributes' for Tramp files."
1260 ;; Don't modify `last-coding-system-used' by accident.
1267 v
1275 ;; The scripts could fail, for example with huge file size.
1279 "Implement `file-attributes' for Tramp files using the ls(1) command."
1281 res-inode res-filemodes res-numlinks
1282 res-uid res-gid res-size res-symlink-target)
1284 ;; We cannot send all three commands combined, it could exceed
1285 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1287 vec
1292 vec
1297 vec
1301 ;; On systems which have no quoting style, file names
1302 ;; with special characters could fail.
1308 ;; Parse `ls -l' output ...
1312 ;; ... inode
1314 ;; ... file mode flags
1316 ;; ... number links
1318 ;; ... uid and gid
1330 ;; ... size
1332 ;; From the file modes, figure out other stuff.
1335 ;; If symlink, find out file name pointed to.
1342 ;; Return data gathered.
1344 ;; 0. t for directory, string (name linked to) for symbolic
1345 ;; link, or nil.
1347 ;; 1. Number of links to file.
1348 res-numlinks
1349 ;; 2. File uid.
1350 res-uid
1351 ;; 3. File gid.
1352 res-gid
1353 ;; 4. Last access time, as a list of integers. Normally
1354 ;; this would be in the same format as `current-time', but
1355 ;; the subseconds part is not currently implemented, and
1356 ;; (0 0) denotes an unknown time.
1357 ;; 5. Last modification time, likewise.
1358 ;; 6. Last status change time, likewise.
1360 ;; 7. Size in bytes (-1, if number is out of range).
1361 res-size
1362 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1363 res-filemodes
1364 ;; 9. t if file's gid would change if file were deleted and
1365 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1366 t
1367 ;; 10. Inode number.
1368 res-inode
1369 ;; 11. Device number. Will be replaced by a virtual device number.
1374 "Implement `file-attributes' for Tramp files using a Perl script."
1379 vec
1385 "Implement `file-attributes' for Tramp files using stat(1) command."
1388 vec
1391 ;; On Opsware, pdksh (which is the true name of ksh there)
1392 ;; doesn't parse correctly the sequence "((". Therefore, we add
1393 ;; a space. Apostrophes in the stat output are masked as
1394 ;; `tramp-stat-marker', in order to make a proper shell escape of
1395 ;; them in file names.
1396 "( (%s %s || %s -h %s) && (%s -c "
1397 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1404 tramp-stat-marker tramp-stat-marker
1409 tramp-stat-marker tramp-stat-marker
1411 tramp-stat-quoted-marker)))
1414 "Like `set-visited-file-modtime' for Tramp files."
1421 coding-system-used)
1425 ;; '(-1 65535) means file doesn't exists yet.
1429 ;; We use '(0 0) as a don't-know value. See also
1430 ;; `tramp-do-file-attributes-with-ls'.
1435 v
1443 nil)))))
1445 ;; This function makes the same assumption as
1446 ;; `tramp-sh-handle-set-visited-file-modtime'.
1448 "Like `verify-visited-file-modtime' for Tramp files.
1449 At the time `verify-visited-file-modtime' calls this function, we
1450 already know that the buffer is visiting a file and that
1451 `visited-file-modtime' does not return 0. Do not call this
1452 function directly, unless those two cases are already taken care
1453 of."
1456 ;; There is no file visiting the buffer, or the buffer has no
1457 ;; recorded last modification time, or there is no established
1458 ;; connection.
1462 t
1470 ;; File exists, and has a known modtime.
1473 modtime
1474 ;; For compatibility, deal with both the old
1475 ;; (HIGH . LOW) and the new (HIGH LOW) return
1476 ;; values of `visited-file-modtime'.
1479 mt)))
1481 ;; Modtime has the don't know value.
1484 v
1491 attr
1494 ;; If file does not exist, say it is not modified if and
1495 ;; only if that agrees with the buffer's record.
1499 "Like `set-file-modes' for Tramp files."
1503 ;; FIXME: extract the proper text from chmod's stderr.
1505 v
1510 "Like `set-file-times' for Tramp files."
1517 time)))
1520 "env TZ=UTC %s %s %s"
1528 "Set the ownership for FILENAME.
1529 If UID and GID are provided, these values are used; otherwise uid
1530 and gid of the corresponding user is taken. Both parameters must
1531 be non-negative integers."
1532 ;; Modern Unices allow chown only for root. So we might need
1533 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1534 ;; working with su(do)? when it is needed, so it shall succeed in
1535 ;; the majority of cases.
1536 ;; Don't modify `last-coding-system-used' by accident.
1541 ;; If we are root on the local host, we can do it directly.
1549 "chown %d:%d %s" uid gid
1552 ;; We handle also the local part, because there doesn't exist
1553 ;; `set-file-uid-gid'. On W32 "chown" does not work.
1558 nil "chown" nil nil nil
1562 "Check, whether SELINUX is enabled on the remote host."
1567 "Like `file-selinux-context' for Tramp files."
1576 "%s -d -Z %s"
1584 ;; Return the context.
1585 context))))
1588 "Like `set-file-selinux-context' for Tramp files."
1607 t)))))
1610 "Check, whether ACL is enabled on the remote host."
1615 "Like `file-acl' for Tramp files."
1621 "getfacl -ac %s"
1630 "Like `set-file-acl' for Tramp files."
1637 tramp-end-of-heredoc
1638 acl-string
1639 tramp-end-of-heredoc))
1641 ;; Success.
1644 t)
1645 ;; In case of errors, we return nil.
1647 nil)))
1649 ;; Simple functions using the `test' command.
1652 "Like `file-executable-p' for Tramp files."
1655 ;; Examine `file-attributes' cache to see if request can be
1656 ;; satisfied without remote operation.
1661 "Like `file-readable-p' for Tramp files."
1664 ;; Examine `file-attributes' cache to see if request can be
1665 ;; satisfied without remote operation.
1669 ;; When the remote shell is started, it looks for a shell which groks
1670 ;; tilde expansion. Here, we assume that all shells which grok tilde
1671 ;; expansion will also provide a `test' command which groks `-nt' (for
1672 ;; newer than). If this breaks, tell me about it and I'll try to do
1673 ;; something smarter about it.
1675 "Like `file-newer-than-file-p' for Tramp files."
1677 nil)
1679 t)
1680 ;; We are sure both files exist at this point.
1683 ;; We try to get the mtime of both files. If they are not
1684 ;; equal to the "dont-know" value, then we subtract the times
1685 ;; and obtain the result.
1698 ;; If one of them is the dont-know value, then we can
1699 ;; still try to run a shell command on the remote host.
1700 ;; However, this only works if both files are Tramp
1701 ;; files and both have the same method, same user, same
1702 ;; host.
1707 v 'file-error
1708 "Files %s and %s must have same method, user, host"
1709 file1 file2)))
1714 ;; Functions implemented using the basic functions above.
1717 "Like `file-directory-p' for Tramp files."
1719 ;; `file-directory-p' is used as predicate for file name completion.
1720 ;; Sometimes, when a connection is not established yet, it is
1721 ;; desirable to return t immediately for "/method:foo:". It can
1722 ;; be expected that this is always a directory.
1728 "Like `file-writable-p' for Tramp files."
1732 ;; Examine `file-attributes' cache to see if request can be
1733 ;; satisfied without remote operation.
1736 ;; If file doesn't exist, check if directory is writable.
1741 "Like `file-ownership-preserved-p' for Tramp files."
1745 ;; Return t if the file doesn't exist, since it's true that no
1746 ;; information would be lost by an (attempted) delete and create.
1755 ;; Directory listings.
1759 "Like `directory-files-and-attributes' for Tramp files."
1767 v localname
1778 v localname id-format))
1781 v localname id-format))
1783 result item)
1793 result
1795 ;; The scripts could fail, for example with huge file size.
1797 directory full match nosort id-format)))))
1801 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1804 vec tramp-perl-directory-files-and-attributes
1808 vec
1812 object))
1816 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1819 vec
1822 ;; We must care about file names with spaces, or starting with
1823 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1824 ;; but it does not work on all remote systems. Apostrophes in
1825 ;; the stat output are masked as `tramp-stat-marker', in order to
1826 ;; make a proper shell escape of them in file names.
1828 "xargs %s -c "
1829 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1833 ;; On systems which have no quoting style, file names with special
1834 ;; characters could fail.
1840 tramp-stat-marker tramp-stat-marker
1841 tramp-stat-marker tramp-stat-marker
1846 tramp-stat-marker tramp-stat-marker
1847 tramp-stat-quoted-marker)))
1849 ;; This function should return "foo/" for directories and "bar" for
1850 ;; files.
1852 "Like `file-name-all-completions' for Tramp files."
1855 filename
1859 ;; Get a list of directories and files, including reliably
1860 ;; tagging the directories with a trailing "/". Because I
1861 ;; rock. --daniel@danann.net
1863 v
1867 v tramp-perl-file-name-all-completions
1873 "(cd %s 2>&1 && %s -a 2>/dev/null"
1874 " | while IFS= read f; do"
1882 ;; Now grab the output.
1886 ;; Check result code, found in last line of output.
1890 ;; Grab error message from line before last line
1891 ;; (it was put there by `cd 2>&1').
1894 v 'file-error
1895 "tramp-sh-handle-file-name-all-completions: %s"
1897 ;; For peace of mind, if buffer doesn't end in `fail'
1898 ;; then it should end in `ok'. If neither are in the
1899 ;; buffer something went seriously wrong on the remote
1900 ;; side.
1904 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1909 result))))))
1911 ;; cp, mv and ln
1915 "Like `add-name-to-file' for Tramp files."
1920 v 'file-error
1921 "add-name-to-file: %s"
1927 ;; Do the 'confirm if exists' thing.
1929 ;; What to do?
1934 "File %s already exists; make it a link anyway? "
1935 v2-localname)))))
1941 v1
1945 "error with add-name-to-file, see buffer `%s' for details"
1950 preserve-uid-gid preserve-extended-attributes)
1951 "Like `copy-file' for Tramp files."
1957 'copy filename newname ok-if-already-exists keep-date
1958 preserve-uid-gid preserve-extended-attributes)
1960 'copy-file
1962 preserve-uid-gid preserve-extended-attributes))))
1966 "Like `copy-directory' for Tramp files."
1972 ;; When DIRNAME and NEWNAME are remote, they must have
1973 ;; the same method.
1979 ;; scp or rsync DTRT.
1997 ;; We must do it file-wise.
1999 'copy-directory
2002 ;; When newname did exist, we have wrong cached values.
2010 "Like `rename-file' for Tramp files."
2011 ;; Check if both files are local -- invoke normal rename-file.
2012 ;; Otherwise, use Tramp from local system.
2015 ;; At least one file a Tramp file?
2019 'rename filename newname ok-if-already-exists
2026 preserve-uid-gid preserve-extended-attributes)
2027 "Copy or rename a remote file.
2028 OP must be `copy' or `rename' and indicates the operation to perform.
2029 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2030 the new file (for copy) or the new name of the file (for rename).
2031 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2032 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2033 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2034 the uid and gid if both files are on the same host.
2035 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2037 This function is invoked by `tramp-sh-handle-copy-file' and
2038 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2039 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2040 file names."
2053 ;; `file-extended-attributes' exists since Emacs 24.4.
2064 filename newname)
2067 ;; Both are Tramp files.
2072 ;; Shortcut: if method, host, user are the same for
2073 ;; both files, we invoke `cp' or `mv' on the remote
2074 ;; host directly.
2077 op filename newname
2078 ok-if-already-exists keep-date preserve-uid-gid))
2080 ;; Try out-of-band operation.
2085 op filename newname keep-date))
2087 ;; No shortcut was possible. So we copy the file
2088 ;; first. If the operation was `rename', we go back
2089 ;; and delete the original file (if the copy was
2090 ;; successful). The approach is simple-minded: we
2091 ;; create a new buffer, insert the contents of the
2092 ;; source file into it, then write out the buffer to
2093 ;; the target file. The advantage is that it doesn't
2094 ;; matter which file name handlers are used for the
2095 ;; source and target file.
2098 op filename newname keep-date))))))
2100 ;; One file is a Tramp file, the other one is local.
2103 ;; Fast track on local machine.
2106 op filename newname
2107 ok-if-already-exists keep-date preserve-uid-gid))
2109 ;; If the Tramp file has an out-of-band method, the
2110 ;; corresponding copy-program can be invoked.
2113 op filename newname keep-date))
2115 ;; Use the inline method via a Tramp buffer.
2117 op filename newname keep-date))))
2120 ;; One of them must be a Tramp file.
2123 ;; Handle `preserve-extended-attributes'. We ignore possible
2124 ;; errors, because ACL strings could be incompatible.
2129 ;; In case of `rename', we must flush the cache of the source file.
2136 ;; When newname did exist, we have wrong cached values.
2144 "Use an Emacs buffer to copy or rename a file.
2145 First arg OP is either `copy' or `rename' and indicates the operation.
2146 FILENAME is the source file, NEWNAME the target file.
2147 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2148 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2149 ;; and `find-file-noselect', but that's not called here.
2153 ;; We must disable multibyte, because binary data shall not be
2154 ;; converted. We don't want the target file to be compressed, so we
2155 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2156 ;; be called either. We remove `tramp-file-name-handler' from
2157 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2158 ;; `insert-file-contents' might be deactivated in some corner cases.
2169 ;; KEEP-DATE handling.
2172 newname
2175 ;; Set the mode.
2177 ;; If the operation was `rename', delete the original file.
2182 "Invokes `cp' or `mv' on the remote system.
2183 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2184 respectively. FILENAME specifies the file to copy or rename,
2185 NEWNAME is the name of the new file (for copy) or the new name of
2186 the file (for rename). Both files must reside on the same host.
2187 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2188 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2189 the uid and gid from FILENAME."
2200 v 'file-error
2201 "Unknown operation `%s', must be `copy' or `rename'"
2202 op))))
2206 cmd-result)
2209 ;; Both files are on a remote host, with same user.
2221 ;; Mask cp -f error.
2223 tramp-operation-not-permitted-regexp nil t))
2224 cmd-result)
2226 nil v 'file-error
2227 "Copying directly failed, see buffer `%s' for details."
2230 ;; We are on the local host.
2233 ;; We can do it directly.
2236 ;; No sticky bit when renaming.
2247 localname1 localname2 ok-if-already-exists
2248 keep-date preserve-uid-gid)
2252 ;; We can do it directly with `tramp-send-command'
2260 ok-if-already-exists keep-date t)
2261 ;; We must change the ownership to the local user.
2267 ;; We need a temporary file in between.
2269 ;; Create the temporary file.
2277 "%s %s %s" cmd
2280 "Copying directly failed, see buffer `%s' for details."
2282 ;; We must change the ownership as remote user.
2283 ;; Since this does not work reliable, we also
2284 ;; give read permissions.
2294 localname1 tmpfile t keep-date preserve-uid-gid)
2297 ;; We must change the ownership as local user.
2298 ;; Since this does not work reliable, we also
2299 ;; give read permissions.
2302 tmpfile
2306 ;; Move the temporary file to its destination.
2311 "cp -f -p %s %s"
2314 "Copying directly failed, see buffer `%s' for details."
2318 'rename-file
2321 ;; Save exit.
2324 ;; Set the time and mode. Mask possible errors.
2331 "Invoke `scp' program to copy.
2332 The method used must be an out-of-band method."
2336 copy-program copy-args copy-env copy-keep-date listener spec
2337 options source target remote-copy-program remote-copy-args)
2342 ;; Both are Tramp files. We shall optimize it when the
2343 ;; methods for FILENAME and NEWNAME are the same.
2353 op filename tmpfile keep-date)
2356 ;; Save exit.
2363 ;; Check which ones of source and target are Tramp files.
2367 'file-name-as-directory
2376 ;; Check for user. There might be an interactive setting.
2380 ;; Check for listener port.
2387 ;; Compose copy command.
2396 ?h host ?u user ?p port ?r listener ?c options
2402 copy-args
2404 ;; " " has either been a replacement of "%k" (when
2405 ;; keep-date argument is non-nil), or a replacement
2406 ;; for the whole keep-date sublist.
2407 " "
2412 copy-args
2416 copy-env
2418 nil
2425 remote-copy-program
2431 remote-copy-args
2435 ;; Check for local copy program.
2440 ;; Install listener on the remote side. The prompt must be
2441 ;; consumed later on, when the process does not listen anymore.
2448 v 'file-error
2452 'identity
2460 v 'file-error
2461 "Listener process not running on remote host: `%s'"
2462 remote-copy-program))
2470 ;; The default directory must be remote.
2474 ;; We do not want to run timers.
2475 timer-list timer-idle-list)
2476 ;; Set the transfer process properties.
2486 copy-args
2488 copy-args
2493 ;; Use an asynchronous process. By this, password can
2494 ;; be handled. We don't set a timeout, because the
2495 ;; copying of large files can last longer than 60 secs.
2505 command))))
2511 ;; We must adapt `tramp-local-end-of-line' for
2512 ;; sending the password.
2515 p v nil tramp-actions-copy-out-of-band))))
2517 ;; Reset the transfer process properties.
2520 ;; Clear the remote prompt.
2523 ;; Houston, we have a problem! Likely, the listener is
2524 ;; still running, so let's clear everything (but the
2525 ;; cached password).
2528 ;; Handle KEEP-DATE argument.
2531 newname
2535 ;; Set the mode.
2540 ;; If the operation was `rename', delete the original file.
2547 "Like `make-directory' for Tramp files."
2559 "Like `delete-directory' for Tramp files."
2572 "Like `delete-file' for Tramp files."
2583 ;; Dired.
2586 "Like `dired-compress-file' for Tramp files."
2587 ;; Code stolen mainly from dired-aux.el.
2592 suffix)
2593 ;; See if any suffix rule matches this file name.
2601 nil)
2603 ;; We found an uncompression rule.
2613 ;; We don't recognize the file as compressed, so compress it.
2614 ;; Try gzip.
2628 "Like `insert-directory' for Tramp files."
2635 filename switches wildcard full-directory-p)
2656 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2657 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2660 v
2663 switches
2665 localname
2668 v
2672 "Couldn't `cd %s'"
2676 v
2679 switches
2684 ""
2692 ;; We cannot use `insert-buffer-substring' because the Tramp
2693 ;; buffer changes its contents before insertion due to calling
2694 ;; `expand-file-name' and alike.
2699 ;; Check for "--dired" output.
2706 ;; Now read the numeric positions of file names.
2712 ;; End is followed by \n or by " -> ".
2714 ;; Remove trailing lines.
2720 ;; Some busyboxes are reluctant to discard colors.
2728 ;; Decode the output, it could be multibyte.
2733 ;; The inserted file could be from somewhere else.
2740 "."
2745 ;; Try to insert the amount of free space.
2747 ;; First find the line to put it on.
2751 ;; Replace "total" with "total used", to avoid confusion.
2758 ;; Canonicalization of file names.
2761 "Like `expand-file-name' for Tramp files.
2763 the result will be a local, non-Tramp, file name."
2764 ;; If DIR is not given, use `default-directory' or "/".
2766 ;; Unless NAME is absolute, concat DIR and NAME.
2769 ;; If connection is not established yet, run the real handler.
2772 ;; Dissect NAME.
2776 ;; Tilde expansion if necessary. This needs a shell which
2777 ;; groks tilde expansion! The function `tramp-find-shell' is
2778 ;; supposed to find such a shell on the remote host. Please
2779 ;; tell me about it when this doesn't work on your system.
2783 ;; We cannot simply apply "~/", because under sudo "~/" is
2784 ;; expanded to the local user home directory but to the
2785 ;; root home directory. On the other hand, using always
2786 ;; the default user name for tilde expansion is not
2787 ;; appropriate either, because ssh and companions might
2788 ;; use a user name from the config file.
2800 ;; There might be a double slash, for example when "~/"
2801 ;; expands to "/". Remove this.
2804 ;; No tilde characters in file name, do normal
2805 ;; `expand-file-name' (this does "/./" and "/../").
2806 ;; `default-directory' is bound, because on Windows there would
2807 ;; be problems with UNC shares or Cygwin mounts.
2810 method user domain host port
2814 hop)))))
2816 ;;; Remote commands:
2819 "Flush file caches."
2827 ;; We use BUFFER also as connection buffer during setup. Because of
2828 ;; this, its original contents must be saved, and restored once
2829 ;; connection has been setup.
2831 "Like `start-file-process' for Tramp files."
2836 ;; BUFFER can be nil. We use a temporary buffer.
2838 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2839 ;; it might be that the arguments exceed the command line
2840 ;; length. Therefore, we modify the command.
2845 ;; When PROGRAM is nil, we just provide a tty.
2851 args
2855 ;; Use a human-friendly prompt, for example for `shell'.
2856 ;; We discard hops, if existing, that's why we cannot use
2857 ;; `file-remote-p'.
2860 tramp-initial-end-of-output))
2861 ;; We use as environment the difference to toplevel
2862 ;; `process-environment'.
2863 env uenv
2877 "unset %s &&"
2892 ;; We do not want to raise an error when
2893 ;; `start-file-process' has been started several times in
2894 ;; `eshell' and friends.
2895 tramp-current-connection
2896 ;; We do not want to run timers.
2897 timer-list timer-idle-list
2898 p)
2901 ;; NAME must be unique as process name.
2905 ;; Set the new process properties.
2911 ;; We catch this event. Otherwise, `start-process' could
2912 ;; be called on the local host.
2915 ;; Activate narrowing in order to save BUFFER
2916 ;; contents. Clear also the modification time;
2917 ;; otherwise we might be interrupted by
2918 ;; `verify-visited-file-modtime'.
2924 ;; We call `tramp-maybe-open-connection', in order
2925 ;; to cleanup the prompt afterwards.
2929 ;; Set the pid of the remote shell. This is
2930 ;; needed when sending signals remotely.
2937 ;; Now do it.
2939 ;; Send the command.
2941 ;; Check, whether a pty is associated.
2944 v 'file-error
2946 ;; Set query flag and process marker for this
2947 ;; process. We ignore errors, because the process
2948 ;; could have finished already.
2952 ;; Return process.
2953 p)))
2955 ;; Save exit.
2966 "Like `process-file' for Tramp files."
2967 ;; The implementation is not complete yet.
2973 ;; Compute command.
2976 ;; We use as environment the difference to toplevel `process-environment'.
2987 "env %s %s"
2992 "unset %s && %s"
2994 ;; Determine input.
2999 ;; INFILE is on the same remote host.
3001 ;; INFILE must be copied to remote host.
3003 tmpinput
3008 ;; Determine output.
3010 ;; Just a buffer.
3013 ;; A buffer name.
3016 ;; (REAL-DESTINATION ERROR-DESTINATION)
3018 ;; output.
3026 ;; stderr.
3031 ;; stderr is on the same remote host.
3034 ;; stderr must be copied to remote host. The temporary
3035 ;; file must be deleted after execution.
3038 method user domain host port stderr))))
3039 ;; stderr to be discarded.
3042 ;; 't
3047 ;; Send the command. It might not return in time, so we protect
3048 ;; it. Call it in a subshell, in order to preserve working
3049 ;; directory.
3056 command)
3057 t t)
3059 ;; We should add the output anyway.
3066 ;; When the user did interrupt, we should do it also. We use
3067 ;; return code -1 as marker.
3071 ;; Handle errors.
3076 ;; Provide error file.
3079 ;; Cleanup. We remove all file cache values for the connection,
3080 ;; because the remote process could have changed them.
3086 ;; Return exit status.
3089 ret))))
3092 "Like `file-local-copy' for Tramp files."
3096 v tramp-file-missing
3107 ;; `copy-file' handles direct copy and out-of-band methods.
3112 ;; Use inline encoding for file transfer.
3116 v 3
3118 filename rem-enc)
3125 tmpfile loc-dec)
3127 ;; If local decoding is a function, we call it.
3128 ;; We must disable multibyte, because
3129 ;; `uudecode-decode-region' doesn't handle it
3130 ;; correctly. Unset `file-name-handler-alist'.
3131 ;; Otherwise, epa-file gets confused.
3139 ;; If tramp-decoding-function is not defined for this
3140 ;; method, we invoke tramp-decoding-command instead.
3142 ;; Unset `file-name-handler-alist'. Otherwise,
3143 ;; epa-file gets confused.
3151 loc-dec tmpfile2 tmpfile)
3154 ;; Set proper permissions.
3156 ;; Set local user ownership.
3159 ;; Oops, I don't know what to do.
3163 ;; Error handling.
3169 tmpfile)))
3171 ;; CCC grok LOCKNAME
3174 "Like `write-region' for Tramp files."
3192 ;; `file-writable-p' calls `file-expand-file-name'. We
3193 ;; cannot use `tramp-run-real-handler' therefore.
3199 ;; Short track: if we are on the local host, we can run directly.
3204 ;; We use this to save the value of
3205 ;; `last-coding-system-used' after writing the tmp
3206 ;; file. At the end of the function, we set
3207 ;; `last-coding-system-used' to this saved value. This
3208 ;; way, any intermediary coding systems used while
3209 ;; talking to the remote shell or suchlike won't hose
3210 ;; this variable. This approach was snarfed from
3211 ;; ange-ftp.el.
3212 coding-system-used
3213 ;; Write region into a tmp file. This isn't really
3214 ;; needed if we use an encoding function, but currently
3215 ;; we use it always because this makes the logic
3216 ;; simpler. We must also set `temporary-file-directory',
3217 ;; because it could point to a remote directory.
3223 ;; If `append' is non-nil, we copy the file locally, and let
3224 ;; the native `write-region' implementation do the job.
3227 ;; We say `no-message' here because we don't want the
3228 ;; visited file modtime data to be clobbered from the temp
3229 ;; file. We call `set-visited-file-modtime' ourselves later
3230 ;; on. We must ensure that `file-coding-system-alist'
3231 ;; matches `tmpfile'.
3237 'write-region
3244 ;; Now, `last-coding-system-used' has the right value. Remember it.
3247 ;; The permissions of the temporary file should be set. If
3248 ;; FILENAME does not exist (eq modes nil) it has been
3249 ;; renamed to the backup file. This case `save-buffer'
3250 ;; handles permissions.
3251 ;; Ensure that it is still readable.
3254 tmpfile
3257 ;; This is a bit lengthy due to the different methods
3258 ;; possible for file transfer. First, we check whether the
3259 ;; method uses an scp program. If so, we call it.
3260 ;; Otherwise, both encoding and decoding command must be
3261 ;; specified. However, if the method _also_ specifies an
3262 ;; encoding function, then that is used for encoding the
3263 ;; contents of the tmp file.
3269 ;; `copy-file' handles direct copy and out-of-band methods.
3279 ;; We keep the local file for performance
3280 ;; reasons, useful for "rsync".
3287 ;; Don't rename, in order to keep context in SELinux.
3292 ;; Use inline file transfer.
3294 ;; Encode tmpfile.
3298 ;; Use encoding function or command.
3301 "Encoding local file `%s' using `%s'"
3302 tmpfile loc-enc)
3304 ;; The following `let' is a workaround for
3305 ;; the base64.el that comes with pgnus-0.84.
3306 ;; If both of the following conditions are
3307 ;; satisfied, it tries to write to a local
3308 ;; file in default-directory, but at this
3309 ;; point, default-directory is remote.
3310 ;; (`call-process-region' can't write to
3311 ;; remote files, it seems.) The file in
3312 ;; question is a tmp file anyway.
3320 loc-enc tmpfile t))
3322 v 'file-error
3325 filename loc-enc))))
3327 ;; Send buffer into remote decoding command which
3328 ;; writes to remote file. Because this happens on
3329 ;; the remote host, we cannot use the function.
3332 "Decoding remote file `%s' using `%s'"
3333 filename rem-dec)
3337 v
3341 tramp-end-of-heredoc
3343 tramp-end-of-heredoc))
3345 v nil
3346 "Couldn't write region to `%s', decode using `%s' failed"
3347 filename rem-dec)
3348 ;; When `file-precious-flag' is set, the region is
3349 ;; written to a temporary file. Check that the
3350 ;; checksum is equal to that from the local tmpfile.
3354 ;; cksum runs locally, if possible.
3356 ;; cksum runs remotely.
3358 v
3361 ;; ... they are different.
3368 v 'file-error
3371 filename rem-dec)))))
3373 ;; Save exit.
3376 ;; That's not expected.
3379 v 'file-error
3382 method))))
3384 ;; Make `last-coding-system-used' have the right value.
3391 ;; We must protect `last-coding-system-used', now we have set it
3392 ;; to its correct value.
3394 ;; Set file modification time.
3398 ;; We must pass modtime explicitly, because FILENAME can
3399 ;; be different from (buffer-file-name), f.e. if
3400 ;; `file-precious-flag' is set.
3406 ;; Set the ownership.
3417 ;; VC backends check for the existence of various different special
3418 ;; files. This is very time consuming, because every single check
3419 ;; requires a remote command (the file cache must be invalidated).
3420 ;; Therefore, we apply a kind of optimization. We install the file
3421 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3422 ;; remembers all file names for which `file-exists-p' or
3423 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3424 ;; is performed. Afterwards, a script is applied for all collected
3425 ;; file names, using just one remote command. The result of this
3426 ;; script is used to fill the file cache with actual values. Now we
3427 ;; can reset the file name handlers, and we make a second run of
3428 ;; `vc-registered', which returns the expected result without sending
3429 ;; any other remote command.
3431 "Like `vc-registered' for Tramp files."
3437 ;; There could be new files, created by the vc backend. We
3438 ;; cannot reuse the old cache entries, therefore. In
3439 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3440 ;; could also be a timestamp as `current-time' returns. This
3441 ;; means invalidate all cache entries with an older timestamp.
3447 ;; Here we collect only file names, which need an operation.
3449 v "Error in 1st pass of `vc-registered': %s"
3453 ;; Send just one command, in order to fill the cache.
3456 v
3465 ;; We cannot use `tramp-send-command-and-read',
3466 ;; because this does not cooperate well with
3467 ;; heredoc documents.
3469 v
3472 tramp-end-of-heredoc
3474 tramp-vc-registered-file-names
3476 tramp-end-of-heredoc))
3478 ;; Read the expression.
3485 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3486 ;; calls shall be answered from the file cache. We unset
3487 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3488 ;; in order to keep the cache.
3490 remote-file-name-inhibit-cache process-file-side-effects)
3491 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3510 ;; Run.
3512 v "Error in 2nd pass of `vc-registered': %s"
3515 ;;;###tramp-autoload
3517 "Invoke remote-shell Tramp file name handler.
3518 Fall back to normal file name handler if no Tramp handler exists."
3524 ;; This must be the last entry, because `identity' always matches.
3525 ;;;###tramp-autoload
3530 "Invoke special file name handler, which collects files to be handled."
3538 ;; That's what we want: file names, for which checks are
3539 ;; applied. We assume that VC uses only `file-exists-p' and
3540 ;; `file-readable-p' checks; otherwise we must extend the
3541 ;; list. We do not perform any action, but return nil, in
3542 ;; order to keep `vc-registered' running.
3545 nil)
3546 ;; `process-file' and `start-file-process' shall be ignored.
3549 ;; Tramp file name handlers like `expand-file-name'. They
3550 ;; must still work.
3552 ;; Default file name handlers, we don't care.
3556 "Like `file-notify-add-watch' for Tramp files."
3560 command events filter p sequence)
3562 ;; "inotifywait".
3565 events
3575 ;; Make events a list of symbols.
3576 events
3580 ;; "gio monitor".
3583 events
3587 attribute-changed))
3592 ;; "gvfs-monitor-dir".
3595 events
3599 attribute-changed))
3604 ;; None.
3606 v 'file-notify-error
3607 "No file notification program found on %s"
3609 ;; Start process.
3611 'start-file-process
3615 sequence))
3616 ;; Return the process object as watch-descriptor.
3619 v 'file-notify-error
3620 "`%s' failed to start on remote host"
3624 ;; Needed for process filter.
3629 ;; There might be an error if the monitor is not supported.
3630 ;; Give the filter a chance to read the output.
3635 p))))
3648 ;; Fix action names.
3655 ;; https://bugs.launchpad.net/bugs/1742946
3664 string)
3670 proc
3673 ;; File names are returned as absolute paths. We must
3674 ;; add the remote prefix.
3678 ;; Remove watch when file or directory to be watched is deleted.
3682 ;; Usually, we would add an Emacs event now. Unfortunately,
3683 ;; `unread-command-events' does not accept several events at
3684 ;; once. Therefore, we apply the handler directly.
3687 'file-notify-handle-event
3690 ;; Save rest of the string.
3697 file-notify events."
3707 ;; Attribute change is returned in unused wording.
3717 string)
3722 proc
3727 ;; File names are returned as absolute paths. We must
3728 ;; add the remote prefix.
3732 ;; Remove watch when file or directory to be watched is deleted.
3736 ;; Usually, we would add an Emacs event now. Unfortunately,
3737 ;; `unread-command-events' does not accept several events at
3738 ;; once. Therefore, we apply the handler directly.
3741 'file-notify-handle-event
3744 ;; Save rest of the string.
3754 ;; Check, whether there is a problem.
3759 line)
3764 proc
3771 ;; Remove watch when file or directory to be watched is deleted.
3774 ;; Usually, we would add an Emacs event now. Unfortunately,
3775 ;; `unread-command-events' does not accept several events at
3776 ;; once. Therefore, we apply the handler directly.
3779 'file-notify-handle-event
3783 "Like `file-system-info' for Tramp files."
3790 "%s --block-size=1 --output=size,used,avail %s"
3800 ;; The second value is the used size. We need the
3801 ;; free size.
3806 ;;; Internal Functions:
3809 "Define in remote shell function NAME implemented as SCRIPT.
3810 Only send the definition if it has not already been done."
3811 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3812 ;; might be nil.
3818 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3819 ;; could result in unwanted command expansion. Avoid this.
3822 ;; The script could contain a call of Perl. This is masked with `%s'.
3827 vec
3835 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3836 Returns the exit code of the `test' program."
3839 v
3841 "%s %s %s"
3843 switch
3847 "Run `test'-like program on the remote system, given FILE1, FILE2.
3848 FORMAT-STRING contains the program name, switches, and place holders.
3849 Returns the exit code of the `test' program. Barfs if the methods,
3850 hosts, or files, disagree."
3854 v 'file-error
3859 v1
3866 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3867 First arg VEC specifies the connection, PROGNAME is the program
3868 to search for, and DIRLIST gives the list of directories to
3869 search. If IGNORE-TILDE is non-nil, directory names starting
3870 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3871 only in DIRLIST.
3873 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3875 This function expects to be in the right *tramp* buffer."
3878 ;; Check whether the executable is in $PATH. "which(1)" does not
3879 ;; report always a correct error code; therefore we check the
3880 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3881 ;; 5.11") have problems with this command, we disable the call
3882 ;; therefore.
3893 ;; Remove all ~/foo directories from dirlist.
3902 vec
3904 "do if test -x $d/%s && test -f $d/%s; "
3905 "then echo tramp_executable $d/%s; "
3908 progname progname progname
3909 tramp-end-of-heredoc
3911 tramp-end-of-heredoc))
3917 result)))
3920 "Sets the remote environment PATH to existing directories.
3921 I.e., for each directory in `tramp-remote-path', it is tested
3922 whether it exists and if so, it is added to the environment
3923 variable PATH."
3929 ;; ------------------------------------------------------------
3930 ;; -- Communication with external shell --
3931 ;; ------------------------------------------------------------
3934 "Find a command on the remote host for checking if a file exists.
3935 Here, we are looking for a command which has zero exit status if the
3936 file exists and nonzero exit status otherwise."
3940 result)
3941 ;; The algorithm is as follows: we try a list of several commands.
3942 ;; For each command, we first run `$cmd /' -- this should return
3943 ;; true, as the root directory always exists. And then we run
3944 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3945 ;; does not exist. This should return false. We use the first
3946 ;; command we find that seems to work.
3947 ;; The list of commands to try is as follows:
3948 ;; `ls -d' This works on most systems, but NetBSD 1.4
3949 ;; has a bug: `ls' always returns zero exit
3950 ;; status, even for files which don't exist.
3951 ;; `test -e' Some Bourne shells have a `test' builtin
3952 ;; which does not know the `-e' option.
3953 ;; `/bin/test -e' For those, the `test' binary on disk normally
3954 ;; provides the option. Alas, the binary
3955 ;; is sometimes `/bin/test' and sometimes it's
3956 ;; `/usr/bin/test'.
3957 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3985 result))
3988 "Opens shell SHELL."
3991 ;; Find arguments for this shell.
3993 item extra-args)
3998 ;; It is useful to set the prompt in the following command
3999 ;; because some people have a setting for $PS1 which /bin/sh
4000 ;; doesn't know about and thus /bin/sh will display a strange
4001 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4002 ;; ksh will display the current working directory but /bin/sh
4003 ;; will display a dollar sign. The following command line sets
4004 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4005 ;; well as csh-like shells. We also unset the variable $ENV
4006 ;; because that is read by some sh implementations (eg, bash
4007 ;; when called as sh) on startup; this way, we avoid the startup
4008 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4009 ;; the prompt in /bin/bash, it must be discarded as well.
4010 ;; $HISTFILE is set according to `tramp-histfile-override'.
4011 ;; $TERM and $INSIDE_EMACS set here to ensure they have the
4012 ;; correct values when the shell starts, not just processes
4013 ;; run within the shell. (Which processes include our
4014 ;; initial probes to ensure the remote shell is usable.)
4018 "exec env TERM='%s' INSIDE_EMACS='%s,tramp:%s' "
4020 tramp-terminal-type
4021 emacs-version tramp-version ; INSIDE_EMACS
4027 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4031 t)
4032 ;; Check proper HISTFILE setting. We give up when not working.
4036 vec
4038 "(cd %s)"
4041 "`tramp-histfile-override' uses invalid file `%s'"
4042 tramp-histfile-override)))
4048 "Opens a shell on the remote host which groks tilde expansion."
4051 shell)
4054 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4055 ;; Which check could we apply instead?
4058 ;; The default shell (ksh93) of OpenSolaris and
4059 ;; Solaris is buggy. We've got reports for
4060 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4069 ;; Maybe it works at least for some other commands.
4071 default-shell
4073 vec 2
4075 "Couldn't find a remote shell which groks tilde "
4077 default-shell)))
4079 default-shell)))
4081 ;; Open a new shell if needed.
4087 ;; Utility functions.
4090 "Wait for shell prompt and barf if none appears.
4091 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4092 seconds. If not, it produces an error message with the given ERROR-ARGS."
4096 proc timeout
4105 "Set up an interactive shell.
4106 Mainly sets the prompt and the echo correctly. PROC is the shell
4107 process to set up. VEC specifies the connection."
4112 ;; Disable echo expansion.
4116 ;; Check whether the echo has really been disabled. Some
4117 ;; implementations, like busybox of embedded GNU/Linux, don't
4118 ;; support disabling.
4125 ;; Make sure backspaces and their echo are enabled and no line
4126 ;; width magic interferes with them.
4133 t)
4135 ;; Check whether the output of "uname -sr" has been changed. If
4136 ;; yes, this is a strong indication that we must expire all
4137 ;; connection properties. We start again with
4138 ;; `tramp-maybe-open-connection', it will be caught there.
4143 vec "uname"
4147 vec 3
4148 "Connection reset, because remote host changed from `%s' to `%s'"
4149 old-uname uname)
4150 ;; We want to keep the password.
4154 ;; Try to set up the coding system correctly.
4155 ;; CCC this can't be the right way to do it. Hm.
4158 ;; Use MULE to select the right EOL convention for communicating
4159 ;; with the process.
4165 cs-decode cs-encode)
4169 cs-encode
4176 ;; Special setting for macOS.
4187 ;; Check whether the remote host suffers from buggy
4188 ;; `send-process-string'. This is known for FreeBSD (see comment
4189 ;; in `send_process', file process.c). I've tested sending 624
4190 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4191 ;; hack when this host type is detected locally. It cannot handle
4192 ;; remote hosts, though.
4196 tramp-chunksize)
4202 ;; Set remote PATH variable.
4205 ;; Search for a good shell before searching for a command which
4206 ;; checks if a file exists. This is done because Tramp wants to
4207 ;; use "test foo; echo $?" to check if various conditions hold,
4208 ;; and there are buggy /bin/sh implementations which don't execute
4209 ;; the "echo $?" part if the "test" part has an error. In
4210 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4211 ;; also other problems with /bin/sh of OpenSolaris, like
4212 ;; redirection of stderr in function declarations, or changing
4213 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4214 ;; by bash, when detected.
4217 ;; Disable unexpected output.
4220 ;; IRIX64 bash expands "!" even when in single quotes. This
4221 ;; destroys our shell functions, we must disable it. See
4222 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4226 ;; Disable tab expansion.
4231 ;; Set utf8 encoding. Needed for macOS, for example. This is
4232 ;; non-POSIX, so we must expect errors on some systems.
4235 ;; Set `remote-tty' process property.
4241 ;; Dump stty settings in the traces.
4245 ;; Set the environment.
4259 vec
4262 tramp-end-of-heredoc
4264 tramp-end-of-heredoc)
4265 t))
4270 ;; Old text from documentation of tramp-methods:
4271 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4272 ;; of the base64 methods instead since base64 encoding is much more
4273 ;; reliable and the commands are more standardized between the different
4274 ;; Unix versions. But if you can't use base64 for some reason, please
4275 ;; note that the default uudecode command does not work well for some
4276 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4277 ;; the following command for uudecode:
4278 ;;
4279 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4280 ;;
4281 ;; For Irix, no solution is known yet.
4289 "List of local coding commands for inline transfer.
4290 Each item is a list that looks like this:
4292 \(FORMAT ENCODING DECODING)
4294 FORMAT is symbol describing the encoding/decoding format. It can be
4295 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4297 ENCODING and DECODING can be strings, giving commands, or symbols,
4298 giving functions. If they are strings, then they can contain
4300 file name will be put into the command line at that spot. If the
4301 specifier is not present, the input should be read from standard
4302 input.
4304 If they are functions, they will be called with two arguments, start
4305 and end of region, and are expected to replace the region contents
4310 ;; "-i" is more robust with older base64 from GNU coreutils.
4311 ;; However, I don't know whether all base64 versions do supports
4312 ;; this option.
4320 ;; This is painful slow, so we put it on the end.
4327 "List of remote coding commands for inline transfer.
4328 Each item is a list that looks like this:
4330 \(FORMAT ENCODING DECODING [TEST])
4332 FORMAT is a symbol describing the encoding/decoding format. It can be
4333 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4335 ENCODING and DECODING can be strings, giving commands, or symbols,
4336 giving variables. If they are strings, then they can contain
4338 file name will be put into the command line at that spot. If the
4339 specifier is not present, the input should be read from standard
4340 input.
4342 If they are variables, this variable is a string containing a
4343 Perl or Shell implementation for this functionality. This
4344 program will be transferred to the remote host, and it is
4346 specifier in the variable value denotes a temporary file.
4348 The optional TEST command can be used for further tests, whether
4352 "Find an inline transfer encoding that works.
4353 Goes through the list `tramp-local-coding-commands' and
4354 `tramp-remote-coding-commands'."
4359 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4367 ;; If the local encoder or decoder is a string, the
4368 ;; corresponding command has to work locally.
4375 loc-enc nil nil))
4383 loc-dec nil nil))
4385 ;; Search for remote coding commands with the same format
4393 ;; Check the remote test command if exists.
4399 ;; Check if remote perl exists when necessary.
4404 ;; Check if remote encoding and decoding commands can be
4405 ;; called remotely with null input and output. This makes
4406 ;; sure there are no syntax errors and the command is really
4407 ;; found. Note that we do not redirect stdout to /dev/null,
4408 ;; for two reasons: when checking the decoding command, we
4409 ;; actually check the output it gives. And also, when
4410 ;; redirecting "mimencode" output to /dev/null, then as root
4411 ;; it might change the permissions of /dev/null!
4419 vec 5
4428 tmpfile)
4435 tramp-temp-name-prefix
4437 value
4439 value
4441 ?t
4446 vec 5
4449 vec
4451 t)
4459 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4465 ;; Set connection properties. Since the commands are risky
4466 ;; (due to output direction), we cache them in the process cache.
4477 "Call the local encoding or decoding command.
4479 Otherwise, INPUT is passed via standard input.
4480 INPUT can also be nil which means `/dev/null'.
4481 OUTPUT can be a string (which specifies a file name), or t (which
4482 means standard output and thus the current buffer), or nil (which
4483 means discard it)."
4485 nil tramp-encoding-shell
4488 nil
4489 tramp-encoding-command-switch
4499 "List of compress and decompress commands for inline transfer.
4500 Each item is a list that looks like this:
4502 \(COMPRESS DECOMPRESS)
4507 "Find an inline transfer compress command that works.
4508 Goes through the list `tramp-inline-compress-commands'."
4513 item compress decompress found)
4520 vec 5
4521 "Checking local compress commands `%s', `%s' for sanity"
4522 compress decompress)
4527 "echo %s | %s | %s" magic
4528 ;; Windows shells need the program file name after
4529 ;; the pipe symbol be quoted if they use forward
4530 ;; slashes as directory separators.
4535 nil nil))
4538 vec 5
4539 "Checking remote compress commands `%s', `%s' for sanity"
4540 compress decompress)
4546 ;; Did we find something?
4549 ;; Set connection properties. Since the commands are
4550 ;; risky (due to output direction), we cache them in the
4551 ;; process cache.
4565 "Expands VEC according to `tramp-default-proxies-alist'."
4569 choices proxy)
4571 ;; Ad-hoc proxy definitions.
4576 tramp-prefix-format proxy tramp-postfix-host-format)))
4581 proxy)
4582 ;; Add the hop.
4584 'tramp-default-proxies-alist
4587 proxy))
4589 ;; Save the new value.
4594 ;; Look for proxy hosts to be passed.
4600 ;; Host.
4603 ;; User.
4607 ;; No more hops needed.
4609 ;; Replace placeholders.
4612 proxy
4617 ;; Add the hop.
4619 ;; Start next search.
4622 ;; Foreign and out-of-band methods are not supported for multi-hops.
4629 vec 'file-error
4630 "Method `%s' is not supported for multi-hops."
4633 ;; Some methods ("su", "sg", "sudo", "doas", "ksu") do not use the
4634 ;; host name in their command template. In this case, the remote
4635 ;; file name must use either a local host name (first hop), or a
4636 ;; host name matching the previous hop.
4643 ;; The host name is used for the remote shell command.
4646 ;; The host name must match previous hop.
4652 ;; Result.
4653 target-alist))
4656 "Return the Control* arguments of the local ssh."
4658 ;; No options to be computed.
4663 ;; There is already a value to be used.
4666 ;; Determine the options.
4681 ;; We use a non-existing IP address, in order to
4682 ;; avoid useless connections, and DNS timeouts.
4683 ;; Setting ConnectTimeout is needed since OpenSSH 7.
4685 vec "ssh" nil t nil
4691 " -o ControlPath='tramp.%%r@%%h:%%p'"
4700 tramp-ssh-controlmaster-options)))
4703 "Maybe open a connection VEC.
4704 Does not do anything if a connection is already open, but re-opens the
4705 connection if a previous connection has died for some reason."
4711 ;; If Tramp opens the same connection within a short time frame,
4712 ;; there is a problem. We shall signal this.
4721 ;; If too much time has passed since last command was sent, look
4722 ;; whether process is still alive. If it isn't, kill it. When
4723 ;; using ssh, it can sometimes happen that the remote end has hung
4724 ;; up but the local ssh client doesn't recognize this until it
4725 ;; tries to send some data to the remote end. So that's why we
4726 ;; try to send a command from time to time, then look again
4727 ;; whether the process is really alive.
4738 ;; The error will be caught locally.
4744 ;; New connection must be opened.
4748 ;; During completion, don't reopen a new connection. We
4749 ;; check this for the process related to
4750 ;; `tramp-buffer-name'; otherwise `start-file-process'
4751 ;; wouldn't run ever when `non-essential' is non-nil.
4757 vec 3
4768 ;; Start new process.
4786 ;; We will apply `tramp-ssh-controlmaster-options'
4787 ;; only for the first hop.
4791 ;; There are unfortunate settings for "cmdproxy" on
4792 ;; W32 systems.
4795 ;; This must be done in order to avoid our file
4796 ;; name handler.
4800 'start-process
4805 tramp-encoding-command-interactive)
4808 ;; Set sentinel and query flag. Initialize variables.
4818 ;; Check whether process is alive.
4820 p 10
4823 ;; Now do all the connections as specified.
4843 ;; We don't create the temporary file. In
4844 ;; fact, it is just a prefix for the
4845 ;; ControlPath option of ssh; the real
4846 ;; temporary file has another name, and it is
4847 ;; created and protected by ssh. It is also
4848 ;; removed by ssh when the connection is
4849 ;; closed. The temporary file name is cached
4850 ;; in the main connection process, therefore
4851 ;; we cannot use `tramp-get-connection-process'.
4857 tramp-temp-name-prefix
4859 spec r-shell)
4861 ;; Add arguments for asynchronous processes.
4865 ;; Check, whether there is a restricted shell.
4871 ;; Set password prompt vector.
4873 p "password-vector"
4878 ;; Add login environment.
4881 login-env
4886 login-env))
4890 "%s=%s %s"
4893 command)))
4896 ;; Replace `login-args' place holders.
4904 ?h l-host ?u l-user ?p l-port ?c options)
4905 command
4907 ;; We do not want to see the trailing local
4908 ;; prompt in `start-file-process'.
4910 command " "
4916 ;; Local shell could be a Windows COMSPEC. It
4917 ;; doesn't know the ";" syntax, but we must exit
4918 ;; always for `start-file-process'. It could
4919 ;; also be a restricted shell, which does not
4920 ;; allow "exec".
4923 ;; Send the command.
4927 p vec
4930 tramp-actions-before-shell
4934 ;; Next hop.
4938 ;; Set connection-local variables.
4941 ;; Make initial shell settings.
4944 ;; Mark it as connected.
4947 ;; Cleanup, and propagate the signal.
4953 "Send the COMMAND to connection VEC.
4954 Erases temporary buffer before sending the command. If optional
4955 arg NEVEROPEN is non-nil, never try to open the connection. This
4956 is meant to be used from `tramp-maybe-open-connection' only. The
4957 function waits for output unless NOOUTPUT is set."
4961 ;; We mark the command string that it can be erased in the output buffer.
4963 ;; If we put `tramp-echo-mark' after a trailing newline (which
4964 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4965 ;; that newline and adds `tramp-rsh-end-of-line' right after
4966 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4967 ;; trailing line endings and sends two prompts after executing
4968 ;; the command, which confuses `tramp-wait-for-output'.
4972 ;; No need to restore a trailing newline here since `tramp-send-string'
4973 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4975 ;; Send the command.
4981 "Wait for output from remote command."
4987 ;; be leading escape sequences, which must be ignored.
4988 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4989 ;; option send also escape sequences, which must be
4990 ;; ignored.
4993 tramp-device-escape-sequence-regexp))
4994 ;; Sometimes, the commands do not return a newline but a
4995 ;; null byte before the shell prompt, for example "git
4996 ;; ls-files -c -z ...".
5001 ;; A simple-minded busybox has sent " ^H" sequences.
5002 ;; Delete them.
5007 ;; Delete the prompt.
5013 proc 'file-error
5014 "[[Remote prompt `%s' not found in %d secs]]"
5015 tramp-end-of-output timeout)
5017 proc 'file-error
5019 ;; Return value is whether end-of-output sentinel was found.
5020 found)))
5024 "Run COMMAND and check its exit status.
5025 Sends `echo $?' along with the COMMAND for checking the exit status.
5026 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5027 status is 0, and nil otherwise.
5029 If the optional argument SUBSHELL is non-nil, the command is
5030 executed in a subshell, ie surrounded by parentheses. If
5031 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5033 vec
5035 command
5037 "echo tramp_exit_status $?"
5051 "Run COMMAND, check exit status, throw error if exit status not okay.
5052 Similar to `tramp-send-command-and-check' but accepts two more arguments
5053 FMT and ARGS which are passed to `error'."
5058 "Run COMMAND and return the output, which must be a Lisp expression.
5059 If MARKER is a regexp, read the output after that string.
5060 In case there is no valid Lisp expression and NOERROR is nil, it
5061 raises an error."
5068 ;; Read the marker.
5074 vec 'file-error
5075 "`%s' does not return the marker `%s': `%s'"
5077 ;; Read the expression.
5080 ;; Error handling.
5085 vec 'file-error
5086 "`%s' does not return a valid Lisp expression: `%s'"
5090 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5091 Convert file mode bits to string and set virtual device number.
5092 Return ATTR."
5094 ;; Remove color escape sequences from symlink.
5098 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5099 ;; indication of unusable value.
5110 ;; Convert last access time.
5115 ;; Convert last modification time.
5120 ;; Convert last status change time.
5125 ;; Convert file size.
5131 ;; Convert file mode bits to string.
5136 ;; Convert directory indication bit.
5139 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5145 ;; Set file's gid change bit.
5153 ;; Convert inode.
5158 middle low)
5161 ;; The low 16 bits.
5166 ;; The middle 24 bits.
5170 ;; Inodes can be incredible huge. We must hide this.
5172 ;; Set virtual device number.
5175 attr))
5178 "Converts STRING to shell glob pattern which ignores case."
5184 string
5188 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5200 localname)
5206 "Return t if this is an out-of-band method, nil otherwise."
5208 ;; It shall be an out-of-band method.
5210 ;; There must be a size, otherwise the file doesn't exist.
5212 ;; Either the file size is large enough, or (in rare cases) there
5213 ;; does not exist a remote encoding.
5218 ;; Variables local to connection.
5221 "Compile list of remote directories for $PATH.
5222 Nonexistent directories are removed from spec."
5224 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5225 ;; cache the result for the session only. Otherwise, the result
5226 ;; is cached persistently.
5229 vec)
5230 "remote-path"
5239 ;; Default if "getconf" is not available.
5242 vec 3
5247 ;; The login shell could return more than just the $PATH
5248 ;; string. So we use `tramp-end-of-heredoc' as marker.
5252 vec
5257 'identity
5261 'identity
5269 nil)))))
5271 ;; Replace place holder `tramp-default-remote-path'.
5279 ;; Replace place holder `tramp-own-remote-path'.
5287 ;; Remove double entries.
5294 ;; Remove non-existing directories.
5296 nil
5302 x))
5303 remote-path)))))
5306 "Determine remote locale, supporting UTF8 if possible."
5310 locale)
5317 candidates nil)
5319 ;; Return value.
5323 "Determine remote `ls' command."
5330 result)
5332 ;; Check parameters. On busybox, "ls" output coloring is
5333 ;; enabled by default sometimes. So we try to disable it
5334 ;; when possible. $LS_COLORING is not supported there.
5335 ;; Some "ls" versions are sensible wrt the order of
5336 ;; arguments, they fail when "-al" is after the
5337 ;; "--color=never" argument (for example on FreeBSD).
5349 "Return OPTION, if the remote `ls' command supports the OPTION option."
5353 ;; Some "ls" versions are sensible wrt the order of arguments,
5354 ;; they fail when "-al" is after the "--dired" argument (for
5355 ;; example on FreeBSD).
5359 option))))
5362 "Determine remote `test' command."
5366 "test"
5370 "Check, whether the remote `test' command supports the -nt option."
5371 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5372 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5373 ;; for otherwise the shell crashes.
5385 vec
5392 "Determine remote command for file existing check."
5398 "Determine remote `ln' command."
5404 "Determine remote `perl' command."
5410 ;; Perform a basic check.
5415 ;; We must check also for some Perl modules.
5423 result)))
5426 "Determine remote `stat' command."
5431 tmp)
5432 ;; Check whether stat(1) returns usable syntax. "%s" does not
5433 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5434 ;; use shell quoted format for "%N", we check the boundaries "`"
5435 ;; and "'", therefore. See Bug#23422 in coreutils.
5436 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5437 ;; supported.
5446 result)))
5449 "Determine remote `readlink' command."
5457 result))))
5460 "Determine remote `trash' command.
5461 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5468 "Determine remote `touch' command."
5477 ;; Busyboxes do support the "-t" option only when they have been
5478 ;; built with the DESKTOP config option. Let's check it.
5481 vec "touch-t"
5483 vec
5485 "%s -t %s %s"
5486 result
5490 result)))
5493 "Determine remote `df' command."
5498 result
5501 result))))
5504 "Determine remote `gio-monitor' command."
5510 "Determine remote `gvfs-monitor-dir' command."
5513 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5514 ;; establish better timeouts in filenotify-tests.el. Any better
5515 ;; distinction approach would be welcome!
5522 "Determine remote `inotifywait' command."
5528 "Determine remote `id' command."
5534 result)
5536 ;; Check POSIX parameter.
5542 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5544 vec
5552 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5554 vec
5558 "print $>"
5562 "Determine remote `python' command."
5570 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5572 vec
5576 "import os; print (os.getuid())"
5580 "The uid of the remote connection VEC, in ID-FORMAT.
5581 ID-FORMAT valid values are `string' and `integer'."
5592 ;; Ensure there is a valid result.
5595 tramp-unknown-id-integer)
5597 tramp-unknown-id-string)
5601 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5603 vec
5611 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5613 vec
5621 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5623 vec
5627 "import os; print (os.getgid())"
5631 "The gid of the remote connection VEC, in ID-FORMAT.
5632 ID-FORMAT valid values are `string' and `integer'."
5643 ;; Ensure there is a valid result.
5646 tramp-unknown-id-integer)
5648 tramp-unknown-id-string)
5652 "Check, whether the remote `env' command supports the -u option."
5655 ;; Option "-u" is a GNU extension.
5659 ;; Some predefined connection properties.
5661 "Return the compress command related to PROP.
5662 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5663 the length of the file to be compressed.
5665 If no corresponding command is found, nil is returned."
5674 "Return the coding command related to PROP.
5675 PROP is either `remote-encoding', `remote-decoding',
5676 `local-encoding' or `local-decoding'.
5678 SIZE is the length of the file to be coded. Depending on SIZE,
5679 compression might be applied.
5681 If no corresponding command is found, nil is returned.
5682 Otherwise, either a string is returned which contains a `%s' mark
5683 to be used for the respective input or output file; or a Lisp
5684 function cell is returned to be applied on a buffer."
5685 ;; We must catch the errors, because we want to return nil, when
5686 ;; no inline coding is found.
5696 compress)
5697 ;; The connection property might have been cached. So we must
5698 ;; send the script to the remote side - maybe.
5706 ;; Check for the `compress' command.
5708 ;; Return the value.
5729 coding)
5732 ;; Windows shells need the program file name after
5733 ;; the pipe symbol be quoted if they use forward
5734 ;; slashes as directory separators.
5741 coding compress))
5744 ;; Windows shells need the program file name after
5745 ;; the pipe symbol be quoted if they use forward
5746 ;; slashes as directory separators.
5751 compress coding))
5765 ;;; TODO:
5767 ;; * Don't use globbing for directories with many files, as this is
5768 ;; likely to produce long command lines, and some shells choke on
5769 ;; long command lines.
5770 ;;
5771 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5772 ;; then look if it's the right version (with `perl -v').
5773 ;;
5774 ;; * When editing a remote CVS controlled file as a different user, VC
5775 ;; gets confused about the file locking status. Try to find out why
5776 ;; the workaround doesn't work.
5777 ;;
5778 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5779 ;; until the last but one hop via `start-file-process'. Apply it
5780 ;; also for ftp and smb.
5781 ;;
5782 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5783 ;; some shell with root privileges, it would be nice if I could
5784 ;; just call
5785 ;; trampclient filename.c
5786 ;; as an editor, and the _current_ shell would connect to an Emacs
5787 ;; server and would be used in an existing non-privileged Emacs
5788 ;; session for doing the editing in question.
5789 ;; That way, I need not tell Emacs my password again and be afraid
5790 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5791 ;; once display a just typed password in the context of a keyboard
5792 ;; sequence prompt for a question immediately following in a shell
5793 ;; script run within Emacs -- nasty).
5794 ;; And if I have some ssh session running to a different computer,
5795 ;; having the possibility of passing a local file there to a local
5796 ;; Emacs session (in case I can arrange for a connection back) would
5797 ;; be nice.
5798 ;; Likely the corresponding Tramp server should not allow the
5799 ;; equivalent of the emacsclient -eval option in order to make this
5800 ;; reasonably unproblematic. And maybe trampclient should have some
5801 ;; way of passing credentials, like by using an SSL socket or
5802 ;; something. (David Kastrup)
5803 ;;
5804 ;; * Reconnect directly to a compliant shell without first going
5805 ;; through the user's default shell. (Pete Forman)
5806 ;;
5807 ;; * Avoid the local shell entirely for starting remote processes. If
5808 ;; so, I think even a signal, when delivered directly to the local
5809 ;; SSH instance, would correctly be propagated to the remote process
5810 ;; automatically; possibly SSH would have to be started with
5811 ;; "-t". (Markus Triska)
5812 ;;
5813 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5814 ;; isn't on the remote host. (Mark A. Hershberger)
5815 ;;
5816 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5817 ;;
5818 ;; * Optimize out-of-band copying when both methods are scp-like (not
5819 ;; rsync).
5820 ;;
5821 ;; * Keep a second connection open for out-of-band methods like scp or
5822 ;; rsync.
5823 ;;
5824 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5825 ;;
5826 ;; * I think you could get the best of both worlds by using an
5827 ;; approach similar to Tramp but running a little tramp-daemon on
5828 ;; the other end, such that we can use a more efficient
5829 ;; communication protocol (e.g. when saving a file we could locally
5830 ;; diff it against the last version (of which the remote daemon
5831 ;; would also keep a copy), and then only send the diff).
5832 ;;
5833 ;; This said, even using such a daemon it might be difficult to get
5834 ;; good performance: part of the problem is the number of
5835 ;; round-trips. E.g. when saving a file we have to check if the
5836 ;; file was modified in the mean time and whether saving into a new
5837 ;; inode would change the owner (etc...), which each require a
5838 ;; round-trip. To get rid of these round-trips, we'd have to
5839 ;; shortcut this code and delegate the higher-level "save file"
5840 ;; operation to the remote server, which then has to perform those
5841 ;; tasks but still obeying the locally set customizations about how
5842 ;; to do each one of those tasks.
5843 ;;
5844 ;; We could either put higher-level ops in there (like
5845 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5846 ;; behavior, which is a lot of work and likely to be not 100%
5847 ;; faithful.
5848 ;;
5849 ;; Or we could introduce new low-level ops that are asynchronous,
5850 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5851 ;; start with a bunch of calls like `start-getting-file-attributes'
5852 ;; which could immediately be passed on to the remote side, and
5853 ;; later on checks the return value of those calls as and when
5854 ;; needed. (Stefan Monnier)
5856 ;;; tramp-sh.el ends here