| blob | 63b39a0378e7bd168aa074fcafb895182566c1cf |
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."
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."
61 ;;;###tramp-autoload
63 "Value of TERM environment variable for logging in to remote host.
64 Because Tramp wants to parse the output of the remote shell, it is easily
65 confused by ANSI color escape sequences and suchlike. Often, shell init
66 files conditionalize this setup based on the TERM environment variable."
70 ;;;###tramp-autoload
72 "When invoking a shell, override the HISTFILE with this value.
73 When setting to a string, it redirects the shell history to that
77 The value t unsets any setting of HISTFILE, and sets both
78 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
79 however, the *override* is disabled, so the history will go to
87 ;;;###tramp-autoload
91 ;;;###tramp-autoload
95 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
96 ;; root users. It uses the `$' character for other users. In order
97 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
101 "///%s#$"
103 "String used to recognize end of output.
104 The `$' character at the end is quoted; the string cannot be
107 ;;;###tramp-autoload
114 ;;;###tramp-autoload
116 "Whether to use `tramp-ssh-controlmaster-options'."
122 "Which ssh Control* arguments to use.
124 If it is a string, it should have the form
127 spec must be doubled, because the string is used as format string.
129 Otherwise, it will be auto-detected by Tramp, if
130 `tramp-use-ssh-controlmaster-options' is non-nil. The value
131 depends on the installed local ssh version.
135 ;; Initialize `tramp-methods' with the supported methods.
136 ;;;###tramp-autoload
148 ;;;###tramp-autoload
159 ;;;###tramp-autoload
173 ;;;###tramp-autoload
188 ;;;###tramp-autoload
204 ;;;###tramp-autoload
212 ;;;###tramp-autoload
220 ;;;###tramp-autoload
230 ;;;###tramp-autoload
240 ;;;###tramp-autoload
248 ;;;###tramp-autoload
257 ;; We use "-v" for better error tracking.
260 ;; We use "-p" as required for newer busyboxes. For older
261 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
262 ;; can be achieved by tweaking `tramp-connection-properties'.
264 ;;;###tramp-autoload
273 ;;;###tramp-autoload
275 'tramp-methods
282 ;;;###tramp-autoload
286 ;; The password template must be masked. Otherwise, it could be
287 ;; interpreted as password prompt if the remote host echoes the command.
290 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
296 ;;;###tramp-autoload
304 ;;;###tramp-autoload
313 ;;;###tramp-autoload
321 ;;;###tramp-autoload
328 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
329 tramp-terminal-type
330 tramp-initial-end-of-output))
335 ;;;###tramp-autoload
341 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
342 tramp-terminal-type
343 tramp-initial-end-of-output))
348 ;;;###tramp-autoload
355 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
356 tramp-terminal-type
357 tramp-initial-end-of-output))
367 ;;;###tramp-autoload
374 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
375 tramp-terminal-type
376 tramp-initial-end-of-output))
385 ;;;###tramp-autoload
397 ;;;###tramp-autoload
401 ;;;###tramp-autoload
405 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
406 ;; Do not add "plink" based methods, they ask interactively for the user.
407 ;;;###tramp-autoload
416 ;;;###tramp-autoload
422 ;;;###tramp-autoload
438 ;;;###tramp-autoload
443 ;;;###tramp-autoload
448 ;;;###tramp-autoload
453 ;;;###tramp-autoload
461 ;;;###tramp-autoload
490 ;; "getconf PATH" yields:
491 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
492 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
493 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
494 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
495 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
496 ;; IRIX64: /usr/bin
497 ;; QNAP QTS: ---
498 ;;;###tramp-autoload
504 "List of directories to search for executables on remote host.
505 For every remote host, this variable will be set buffer local,
506 keeping the list of existing directories on that host.
508 You can use `~' in this list, but when searching for a shell which groks
509 tilde expansion, all directory names starting with `~' will be ignored.
511 `Default Directories' represent the list of directories given by
513 entry on head of this list, because these are the default
514 directories for POSIX compatible commands. On remote hosts which
515 do not offer the getconf command (like cygwin), the value
517 the list by the special value `tramp-default-remote-path'.
519 `Private Directories' are the settings of the $PATH environment,
520 as given in your `~/.profile'. This entry is represented in
521 the list by the special value `tramp-own-remote-path'."
528 ;;;###tramp-autoload
533 "List of environment variables to be set on the remote host.
535 Each element should be a string of the form ENVVARNAME=VALUE. An
536 entry ENVVARNAME= disables the corresponding environment variable,
537 which might have been set in the init files like ~/.profile.
539 Special handling is applied to some environment variables,
540 which should not be set here:
542 The PATH environment variable should be set via `tramp-remote-path'.
544 The TERM environment variable should be set via `tramp-terminal-type'.
546 The INSIDE_EMACS environment variable will automatically be set
547 based on the TRAMP and Emacs versions, and should not be set here."
552 ;;;###tramp-autoload
554 "Alist specifying extra arguments to pass to the remote shell.
555 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
556 matching the shell file name and ARGS is a string specifying the
557 arguments.
559 This variable is only used when Tramp needs to start up another shell
560 for tilde expansion. The extra arguments should typically prevent the
561 shell from reading its init file."
575 "List of pattern/action pairs.
576 Whenever a pattern matches, the corresponding action is performed.
577 Each item looks like (PATTERN ACTION).
579 The PATTERN should be a symbol, a variable. The value of this
580 variable gives the regular expression to search for. Note that the
582 appended to it.
584 The ACTION should also be a symbol, but a function. When the
592 "List of pattern/action pairs.
593 This list is used for copying/renaming with out-of-band methods.
598 "(echo begin 600 %t; tail -n +2) | uudecode
599 cat %t
600 rm -f %t"
601 "Shell function to implement `uudecode' to standard output.
602 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
603 for this or `uudecode -p', but some systems don't, and for them
607 "%s -e '
608 use File::Spec;
611 sub myrealpath {
612 my ($file) = @_;
613 return realpath($file) if (-e $file || -l $file);
614 }
616 sub recursive {
617 my ($volume, @dirs) = @_;
618 my $real = myrealpath(File::Spec->catpath(
620 if ($real) {
621 my ($vol, $dir) = File::Spec->splitpath($real, 1);
622 return ($vol, File::Spec->splitdir($dir));
623 }
624 else {
625 my $last = pop(@dirs);
626 ($volume, @dirs) = recursive($volume, @dirs);
627 push(@dirs, $last);
628 return ($volume, @dirs);
629 }
630 }
632 $result = myrealpath($ARGV[0]);
633 if (!$result) {
634 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
635 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
638 }
643 "Perl script to produce output suitable for use with `file-truename'
644 on the remote file system.
645 Escape sequence %s is replaced with name of Perl binary.
649 "%s -e '
651 @files = readdir(d); closedir(d);
652 foreach $f (@files) {
655 }
656 else {
658 }
659 }
662 "Perl script to produce output suitable for use with
663 `file-name-all-completions' on the remote file system. Escape
664 sequence %s is replaced with name of Perl binary. This string is
667 ;; Perl script to implement `file-attributes' in a Lisp `read'able
668 ;; output. If you are hacking on this, note that you get *no* output
669 ;; unless this spits out a complete line, including the '\n' at the
670 ;; end.
671 ;; The device number is returned as "-1", because there will be a virtual
672 ;; device number set in `tramp-sh-handle-file-attributes'.
674 "%s -e '
675 @stat = lstat($ARGV[0]);
676 if (!@stat) {
678 exit 0;
679 }
680 if (($stat[2] & 0170000) == 0120000)
681 {
682 $type = readlink($ARGV[0]);
685 }
686 elsif (($stat[2] & 0170000) == 040000)
687 {
689 }
690 else
691 {
693 };
696 printf(
698 $type,
699 $stat[3],
700 $uid,
701 $gid,
702 $stat[8] >> 16 & 0xffff,
703 $stat[8] & 0xffff,
704 $stat[9] >> 16 & 0xffff,
705 $stat[9] & 0xffff,
706 $stat[10] >> 16 & 0xffff,
707 $stat[10] & 0xffff,
708 $stat[7],
709 $stat[2],
710 $stat[1] >> 16 & 0xffff,
711 $stat[1] & 0xffff
713 "Perl script to produce output suitable for use with `file-attributes'
714 on the remote file system.
715 Escape sequence %s is replaced with name of Perl binary.
719 "%s -e '
722 @list = readdir(DIR);
723 closedir(DIR);
724 $n = scalar(@list);
726 for($i = 0; $i < $n; $i++)
727 {
728 $filename = $list[$i];
729 @stat = lstat($filename);
730 if (($stat[2] & 0170000) == 0120000)
731 {
732 $type = readlink($filename);
735 }
736 elsif (($stat[2] & 0170000) == 040000)
737 {
739 }
740 else
741 {
743 };
747 printf(
748 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
749 $filename,
750 $type,
751 $stat[3],
752 $uid,
753 $gid,
754 $stat[8] >> 16 & 0xffff,
755 $stat[8] & 0xffff,
756 $stat[9] >> 16 & 0xffff,
757 $stat[9] & 0xffff,
758 $stat[10] >> 16 & 0xffff,
759 $stat[10] & 0xffff,
760 $stat[7],
761 $stat[2],
762 $stat[1] >> 16 & 0xffff,
763 $stat[1] & 0xffff,
764 $stat[0] >> 16 & 0xffff,
765 $stat[0] & 0xffff);
766 }
768 "Perl script implementing `directory-files-attributes' as Lisp `read'able
769 output.
770 Escape sequence %s is replaced with name of Perl binary.
773 ;; These two use base64 encoding.
775 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
776 "Perl program to use for encoding a file.
777 Escape sequence %s is replaced with name of Perl binary.
778 This string is passed to `format', so percent characters need to be doubled.
779 This implementation requires the MIME::Base64 Perl module to be installed
783 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
784 "Perl program to use for decoding 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 -e '
792 # This script contributed by Juanma Barranquero <lektu@terra.es>.
793 # Copyright (C) 2002-2018 Free Software Foundation, Inc.
794 use strict;
796 my %%trans = do {
797 my $i = 0;
798 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
799 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
800 };
801 my $data;
803 # We read in chunks of 54 bytes, to generate output lines
804 # of 72 chars (plus end of line)
805 while (read STDIN, $data, 54) {
806 my $pad = q();
808 # Only for the last chunk, and only if did not fill the last three-byte packet
809 if (eof) {
810 my $mod = length($data) %% 3;
811 $pad = q(=) x (3 - $mod) if $mod;
812 }
814 # Not the fastest method, but it is simple: unpack to binary string, split
815 # by groups of 6 bits and convert back from binary to byte; then map into
816 # the translation table
817 print
818 join q(),
819 map($trans{$_},
820 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
821 $pad,
823 }' 2>/dev/null"
824 "Perl program to use for encoding a file.
825 Escape sequence %s is replaced with name of Perl binary.
829 "%s -e '
830 # This script contributed by Juanma Barranquero <lektu@terra.es>.
831 # Copyright (C) 2002-2018 Free Software Foundation, Inc.
832 use strict;
834 my %%trans = do {
835 my $i = 0;
836 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
837 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
838 };
840 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
844 # We are going to accumulate into $pending to accept any line length
845 # (we do not check they are <= 76 chars as the RFC says)
846 my $pending = q();
848 while (my $data = <STDIN>) {
849 chomp $data;
851 # If we find one or two =, we have reached the end and
852 # any following data is to be discarded
853 my $finished = $data =~ s/(==?).*/$1/;
854 $pending .= $data;
856 my $len = length($pending);
857 my $chunk = substr($pending, 0, $len & ~3);
858 $pending = substr($pending, $len & ~3 + 1);
860 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
861 # split in 8-bit chunks and convert back to char.
862 print join q(),
863 map $bytes{$_},
864 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
866 last if $finished;
867 }' 2>/dev/null"
868 "Perl program to use for decoding a file.
869 Escape sequence %s is replaced with name of Perl binary.
873 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
874 "Perl program to use for encoding a file.
878 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
879 "Perl program to use for decoding a file.
884 BEGIN {
887 }
888 {
889 for (c=1; c<=length($0); c++) {
890 d=index(b16, substr($0,c,1))
891 if (d--) {
892 for (b=1; b<=4; b++) {
893 o=o*2+int(d/8); d=(d*2)%%16
894 if (++obc==6) {
895 printf substr(b64,o+1,1)
897 obc=0; o=0
898 }
899 }
900 }
901 }
902 }
903 END {
904 if (obc) {
906 while (obc++<6) { o=o*2 }
908 } else {
910 }
911 printf tail
912 }'"
913 "Awk program to use for encoding a file.
918 BEGIN {
920 }
921 {
922 for (i=1; i<=length($0); i++) {
923 c=index(b64, substr($0,i,1))
924 if(c--) {
925 for(b=0; b<6; b++) {
926 o=o*2+int(c/32); c=(c*2)%%64
927 if(++obc==8) {
928 if (o) {
930 } else {
932 }
933 obc=0; o=0
934 }
935 }
936 }
937 }
938 }'"
939 "Awk program to use for decoding a file.
943 "test -c /dev/zero && \
944 od -v -t x1 -A n </dev/null && \
945 busybox awk '{}' </dev/null"
956 while read file; do
960 else
962 fi
965 else
967 fi
968 done
970 "Script to check existence of VC related files.
971 It must be send formatted with two strings; the tests for file
972 existence, and file readability. Input shall be read via
973 here-document, otherwise the command could exceed maximum length
976 ;; New handlers should be added here.
977 ;;;###tramp-autoload
981 ;; `byte-compiler-base-file-name' performed by default handler.
986 ;; `diff-latest-backup-file' performed by default handler.
990 . tramp-sh-handle-directory-files-and-attributes)
1011 ;; `file-name-sans-versions' performed by default handler.
1026 ;; `find-file-noselect' performed by default handler.
1027 ;; `get-file-buffer' performed by default handler.
1033 ;; `make-directory-internal' performed by default handler.
1051 "Alist of handler functions.
1054 ;;; File Name Handler Functions:
1058 "Like `make-symbolic-link' for Tramp files.
1059 If TARGET is a non-Tramp file, it is used verbatim as the target
1060 of the symlink. If TARGET is a Tramp file, only the localname
1061 component is used as the target of the symlink."
1067 ;; If TARGET is a Tramp name, use just the localname component.
1074 ;; If TARGET is still remote, quote it.
1078 linkname ok-if-already-exists)
1085 v 'file-error
1088 ;; Do the 'confirm if exists' thing.
1090 ;; What to do?
1096 "File %s already exists; make it a link anyway? "
1097 localname)))))
1104 ;; Right, they are on the same host, regardless of user,
1105 ;; method, etc. We now make the link on the remote
1106 ;; machine. This will occur as the user that TARGET belongs to.
1111 "%s -sf %s %s" ln
1113 ;; The command could exceed PATH_MAX, so we use
1114 ;; relative file names. However, relative file
1115 ;; names could start with "-".
1116 ;; `tramp-shell-quote-argument' does not handle
1117 ;; this, we must do it ourselves.
1122 "Like `file-truename' for Tramp files."
1123 ;; Preserve trailing "/".
1129 v
1136 ;; Use GNU readlink --canonicalize-missing where available.
1139 v
1147 ;; Use Perl implementation.
1155 v
1159 ;; Do it yourself.
1163 ;; Don't make the following value larger than
1164 ;; necessary. People expect an error message in a
1165 ;; timely fashion when something is wrong;
1166 ;; otherwise they might think that Emacs is hung.
1167 ;; Of course, correctness has to come first.
1169 symlink-target)
1181 v
1194 ;; It's a symlink, follow it.
1204 ;; It's a file.
1208 v 'file-error
1211 ;; Combine list to form string.
1219 ;; Detect cycle.
1223 v 'file-error
1225 ;; If the resulting localname looks remote, we must quote it
1226 ;; for security reasons.
1231 result))
1234 ;; Basic functions.
1237 "Like `file-exists-p' for Tramp files."
1245 v
1247 "%s %s"
1252 "Like `file-attributes' for Tramp files."
1255 ;; Don't modify `last-coding-system-used' by accident.
1262 v
1270 ;; The scripts could fail, for example with huge file size.
1281 "Implement `file-attributes' for Tramp files using the ls(1) command."
1283 res-inode res-filemodes res-numlinks
1284 res-uid res-gid res-size res-symlink-target)
1286 ;; We cannot send all three commands combined, it could exceed
1287 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1289 vec
1294 vec
1299 vec
1303 ;; On systems which have no quoting style, file names
1304 ;; with special characters could fail.
1307 ;; Parse `ls -l' output ...
1311 ;; ... inode
1313 ;; ... file mode flags
1315 ;; ... number links
1317 ;; ... uid and gid
1329 ;; ... size
1331 ;; From the file modes, figure out other stuff.
1334 ;; If symlink, find out file name pointed to.
1341 ;; Return data gathered.
1343 ;; 0. t for directory, string (name linked to) for symbolic
1344 ;; link, or nil.
1346 ;; 1. Number of links to file.
1347 res-numlinks
1348 ;; 2. File uid.
1349 res-uid
1350 ;; 3. File gid.
1351 res-gid
1352 ;; 4. Last access time, as a list of integers. Normally
1353 ;; this would be in the same format as `current-time', but
1354 ;; the subseconds part is not currently implemented, and
1355 ;; (0 0) denotes an unknown time.
1356 ;; 5. Last modification time, likewise.
1357 ;; 6. Last status change time, likewise.
1359 ;; 7. Size in bytes (-1, if number is out of range).
1360 res-size
1361 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1362 res-filemodes
1363 ;; 9. t if file's gid would change if file were deleted and
1364 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1365 t
1366 ;; 10. Inode number.
1367 res-inode
1368 ;; 11. Device number. Will be replaced by a virtual device number.
1373 "Implement `file-attributes' for Tramp files using a Perl script."
1378 vec
1384 "Implement `file-attributes' for Tramp files using stat(1) command."
1387 vec
1390 ;; On Opsware, pdksh (which is the true name of ksh there)
1391 ;; doesn't parse correctly the sequence "((". Therefore, we add
1392 ;; a space. Apostrophes in the stat output are masked as
1393 ;; `tramp-stat-marker', in order to make a proper shell escape of
1394 ;; them in file names.
1395 "( (%s %s || %s -h %s) && (%s -c "
1396 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1403 tramp-stat-marker tramp-stat-marker
1408 tramp-stat-marker tramp-stat-marker
1410 tramp-stat-quoted-marker)))
1413 "Like `set-visited-file-modtime' for Tramp files."
1420 coding-system-used)
1424 ;; '(-1 65535) means file doesn't exists yet.
1428 ;; We use '(0 0) as a don't-know value. See also
1429 ;; `tramp-do-file-attributes-with-ls'.
1434 v
1442 nil)))))
1444 ;; This function makes the same assumption as
1445 ;; `tramp-sh-handle-set-visited-file-modtime'.
1447 "Like `verify-visited-file-modtime' for Tramp files.
1448 At the time `verify-visited-file-modtime' calls this function, we
1449 already know that the buffer is visiting a file and that
1450 `visited-file-modtime' does not return 0. Do not call this
1451 function directly, unless those two cases are already taken care
1452 of."
1455 ;; There is no file visiting the buffer, or the buffer has no
1456 ;; recorded last modification time, or there is no established
1457 ;; connection.
1461 t
1469 ;; File exists, and has a known modtime.
1472 modtime
1473 ;; For compatibility, deal with both the old
1474 ;; (HIGH . LOW) and the new (HIGH LOW) return
1475 ;; values of `visited-file-modtime'.
1478 mt)))
1480 ;; Modtime has the don't know value.
1483 v
1490 attr
1493 ;; If file does not exist, say it is not modified if and
1494 ;; only if that agrees with the buffer's record.
1498 "Like `set-file-modes' for Tramp files."
1502 ;; FIXME: extract the proper text from chmod's stderr.
1504 v
1509 "Like `set-file-times' for Tramp files."
1516 time)))
1519 "env TZ=UTC %s %s %s"
1527 "Set the ownership for FILENAME.
1528 If UID and GID are provided, these values are used; otherwise uid
1529 and gid of the corresponding user is taken. Both parameters must
1530 be non-negative integers."
1531 ;; Modern Unices allow chown only for root. So we might need
1532 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1533 ;; working with su(do)? when it is needed, so it shall succeed in
1534 ;; the majority of cases.
1535 ;; Don't modify `last-coding-system-used' by accident.
1540 ;; If we are root on the local host, we can do it directly.
1548 "chown %d:%d %s" uid gid
1551 ;; We handle also the local part, because there doesn't exist
1552 ;; `set-file-uid-gid'. On W32 "chown" does not work.
1557 nil "chown" nil nil nil
1561 "Check, whether SELINUX is enabled on the remote host."
1566 "Like `file-selinux-context' for Tramp files."
1575 "%s -d -Z %s"
1583 ;; Return the context.
1584 context))))
1587 "Like `set-file-selinux-context' for Tramp files."
1606 t)))))
1609 "Check, whether ACL is enabled on the remote host."
1614 "Like `file-acl' for Tramp files."
1620 "getfacl -ac %s"
1629 "Like `set-file-acl' for Tramp files."
1636 tramp-end-of-heredoc
1637 acl-string
1638 tramp-end-of-heredoc))
1640 ;; Success.
1643 t)
1644 ;; In case of errors, we return nil.
1646 nil)))
1648 ;; Simple functions using the `test' command.
1651 "Like `file-executable-p' for Tramp files."
1654 ;; Examine `file-attributes' cache to see if request can be
1655 ;; satisfied without remote operation.
1660 "Like `file-readable-p' for Tramp files."
1663 ;; Examine `file-attributes' cache to see if request can be
1664 ;; satisfied without remote operation.
1668 ;; When the remote shell is started, it looks for a shell which groks
1669 ;; tilde expansion. Here, we assume that all shells which grok tilde
1670 ;; expansion will also provide a `test' command which groks `-nt' (for
1671 ;; newer than). If this breaks, tell me about it and I'll try to do
1672 ;; something smarter about it.
1674 "Like `file-newer-than-file-p' for Tramp files."
1676 nil)
1678 t)
1679 ;; We are sure both files exist at this point.
1682 ;; We try to get the mtime of both files. If they are not
1683 ;; equal to the "dont-know" value, then we subtract the times
1684 ;; and obtain the result.
1697 ;; If one of them is the dont-know value, then we can
1698 ;; still try to run a shell command on the remote host.
1699 ;; However, this only works if both files are Tramp
1700 ;; files and both have the same method, same user, same
1701 ;; host.
1706 v 'file-error
1707 "Files %s and %s must have same method, user, host"
1708 file1 file2)))
1713 ;; Functions implemented using the basic functions above.
1716 "Like `file-directory-p' for Tramp files."
1718 ;; `file-directory-p' is used as predicate for file name completion.
1719 ;; Sometimes, when a connection is not established yet, it is
1720 ;; desirable to return t immediately for "/method:foo:". It can
1721 ;; be expected that this is always a directory.
1727 "Like `file-writable-p' for Tramp files."
1731 ;; Examine `file-attributes' cache to see if request can be
1732 ;; satisfied without remote operation.
1735 ;; If file doesn't exist, check if directory is writable.
1740 "Like `file-ownership-preserved-p' for Tramp files."
1744 ;; Return t if the file doesn't exist, since it's true that no
1745 ;; information would be lost by an (attempted) delete and create.
1754 ;; Directory listings.
1758 "Like `directory-files-and-attributes' for Tramp files."
1766 v localname
1777 v localname id-format))
1780 v localname id-format))
1782 result item)
1792 result
1794 ;; The scripts could fail, for example with huge file size.
1796 directory full match nosort id-format)))))
1800 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1803 vec tramp-perl-directory-files-and-attributes
1807 vec
1811 object))
1815 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1818 vec
1821 ;; We must care about file names with spaces, or starting with
1822 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1823 ;; but it does not work on all remote systems. Apostrophes in
1824 ;; the stat output are masked as `tramp-stat-marker', in order to
1825 ;; make a proper shell escape of them in file names.
1827 "xargs %s -c "
1828 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1832 ;; On systems which have no quoting style, file names with special
1833 ;; characters could fail.
1836 tramp-stat-marker tramp-stat-marker
1837 tramp-stat-marker tramp-stat-marker
1842 tramp-stat-marker tramp-stat-marker
1843 tramp-stat-quoted-marker)))
1845 ;; This function should return "foo/" for directories and "bar" for
1846 ;; files.
1848 "Like `file-name-all-completions' for Tramp files."
1851 filename
1855 ;; Get a list of directories and files, including reliably
1856 ;; tagging the directories with a trailing "/". Because I
1857 ;; rock. --daniel@danann.net
1859 v
1863 v tramp-perl-file-name-all-completions
1869 "(cd %s 2>&1 && %s -a 2>/dev/null"
1870 " | while IFS= read f; do"
1878 ;; Now grab the output.
1882 ;; Check result code, found in last line of output.
1886 ;; Grab error message from line before last line
1887 ;; (it was put there by `cd 2>&1').
1890 v 'file-error
1891 "tramp-sh-handle-file-name-all-completions: %s"
1893 ;; For peace of mind, if buffer doesn't end in `fail'
1894 ;; then it should end in `ok'. If neither are in the
1895 ;; buffer something went seriously wrong on the remote
1896 ;; side.
1900 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1905 result))))))
1907 ;; cp, mv and ln
1911 "Like `add-name-to-file' for Tramp files."
1916 v 'file-error
1917 "add-name-to-file: %s"
1923 ;; Do the 'confirm if exists' thing.
1925 ;; What to do?
1930 "File %s already exists; make it a link anyway? "
1931 v2-localname)))))
1937 v1
1941 "error with add-name-to-file, see buffer `%s' for details"
1946 preserve-uid-gid preserve-extended-attributes)
1947 "Like `copy-file' for Tramp files."
1953 'copy filename newname ok-if-already-exists keep-date
1954 preserve-uid-gid preserve-extended-attributes)
1956 'copy-file
1958 preserve-uid-gid preserve-extended-attributes))))
1962 "Like `copy-directory' for Tramp files."
1968 ;; When DIRNAME and NEWNAME are remote, they must have
1969 ;; the same method.
1975 ;; scp or rsync DTRT.
1993 ;; We must do it file-wise.
1995 'copy-directory
1998 ;; When newname did exist, we have wrong cached values.
2006 "Like `rename-file' for Tramp files."
2007 ;; Check if both files are local -- invoke normal rename-file.
2008 ;; Otherwise, use Tramp from local system.
2011 ;; At least one file a Tramp file?
2015 'rename filename newname ok-if-already-exists
2022 preserve-uid-gid preserve-extended-attributes)
2023 "Copy or rename a remote file.
2024 OP must be `copy' or `rename' and indicates the operation to perform.
2025 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2026 the new file (for copy) or the new name of the file (for rename).
2027 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2028 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2029 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2030 the uid and gid if both files are on the same host.
2031 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2033 This function is invoked by `tramp-sh-handle-copy-file' and
2034 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2035 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2036 file names."
2049 ;; `file-extended-attributes' exists since Emacs 24.4.
2060 filename newname)
2063 ;; Both are Tramp files.
2068 ;; Shortcut: if method, host, user are the same for
2069 ;; both files, we invoke `cp' or `mv' on the remote
2070 ;; host directly.
2073 op filename newname
2074 ok-if-already-exists keep-date preserve-uid-gid))
2076 ;; Try out-of-band operation.
2081 op filename newname keep-date))
2083 ;; No shortcut was possible. So we copy the file
2084 ;; first. If the operation was `rename', we go back
2085 ;; and delete the original file (if the copy was
2086 ;; successful). The approach is simple-minded: we
2087 ;; create a new buffer, insert the contents of the
2088 ;; source file into it, then write out the buffer to
2089 ;; the target file. The advantage is that it doesn't
2090 ;; matter which file name handlers are used for the
2091 ;; source and target file.
2094 op filename newname keep-date))))))
2096 ;; One file is a Tramp file, the other one is local.
2099 ;; Fast track on local machine.
2102 op filename newname
2103 ok-if-already-exists keep-date preserve-uid-gid))
2105 ;; If the Tramp file has an out-of-band method, the
2106 ;; corresponding copy-program can be invoked.
2109 op filename newname keep-date))
2111 ;; Use the inline method via a Tramp buffer.
2113 op filename newname keep-date))))
2116 ;; One of them must be a Tramp file.
2119 ;; Handle `preserve-extended-attributes'. We ignore possible
2120 ;; errors, because ACL strings could be incompatible.
2125 ;; In case of `rename', we must flush the cache of the source file.
2132 ;; When newname did exist, we have wrong cached values.
2140 "Use an Emacs buffer to copy or rename a file.
2141 First arg OP is either `copy' or `rename' and indicates the operation.
2142 FILENAME is the source file, NEWNAME the target file.
2143 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2144 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2145 ;; and `find-file-noselect', but that's not called here.
2149 ;; We must disable multibyte, because binary data shall not be
2150 ;; converted. We don't want the target file to be compressed, so we
2151 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2152 ;; be called either. We remove `tramp-file-name-handler' from
2153 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2154 ;; `insert-file-contents' might be deactivated in some corner cases.
2165 ;; KEEP-DATE handling.
2168 newname
2171 ;; Set the mode.
2173 ;; If the operation was `rename', delete the original file.
2178 "Invokes `cp' or `mv' on the remote system.
2179 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2180 respectively. FILENAME specifies the file to copy or rename,
2181 NEWNAME is the name of the new file (for copy) or the new name of
2182 the file (for rename). Both files must reside on the same host.
2183 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2184 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2185 the uid and gid from FILENAME."
2196 v 'file-error
2197 "Unknown operation `%s', must be `copy' or `rename'"
2198 op))))
2202 cmd-result)
2205 ;; Both files are on a remote host, with same user.
2217 ;; Mask cp -f error.
2219 tramp-operation-not-permitted-regexp nil t))
2220 cmd-result)
2222 nil v 'file-error
2223 "Copying directly failed, see buffer `%s' for details."
2226 ;; We are on the local host.
2229 ;; We can do it directly.
2232 ;; No sticky bit when renaming.
2243 localname1 localname2 ok-if-already-exists
2244 keep-date preserve-uid-gid)
2248 ;; We can do it directly with `tramp-send-command'
2256 ok-if-already-exists keep-date t)
2257 ;; We must change the ownership to the local user.
2263 ;; We need a temporary file in between.
2265 ;; Create the temporary file.
2273 "%s %s %s" cmd
2276 "Copying directly failed, see buffer `%s' for details."
2278 ;; We must change the ownership as remote user.
2279 ;; Since this does not work reliable, we also
2280 ;; give read permissions.
2290 localname1 tmpfile t keep-date preserve-uid-gid)
2293 ;; We must change the ownership as local user.
2294 ;; Since this does not work reliable, we also
2295 ;; give read permissions.
2298 tmpfile
2302 ;; Move the temporary file to its destination.
2307 "cp -f -p %s %s"
2310 "Copying directly failed, see buffer `%s' for details."
2314 'rename-file
2317 ;; Save exit.
2320 ;; Set the time and mode. Mask possible errors.
2327 "Invoke `scp' program to copy.
2328 The method used must be an out-of-band method."
2332 copy-program copy-args copy-env copy-keep-date listener spec
2333 options source target remote-copy-program remote-copy-args)
2338 ;; Both are Tramp files. We shall optimize it when the
2339 ;; methods for FILENAME and NEWNAME are the same.
2349 op filename tmpfile keep-date)
2352 ;; Save exit.
2359 ;; Check which ones of source and target are Tramp files.
2363 'file-name-as-directory
2372 ;; Check for user. There might be an interactive setting.
2376 ;; Check for listener port.
2383 ;; Compose copy command.
2392 ?h host ?u user ?p port ?r listener ?c options
2398 copy-args
2400 ;; " " has either been a replacement of "%k" (when
2401 ;; keep-date argument is non-nil), or a replacement
2402 ;; for the whole keep-date sublist.
2403 " "
2408 copy-args
2412 copy-env
2414 nil
2421 remote-copy-program
2427 remote-copy-args
2431 ;; Check for local copy program.
2436 ;; Install listener on the remote side. The prompt must be
2437 ;; consumed later on, when the process does not listen anymore.
2444 v 'file-error
2448 'identity
2456 v 'file-error
2457 "Listener process not running on remote host: `%s'"
2458 remote-copy-program))
2466 ;; The default directory must be remote.
2470 ;; We do not want to run timers.
2471 timer-list timer-idle-list)
2472 ;; Set the transfer process properties.
2482 copy-args
2484 copy-args
2489 ;; Use an asynchronous process. By this, password can
2490 ;; be handled. We don't set a timeout, because the
2491 ;; copying of large files can last longer than 60 secs.
2501 command))))
2507 ;; We must adapt `tramp-local-end-of-line' for
2508 ;; sending the password.
2511 p v nil tramp-actions-copy-out-of-band))))
2513 ;; Reset the transfer process properties.
2516 ;; Clear the remote prompt.
2519 ;; Houston, we have a problem! Likely, the listener is
2520 ;; still running, so let's clear everything (but the
2521 ;; cached password).
2524 ;; Handle KEEP-DATE argument.
2527 newname
2531 ;; Set the mode.
2536 ;; If the operation was `rename', delete the original file.
2543 "Like `make-directory' for Tramp files."
2555 "Like `delete-directory' for Tramp files."
2568 "Like `delete-file' for Tramp files."
2579 ;; Dired.
2582 "Like `dired-compress-file' for Tramp files."
2583 ;; Code stolen mainly from dired-aux.el.
2588 suffix)
2589 ;; See if any suffix rule matches this file name.
2597 nil)
2599 ;; We found an uncompression rule.
2609 ;; We don't recognize the file as compressed, so compress it.
2610 ;; Try gzip.
2624 "Like `insert-directory' for Tramp files."
2631 filename switches wildcard full-directory-p)
2655 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2656 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2659 v
2662 switches
2664 localname
2667 v
2671 "Couldn't `cd %s'"
2675 v
2678 switches
2683 ""
2691 ;; We cannot use `insert-buffer-substring' because the Tramp
2692 ;; buffer changes its contents before insertion due to calling
2693 ;; `expand-file-name' and alike.
2698 ;; Check for "--dired" output.
2705 ;; Now read the numeric positions of file names.
2711 ;; End is followed by \n or by " -> ".
2713 ;; Remove trailing lines.
2719 ;; Some busyboxes are reluctant to discard colors.
2727 ;; Decode the output, it could be multibyte.
2732 ;; The inserted file could be from somewhere else.
2739 "."
2744 ;; Try to insert the amount of free space.
2746 ;; First find the line to put it on.
2750 ;; Replace "total" with "total used", to avoid confusion.
2757 ;; Canonicalization of file names.
2760 "Like `expand-file-name' for Tramp files.
2762 the result will be a local, non-Tramp, file name."
2763 ;; If DIR is not given, use `default-directory' or "/".
2765 ;; Unless NAME is absolute, concat DIR and NAME.
2768 ;; If connection is not established yet, run the real handler.
2771 ;; Dissect NAME.
2775 ;; Tilde expansion if necessary. This needs a shell which
2776 ;; groks tilde expansion! The function `tramp-find-shell' is
2777 ;; supposed to find such a shell on the remote host. Please
2778 ;; tell me about it when this doesn't work on your system.
2782 ;; We cannot simply apply "~/", because under sudo "~/" is
2783 ;; expanded to the local user home directory but to the
2784 ;; root home directory. On the other hand, using always
2785 ;; the default user name for tilde expansion is not
2786 ;; appropriate either, because ssh and companions might
2787 ;; use a user name from the config file.
2799 ;; There might be a double slash, for example when "~/"
2800 ;; expands to "/". Remove this.
2803 ;; No tilde characters in file name, do normal
2804 ;; `expand-file-name' (this does "/./" and "/../").
2805 ;; `default-directory' is bound, because on Windows there would
2806 ;; be problems with UNC shares or Cygwin mounts.
2813 ;;; Remote commands:
2816 "Flush file caches."
2824 ;; We use BUFFER also as connection buffer during setup. Because of
2825 ;; this, its original contents must be saved, and restored once
2826 ;; connection has been setup.
2828 "Like `start-file-process' for Tramp files."
2833 ;; BUFFER can be nil. We use a temporary buffer.
2835 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2836 ;; it might be that the arguments exceed the command line
2837 ;; length. Therefore, we modify the command.
2842 ;; When PROGRAM is nil, we just provide a tty.
2848 args
2852 ;; Use a human-friendly prompt, for example for `shell'.
2853 ;; We discard hops, if existing, that's why we cannot use
2854 ;; `file-remote-p'.
2857 tramp-initial-end-of-output))
2858 ;; We use as environment the difference to toplevel
2859 ;; `process-environment'.
2860 env uenv
2874 "unset %s &&"
2889 ;; We do not want to raise an error when
2890 ;; `start-file-process' has been started several times in
2891 ;; `eshell' and friends.
2892 tramp-current-connection
2893 ;; We do not want to run timers.
2894 timer-list timer-idle-list
2895 p)
2898 ;; NAME must be unique as process name.
2902 ;; Set the new process properties.
2908 ;; We catch this event. Otherwise, `start-process' could
2909 ;; be called on the local host.
2912 ;; Activate narrowing in order to save BUFFER
2913 ;; contents. Clear also the modification time;
2914 ;; otherwise we might be interrupted by
2915 ;; `verify-visited-file-modtime'.
2921 ;; We call `tramp-maybe-open-connection', in order
2922 ;; to cleanup the prompt afterwards.
2926 ;; Set the pid of the remote shell. This is
2927 ;; needed when sending signals remotely.
2934 ;; Now do it.
2936 ;; Send the command.
2938 ;; Check, whether a pty is associated.
2941 v 'file-error
2943 ;; Set query flag and process marker for this
2944 ;; process. We ignore errors, because the process
2945 ;; could have finished already.
2949 ;; Return process.
2950 p)))
2952 ;; Save exit.
2963 "Like `process-file' for Tramp files."
2964 ;; The implementation is not complete yet.
2970 ;; Compute command.
2973 ;; We use as environment the difference to toplevel `process-environment'.
2984 "env %s %s"
2989 "unset %s && %s"
2991 ;; Determine input.
2996 ;; INFILE is on the same remote host.
2998 ;; INFILE must be copied to remote host.
3004 ;; Determine output.
3006 ;; Just a buffer.
3009 ;; A buffer name.
3012 ;; (REAL-DESTINATION ERROR-DESTINATION)
3014 ;; output.
3022 ;; stderr.
3027 ;; stderr is on the same remote host.
3030 ;; stderr must be copied to remote host. The temporary
3031 ;; file must be deleted after execution.
3034 ;; stderr to be discarded.
3037 ;; 't
3042 ;; Send the command. It might not return in time, so we protect
3043 ;; it. Call it in a subshell, in order to preserve working
3044 ;; directory.
3051 command)
3052 t t)
3054 ;; We should add the output anyway.
3061 ;; When the user did interrupt, we should do it also. We use
3062 ;; return code -1 as marker.
3066 ;; Handle errors.
3071 ;; Provide error file.
3074 ;; Cleanup. We remove all file cache values for the connection,
3075 ;; because the remote process could have changed them.
3081 ;; Return exit status.
3084 ret))))
3087 "Like `exec-path' for Tramp files."
3090 ;; The equivalent to `exec-directory'.
3094 "Like `file-local-copy' for Tramp files."
3098 v tramp-file-missing
3109 ;; `copy-file' handles direct copy and out-of-band methods.
3114 ;; Use inline encoding for file transfer.
3118 v 3
3120 filename rem-enc)
3127 tmpfile loc-dec)
3129 ;; If local decoding is a function, we call it.
3130 ;; We must disable multibyte, because
3131 ;; `uudecode-decode-region' doesn't handle it
3132 ;; correctly. Unset `file-name-handler-alist'.
3133 ;; Otherwise, epa-file gets confused.
3141 ;; If tramp-decoding-function is not defined for this
3142 ;; method, we invoke tramp-decoding-command instead.
3144 ;; Unset `file-name-handler-alist'. Otherwise,
3145 ;; epa-file gets confused.
3153 loc-dec tmpfile2 tmpfile)
3156 ;; Set proper permissions.
3158 ;; Set local user ownership.
3161 ;; Oops, I don't know what to do.
3165 ;; Error handling.
3171 tmpfile)))
3173 ;; CCC grok LOCKNAME
3176 "Like `write-region' for Tramp files."
3194 ;; `file-writable-p' calls `file-expand-file-name'. We
3195 ;; cannot use `tramp-run-real-handler' therefore.
3201 ;; Short track: if we are on the local host, we can run directly.
3206 ;; We use this to save the value of
3207 ;; `last-coding-system-used' after writing the tmp
3208 ;; file. At the end of the function, we set
3209 ;; `last-coding-system-used' to this saved value. This
3210 ;; way, any intermediary coding systems used while
3211 ;; talking to the remote shell or suchlike won't hose
3212 ;; this variable. This approach was snarfed from
3213 ;; ange-ftp.el.
3214 coding-system-used
3215 ;; Write region into a tmp file. This isn't really
3216 ;; needed if we use an encoding function, but currently
3217 ;; we use it always because this makes the logic
3218 ;; simpler. We must also set `temporary-file-directory',
3219 ;; because it could point to a remote directory.
3225 ;; If `append' is non-nil, we copy the file locally, and let
3226 ;; the native `write-region' implementation do the job.
3229 ;; We say `no-message' here because we don't want the
3230 ;; visited file modtime data to be clobbered from the temp
3231 ;; file. We call `set-visited-file-modtime' ourselves later
3232 ;; on. We must ensure that `file-coding-system-alist'
3233 ;; matches `tmpfile'.
3239 'write-region
3246 ;; Now, `last-coding-system-used' has the right value. Remember it.
3249 ;; The permissions of the temporary file should be set. If
3250 ;; FILENAME does not exist (eq modes nil) it has been
3251 ;; renamed to the backup file. This case `save-buffer'
3252 ;; handles permissions.
3253 ;; Ensure that it is still readable.
3256 tmpfile
3259 ;; This is a bit lengthy due to the different methods
3260 ;; possible for file transfer. First, we check whether the
3261 ;; method uses an scp program. If so, we call it.
3262 ;; Otherwise, both encoding and decoding command must be
3263 ;; specified. However, if the method _also_ specifies an
3264 ;; encoding function, then that is used for encoding the
3265 ;; contents of the tmp file.
3271 ;; `copy-file' handles direct copy and out-of-band methods.
3281 ;; We keep the local file for performance
3282 ;; reasons, useful for "rsync".
3289 ;; Don't rename, in order to keep context in SELinux.
3294 ;; Use inline file transfer.
3296 ;; Encode tmpfile.
3300 ;; Use encoding function or command.
3303 "Encoding local file `%s' using `%s'"
3304 tmpfile loc-enc)
3306 ;; The following `let' is a workaround for
3307 ;; the base64.el that comes with pgnus-0.84.
3308 ;; If both of the following conditions are
3309 ;; satisfied, it tries to write to a local
3310 ;; file in default-directory, but at this
3311 ;; point, default-directory is remote.
3312 ;; (`call-process-region' can't write to
3313 ;; remote files, it seems.) The file in
3314 ;; question is a tmp file anyway.
3322 loc-enc tmpfile t))
3324 v 'file-error
3327 filename loc-enc))))
3329 ;; Send buffer into remote decoding command which
3330 ;; writes to remote file. Because this happens on
3331 ;; the remote host, we cannot use the function.
3334 "Decoding remote file `%s' using `%s'"
3335 filename rem-dec)
3339 v
3343 tramp-end-of-heredoc
3345 tramp-end-of-heredoc))
3347 v nil
3348 "Couldn't write region to `%s', decode using `%s' failed"
3349 filename rem-dec)
3350 ;; When `file-precious-flag' is set, the region is
3351 ;; written to a temporary file. Check that the
3352 ;; checksum is equal to that from the local tmpfile.
3356 ;; cksum runs locally, if possible.
3358 ;; cksum runs remotely.
3360 v
3363 ;; ... they are different.
3370 v 'file-error
3373 filename rem-dec)))))
3375 ;; Save exit.
3378 ;; That's not expected.
3381 v 'file-error
3384 method))))
3386 ;; Make `last-coding-system-used' have the right value.
3393 ;; We must protect `last-coding-system-used', now we have set it
3394 ;; to its correct value.
3396 ;; Set file modification time.
3400 ;; We must pass modtime explicitly, because FILENAME can
3401 ;; be different from (buffer-file-name), f.e. if
3402 ;; `file-precious-flag' is set.
3408 ;; Set the ownership.
3419 ;; VC backends check for the existence of various different special
3420 ;; files. This is very time consuming, because every single check
3421 ;; requires a remote command (the file cache must be invalidated).
3422 ;; Therefore, we apply a kind of optimization. We install the file
3423 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3424 ;; remembers all file names for which `file-exists-p' or
3425 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3426 ;; is performed. Afterwards, a script is applied for all collected
3427 ;; file names, using just one remote command. The result of this
3428 ;; script is used to fill the file cache with actual values. Now we
3429 ;; can reset the file name handlers, and we make a second run of
3430 ;; `vc-registered', which returns the expected result without sending
3431 ;; any other remote command.
3433 "Like `vc-registered' for Tramp files."
3439 ;; There could be new files, created by the vc backend. We
3440 ;; cannot reuse the old cache entries, therefore. In
3441 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3442 ;; could also be a timestamp as `current-time' returns. This
3443 ;; means invalidate all cache entries with an older timestamp.
3449 ;; Here we collect only file names, which need an operation.
3451 v "Error in 1st pass of `vc-registered': %s"
3455 ;; Send just one command, in order to fill the cache.
3458 v
3467 ;; We cannot use `tramp-send-command-and-read',
3468 ;; because this does not cooperate well with
3469 ;; heredoc documents.
3471 v
3474 tramp-end-of-heredoc
3476 tramp-vc-registered-file-names
3478 tramp-end-of-heredoc))
3480 ;; Read the expression.
3487 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3488 ;; calls shall be answered from the file cache. We unset
3489 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3490 ;; in order to keep the cache.
3492 remote-file-name-inhibit-cache process-file-side-effects)
3493 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3512 ;; Run.
3514 v "Error in 2nd pass of `vc-registered': %s"
3517 ;;;###tramp-autoload
3519 "Invoke remote-shell Tramp file name handler.
3520 Fall back to normal file name handler if no Tramp handler exists."
3526 ;; This must be the last entry, because `identity' always matches.
3527 ;;;###tramp-autoload
3532 "Invoke special file name handler, which collects files to be handled."
3540 ;; That's what we want: file names, for which checks are
3541 ;; applied. We assume that VC uses only `file-exists-p' and
3542 ;; `file-readable-p' checks; otherwise we must extend the
3543 ;; list. We do not perform any action, but return nil, in
3544 ;; order to keep `vc-registered' running.
3547 nil)
3548 ;; `process-file' and `start-file-process' shall be ignored.
3551 ;; Tramp file name handlers like `expand-file-name'. They
3552 ;; must still work.
3554 ;; Default file name handlers, we don't care.
3558 "Like `file-notify-add-watch' for Tramp files."
3562 command events filter p sequence)
3564 ;; "inotifywait".
3567 events
3577 ;; Make events a list of symbols.
3578 events
3582 ;; "gio monitor".
3585 events
3589 attribute-changed))
3594 ;; "gvfs-monitor-dir".
3597 events
3601 attribute-changed))
3606 ;; None.
3608 v 'file-notify-error
3609 "No file notification program found on %s"
3611 ;; Start process.
3613 'start-file-process
3617 sequence))
3618 ;; Return the process object as watch-descriptor.
3621 v 'file-notify-error
3622 "`%s' failed to start on remote host"
3626 ;; Needed for process filter.
3631 ;; There might be an error if the monitor is not supported.
3632 ;; Give the filter a chance to read the output.
3637 p))))
3650 ;; Fix action names.
3657 ;; https://bugs.launchpad.net/bugs/1742946
3666 string)
3672 proc
3675 ;; File names are returned as absolute paths. We must
3676 ;; add the remote prefix.
3680 ;; Remove watch when file or directory to be watched is deleted.
3684 ;; Usually, we would add an Emacs event now. Unfortunately,
3685 ;; `unread-command-events' does not accept several events at
3686 ;; once. Therefore, we apply the handler directly.
3689 'file-notify-handle-event
3692 ;; Save rest of the string.
3699 file-notify events."
3709 ;; Attribute change is returned in unused wording.
3719 string)
3724 proc
3729 ;; File names are returned as absolute paths. We must
3730 ;; add the remote prefix.
3734 ;; Remove watch when file or directory to be watched is deleted.
3738 ;; Usually, we would add an Emacs event now. Unfortunately,
3739 ;; `unread-command-events' does not accept several events at
3740 ;; once. Therefore, we apply the handler directly.
3743 'file-notify-handle-event
3746 ;; Save rest of the string.
3756 ;; Check, whether there is a problem.
3761 line)
3766 proc
3773 ;; Remove watch when file or directory to be watched is deleted.
3776 ;; Usually, we would add an Emacs event now. Unfortunately,
3777 ;; `unread-command-events' does not accept several events at
3778 ;; once. Therefore, we apply the handler directly.
3781 'file-notify-handle-event
3785 "Like `file-system-info' for Tramp files."
3792 "%s --block-size=1 --output=size,used,avail %s"
3802 ;; The second value is the used size. We need the
3803 ;; free size.
3808 ;;; Internal Functions:
3811 "Define in remote shell function NAME implemented as SCRIPT.
3812 Only send the definition if it has not already been done."
3813 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3814 ;; might be nil.
3820 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3821 ;; could result in unwanted command expansion. Avoid this.
3824 ;; The script could contain a call of Perl. This is masked with `%s'.
3829 vec
3837 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3838 Returns the exit code of the `test' program."
3841 v
3843 "%s %s %s"
3845 switch
3849 "Run `test'-like program on the remote system, given FILE1, FILE2.
3850 FORMAT-STRING contains the program name, switches, and place holders.
3851 Returns the exit code of the `test' program. Barfs if the methods,
3852 hosts, or files, disagree."
3856 v 'file-error
3861 v1
3868 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3869 First arg VEC specifies the connection, PROGNAME is the program
3870 to search for, and DIRLIST gives the list of directories to
3871 search. If IGNORE-TILDE is non-nil, directory names starting
3872 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3873 only in DIRLIST.
3875 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3877 This function expects to be in the right *tramp* buffer."
3880 ;; Check whether the executable is in $PATH. "which(1)" does not
3881 ;; report always a correct error code; therefore we check the
3882 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3883 ;; 5.11") have problems with this command, we disable the call
3884 ;; therefore.
3895 ;; Remove all ~/foo directories from dirlist.
3904 vec
3906 "do if test -x $d/%s && test -f $d/%s; "
3907 "then echo tramp_executable $d/%s; "
3910 progname progname progname
3911 tramp-end-of-heredoc
3913 tramp-end-of-heredoc))
3919 result)))
3922 "Sets the remote environment PATH to existing directories.
3923 I.e., for each directory in `tramp-remote-path', it is tested
3924 whether it exists and if so, it is added to the environment
3925 variable PATH."
3931 ;; ------------------------------------------------------------
3932 ;; -- Communication with external shell --
3933 ;; ------------------------------------------------------------
3936 "Find a command on the remote host for checking if a file exists.
3937 Here, we are looking for a command which has zero exit status if the
3938 file exists and nonzero exit status otherwise."
3942 result)
3943 ;; The algorithm is as follows: we try a list of several commands.
3944 ;; For each command, we first run `$cmd /' -- this should return
3945 ;; true, as the root directory always exists. And then we run
3946 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3947 ;; does not exist. This should return false. We use the first
3948 ;; command we find that seems to work.
3949 ;; The list of commands to try is as follows:
3950 ;; `ls -d' This works on most systems, but NetBSD 1.4
3951 ;; has a bug: `ls' always returns zero exit
3952 ;; status, even for files which don't exist.
3953 ;; `test -e' Some Bourne shells have a `test' builtin
3954 ;; which does not know the `-e' option.
3955 ;; `/bin/test -e' For those, the `test' binary on disk normally
3956 ;; provides the option. Alas, the binary
3957 ;; is sometimes `/bin/test' and sometimes it's
3958 ;; `/usr/bin/test'.
3959 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3987 result))
3990 "Opens shell SHELL."
3993 ;; Find arguments for this shell.
3995 item extra-args)
4000 ;; It is useful to set the prompt in the following command
4001 ;; because some people have a setting for $PS1 which /bin/sh
4002 ;; doesn't know about and thus /bin/sh will display a strange
4003 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4004 ;; ksh will display the current working directory but /bin/sh
4005 ;; will display a dollar sign. The following command line sets
4006 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4007 ;; well as csh-like shells. We also unset the variable $ENV
4008 ;; because that is read by some sh implementations (eg, bash
4009 ;; when called as sh) on startup; this way, we avoid the startup
4010 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4011 ;; the prompt in /bin/bash, it must be discarded as well.
4012 ;; $HISTFILE is set according to `tramp-histfile-override'.
4013 ;; $TERM and $INSIDE_EMACS set here to ensure they have the
4014 ;; correct values when the shell starts, not just processes
4015 ;; run within the shell. (Which processes include our
4016 ;; initial probes to ensure the remote shell is usable.)
4020 "exec env TERM='%s' INSIDE_EMACS='%s,tramp:%s' "
4022 tramp-terminal-type
4023 emacs-version tramp-version ; INSIDE_EMACS
4029 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4033 t)
4034 ;; Check proper HISTFILE setting. We give up when not working.
4038 vec
4040 "(cd %s)"
4043 "`tramp-histfile-override' uses invalid file `%s'"
4044 tramp-histfile-override)))
4050 "Opens a shell on the remote host which groks tilde expansion."
4053 shell)
4056 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4057 ;; Which check could we apply instead?
4060 ;; The default shell (ksh93) of OpenSolaris and
4061 ;; Solaris is buggy. We've got reports for
4062 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4071 ;; Maybe it works at least for some other commands.
4073 default-shell
4075 vec 2
4077 "Couldn't find a remote shell which groks tilde "
4079 default-shell)))
4081 default-shell)))
4083 ;; Open a new shell if needed.
4089 ;; Utility functions.
4092 "Wait for shell prompt and barf if none appears.
4093 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4094 seconds. If not, it produces an error message with the given ERROR-ARGS."
4098 proc timeout
4107 "Set up an interactive shell.
4108 Mainly sets the prompt and the echo correctly. PROC is the shell
4109 process to set up. VEC specifies the connection."
4114 ;; Disable echo expansion.
4118 ;; Check whether the echo has really been disabled. Some
4119 ;; implementations, like busybox of embedded GNU/Linux, don't
4120 ;; support disabling.
4127 ;; Make sure backspaces and their echo are enabled and no line
4128 ;; width magic interferes with them.
4135 t)
4137 ;; Check whether the output of "uname -sr" has been changed. If
4138 ;; yes, this is a strong indication that we must expire all
4139 ;; connection properties. We start again with
4140 ;; `tramp-maybe-open-connection', it will be caught there.
4145 vec "uname"
4149 vec 3
4150 "Connection reset, because remote host changed from `%s' to `%s'"
4151 old-uname uname)
4152 ;; We want to keep the password.
4156 ;; Try to set up the coding system correctly.
4157 ;; CCC this can't be the right way to do it. Hm.
4160 ;; Use MULE to select the right EOL convention for communicating
4161 ;; with the process.
4170 cs-decode cs-encode)
4174 cs-encode
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'.
5140 ;; Decode also multibyte string.
5146 ;; Set file's gid change bit.
5154 ;; Convert inode.
5159 middle low)
5162 ;; The low 16 bits.
5167 ;; The middle 24 bits.
5171 ;; Inodes can be incredible huge. We must hide this.
5173 ;; Set virtual device number.
5176 attr))
5179 "Converts STRING to shell glob pattern which ignores case."
5185 string
5189 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5201 localname)
5207 "Return t if this is an out-of-band method, nil otherwise."
5209 ;; It shall be an out-of-band method.
5211 ;; There must be a size, otherwise the file doesn't exist.
5213 ;; Either the file size is large enough, or (in rare cases) there
5214 ;; does not exist a remote encoding.
5219 ;; Variables local to connection.
5222 "Compile list of remote directories for $PATH.
5223 Nonexistent directories are removed from spec."
5225 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5226 ;; cache the result for the session only. Otherwise, the result
5227 ;; is cached persistently.
5230 vec)
5231 "remote-path"
5240 ;; Default if "getconf" is not available.
5243 vec 3
5248 ;; The login shell could return more than just the $PATH
5249 ;; string. So we use `tramp-end-of-heredoc' as marker.
5253 vec
5258 'identity
5262 'identity
5270 nil)))))
5272 ;; Replace place holder `tramp-default-remote-path'.
5280 ;; Replace place holder `tramp-own-remote-path'.
5288 ;; Remove double entries.
5295 ;; Remove non-existing directories.
5297 nil
5303 x))
5304 remote-path)))))
5307 "Determine remote locale, supporting UTF8 if possible."
5311 locale)
5318 candidates nil)
5320 ;; Return value.
5324 "Determine remote `ls' command."
5331 result)
5333 ;; Check parameters. On busybox, "ls" output coloring is
5334 ;; enabled by default sometimes. So we try to disable it
5335 ;; when possible. $LS_COLORING is not supported there.
5336 ;; Some "ls" versions are sensitive to the order of
5337 ;; arguments, they fail when "-al" is after the
5338 ;; "--color=never" argument (for example on FreeBSD).
5350 "Return OPTION, if the remote `ls' command supports the OPTION option."
5353 ;; Some "ls" versions are sensitive to the order of arguments,
5354 ;; they fail when "-al" is after the "--dired" argument (for
5355 ;; example on FreeBSD). Busybox does not support this kind of
5356 ;; options.
5360 vec
5365 option)))
5368 "Determine remote `test' command."
5372 "test"
5376 "Check, whether the remote `test' command supports the -nt option."
5377 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5378 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5379 ;; for otherwise the shell crashes.
5391 vec
5398 "Determine remote command for file existing check."
5404 "Determine remote `ln' command."
5410 "Determine remote `perl' command."
5416 ;; Perform a basic check.
5421 ;; We must check also for some Perl modules.
5429 result)))
5432 "Determine remote `stat' command."
5437 tmp)
5438 ;; Check whether stat(1) returns usable syntax. "%s" does not
5439 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5440 ;; use shell quoted format for "%N", we check the boundaries "`"
5441 ;; and "'", therefore. See Bug#23422 in coreutils.
5442 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5443 ;; supported.
5452 result)))
5455 "Determine remote `readlink' command."
5463 result))))
5466 "Determine remote `trash' command.
5467 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5474 "Determine remote `touch' command."
5483 ;; Busyboxes do support the "-t" option only when they have been
5484 ;; built with the DESKTOP config option. Let's check it.
5487 vec "touch-t"
5489 vec
5491 "%s -t %s %s"
5492 result
5496 result)))
5499 "Determine remote `df' command."
5504 result
5507 result))))
5510 "Determine remote `gio-monitor' command."
5516 "Determine remote `gvfs-monitor-dir' command."
5519 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5520 ;; establish better timeouts in filenotify-tests.el. Any better
5521 ;; distinction approach would be welcome!
5528 "Determine remote `inotifywait' command."
5534 "Determine remote `id' command."
5540 result)
5542 ;; Check POSIX parameter.
5548 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5550 vec
5558 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5560 vec
5564 "print $>"
5568 "Determine remote `python' command."
5576 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5578 vec
5582 "import os; print (os.getuid())"
5586 "The uid of the remote connection VEC, in ID-FORMAT.
5587 ID-FORMAT valid values are `string' and `integer'."
5598 ;; Ensure there is a valid result.
5601 tramp-unknown-id-integer)
5603 tramp-unknown-id-string)
5607 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5609 vec
5617 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5619 vec
5627 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5629 vec
5633 "import os; print (os.getgid())"
5637 "The gid of the remote connection VEC, in ID-FORMAT.
5638 ID-FORMAT valid values are `string' and `integer'."
5649 ;; Ensure there is a valid result.
5652 tramp-unknown-id-integer)
5654 tramp-unknown-id-string)
5658 "Check, whether the remote `env' command supports the -u option."
5661 ;; Option "-u" is a GNU extension.
5665 ;; Some predefined connection properties.
5667 "Return the compress command related to PROP.
5668 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5669 the length of the file to be compressed.
5671 If no corresponding command is found, nil is returned."
5680 "Return the coding command related to PROP.
5681 PROP is either `remote-encoding', `remote-decoding',
5682 `local-encoding' or `local-decoding'.
5684 SIZE is the length of the file to be coded. Depending on SIZE,
5685 compression might be applied.
5687 If no corresponding command is found, nil is returned.
5688 Otherwise, either a string is returned which contains a `%s' mark
5689 to be used for the respective input or output file; or a Lisp
5690 function cell is returned to be applied on a buffer."
5691 ;; We must catch the errors, because we want to return nil, when
5692 ;; no inline coding is found.
5702 compress)
5703 ;; The connection property might have been cached. So we must
5704 ;; send the script to the remote side - maybe.
5712 ;; Check for the `compress' command.
5714 ;; Return the value.
5735 coding)
5738 ;; Windows shells need the program file name after
5739 ;; the pipe symbol be quoted if they use forward
5740 ;; slashes as directory separators.
5747 coding compress))
5750 ;; Windows shells need the program file name after
5751 ;; the pipe symbol be quoted if they use forward
5752 ;; slashes as directory separators.
5757 compress coding))
5771 ;;; TODO:
5773 ;; * Don't use globbing for directories with many files, as this is
5774 ;; likely to produce long command lines, and some shells choke on
5775 ;; long command lines.
5776 ;;
5777 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5778 ;; then look if it's the right version (with `perl -v').
5779 ;;
5780 ;; * When editing a remote CVS controlled file as a different user, VC
5781 ;; gets confused about the file locking status. Try to find out why
5782 ;; the workaround doesn't work.
5783 ;;
5784 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5785 ;; until the last but one hop via `start-file-process'. Apply it
5786 ;; also for ftp and smb.
5787 ;;
5788 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5789 ;; some shell with root privileges, it would be nice if I could
5790 ;; just call
5791 ;; trampclient filename.c
5792 ;; as an editor, and the _current_ shell would connect to an Emacs
5793 ;; server and would be used in an existing non-privileged Emacs
5794 ;; session for doing the editing in question.
5795 ;; That way, I need not tell Emacs my password again and be afraid
5796 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5797 ;; once display a just typed password in the context of a keyboard
5798 ;; sequence prompt for a question immediately following in a shell
5799 ;; script run within Emacs -- nasty).
5800 ;; And if I have some ssh session running to a different computer,
5801 ;; having the possibility of passing a local file there to a local
5802 ;; Emacs session (in case I can arrange for a connection back) would
5803 ;; be nice.
5804 ;; Likely the corresponding Tramp server should not allow the
5805 ;; equivalent of the emacsclient -eval option in order to make this
5806 ;; reasonably unproblematic. And maybe trampclient should have some
5807 ;; way of passing credentials, like by using an SSL socket or
5808 ;; something. (David Kastrup)
5809 ;;
5810 ;; * Reconnect directly to a compliant shell without first going
5811 ;; through the user's default shell. (Pete Forman)
5812 ;;
5813 ;; * Avoid the local shell entirely for starting remote processes. If
5814 ;; so, I think even a signal, when delivered directly to the local
5815 ;; SSH instance, would correctly be propagated to the remote process
5816 ;; automatically; possibly SSH would have to be started with
5817 ;; "-t". (Markus Triska)
5818 ;;
5819 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5820 ;; isn't on the remote host. (Mark A. Hershberger)
5821 ;;
5822 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5823 ;;
5824 ;; * Optimize out-of-band copying when both methods are scp-like (not
5825 ;; rsync).
5826 ;;
5827 ;; * Keep a second connection open for out-of-band methods like scp or
5828 ;; rsync.
5829 ;;
5830 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5831 ;;
5832 ;; * I think you could get the best of both worlds by using an
5833 ;; approach similar to Tramp but running a little tramp-daemon on
5834 ;; the other end, such that we can use a more efficient
5835 ;; communication protocol (e.g. when saving a file we could locally
5836 ;; diff it against the last version (of which the remote daemon
5837 ;; would also keep a copy), and then only send the diff).
5838 ;;
5839 ;; This said, even using such a daemon it might be difficult to get
5840 ;; good performance: part of the problem is the number of
5841 ;; round-trips. E.g. when saving a file we have to check if the
5842 ;; file was modified in the mean time and whether saving into a new
5843 ;; inode would change the owner (etc...), which each require a
5844 ;; round-trip. To get rid of these round-trips, we'd have to
5845 ;; shortcut this code and delegate the higher-level "save file"
5846 ;; operation to the remote server, which then has to perform those
5847 ;; tasks but still obeying the locally set customizations about how
5848 ;; to do each one of those tasks.
5849 ;;
5850 ;; We could either put higher-level ops in there (like
5851 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5852 ;; behavior, which is a lot of work and likely to be not 100%
5853 ;; faithful.
5854 ;;
5855 ;; Or we could introduce new low-level ops that are asynchronous,
5856 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5857 ;; start with a bunch of calls like `start-getting-file-attributes'
5858 ;; which could immediately be passed on to the remote side, and
5859 ;; later on checks the return value of those calls as and when
5860 ;; needed. (Stefan Monnier)
5862 ;;; tramp-sh.el ends here