| blob | a3641c6c401d642ed4d53f4cede8e653beb52866 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2017 Free Software Foundation, Inc.
5 ;; (copyright statements below in code to be updated with the above notice)
7 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Keywords: comm, processes
10 ;; Package: tramp
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Code:
31 ;; Pacify byte-compiler.
40 ;;;###tramp-autoload
42 "The minimum size of compressing where inline transfer.
43 When inline transfer, compress transferred data of file
44 whose size is this value or above (up to `tramp-copy-size-limit').
45 If it is nil, no compression at all will be applied."
50 ;;;###tramp-autoload
52 "The maximum file size where inline copying is preferred over an \
53 out-of-the-band copy.
54 If it is nil, out-of-the-band copy will be used without a check."
59 ;;;###tramp-autoload
61 "Value of TERM environment variable for logging in to remote host.
62 Because Tramp wants to parse the output of the remote shell, it is easily
63 confused by ANSI color escape sequences and suchlike. Often, shell init
64 files conditionalize this setup based on the TERM environment variable."
69 ;;;###tramp-autoload
71 "When invoking a shell, override the HISTFILE with this value.
72 When setting to a string, it redirects the shell history to that
76 The value t unsets any setting of HISTFILE, and sets both
77 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
78 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'."
123 "Which ssh Control* arguments to use.
125 If it is a string, it should have the form
128 spec must be doubled, because the string is used as format string.
130 Otherwise, it will be auto-detected by Tramp, if
131 `tramp-use-ssh-controlmaster-options' is non-nil. The value
132 depends on the installed local ssh version.
136 ;; Initialize `tramp-methods' with the supported methods.
137 ;;;###tramp-autoload
149 ;;;###tramp-autoload
160 ;;;###tramp-autoload
174 ;;;###tramp-autoload
189 ;;;###tramp-autoload
205 ;;;###tramp-autoload
213 ;;;###tramp-autoload
221 ;;;###tramp-autoload
231 ;;;###tramp-autoload
241 ;;;###tramp-autoload
249 ;;;###tramp-autoload
258 ;; We use "-v" for better error tracking.
261 ;; We use "-p" as required for newer busyboxes. For older
262 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
263 ;; can be achieved by tweaking `tramp-connection-properties'.
265 ;;;###tramp-autoload
274 ;;;###tramp-autoload
276 'tramp-methods
283 ;;;###tramp-autoload
287 ;; The password template must be masked. Otherwise, it could be
288 ;; interpreted as password prompt if the remote host echoes the command.
291 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
297 ;;;###tramp-autoload
305 ;;;###tramp-autoload
314 ;;;###tramp-autoload
322 ;;;###tramp-autoload
326 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
330 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
331 tramp-terminal-type
332 tramp-initial-end-of-output))
337 ;;;###tramp-autoload
343 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
344 tramp-terminal-type
345 tramp-initial-end-of-output))
350 ;;;###tramp-autoload
357 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
358 tramp-terminal-type
359 tramp-initial-end-of-output))
369 ;;;###tramp-autoload
376 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
377 tramp-terminal-type
378 tramp-initial-end-of-output))
387 ;;;###tramp-autoload
399 ;;;###tramp-autoload
403 ;;;###tramp-autoload
407 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
408 ;; Do not add "plink" based methods, they ask interactively for the user.
409 ;;;###tramp-autoload
418 ;;;###tramp-autoload
424 ;;;###tramp-autoload
440 ;;;###tramp-autoload
445 ;;;###tramp-autoload
450 ;;;###tramp-autoload
455 ;;;###tramp-autoload
463 ;;;###tramp-autoload
492 ;; "getconf PATH" yields:
493 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
494 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
495 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
496 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
497 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
498 ;; IRIX64: /usr/bin
499 ;; QNAP QTS: ---
500 ;;;###tramp-autoload
506 "List of directories to search for executables on remote host.
507 For every remote host, this variable will be set buffer local,
508 keeping the list of existing directories on that host.
510 You can use `~' in this list, but when searching for a shell which groks
511 tilde expansion, all directory names starting with `~' will be ignored.
513 `Default Directories' represent the list of directories given by
515 entry on head of this list, because these are the default
516 directories for POSIX compatible commands. On remote hosts which
517 do not offer the getconf command (like cygwin), the value
519 the list by the special value `tramp-default-remote-path'.
521 `Private Directories' are the settings of the $PATH environment,
522 as given in your `~/.profile'. This entry is represented in
523 the list by the special value `tramp-own-remote-path'."
531 ;;;###tramp-autoload
538 "List of environment variables to be set on the remote host.
540 Each element should be a string of the form ENVVARNAME=VALUE. An
541 entry ENVVARNAME= disables the corresponding environment variable,
542 which might have been set in the init files like ~/.profile.
544 Special handling is applied to the PATH environment, which should
545 not be set here. Instead, it should be set via `tramp-remote-path'."
551 ;;;###tramp-autoload
553 "Alist specifying extra arguments to pass to the remote shell.
554 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
555 matching the shell file name and ARGS is a string specifying the
556 arguments.
558 This variable is only used when Tramp needs to start up another shell
559 for tilde expansion. The extra arguments should typically prevent the
560 shell from reading its init file."
562 ;; This might be the wrong way to test whether the widget type
563 ;; `alist' is available. Who knows the right way to test it?
579 "List of pattern/action pairs.
580 Whenever a pattern matches, the corresponding action is performed.
581 Each item looks like (PATTERN ACTION).
583 The PATTERN should be a symbol, a variable. The value of this
584 variable gives the regular expression to search for. Note that the
586 appended to it.
588 The ACTION should also be a symbol, but a function. When the
596 "List of pattern/action pairs.
597 This list is used for copying/renaming with out-of-band methods.
602 "(echo begin 600 %t; tail -n +2) | uudecode
603 cat %t
604 rm -f %t"
605 "Shell function to implement `uudecode' to standard output.
606 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
607 for this or `uudecode -p', but some systems don't, and for them
611 "%s -e '
612 use File::Spec;
615 sub myrealpath {
616 my ($file) = @_;
617 return realpath($file) if -e $file;
618 }
620 sub recursive {
621 my ($volume, @dirs) = @_;
622 my $real = myrealpath(File::Spec->catpath(
624 if ($real) {
625 my ($vol, $dir) = File::Spec->splitpath($real, 1);
626 return ($vol, File::Spec->splitdir($dir));
627 }
628 else {
629 my $last = pop(@dirs);
630 ($volume, @dirs) = recursive($volume, @dirs);
631 push(@dirs, $last);
632 return ($volume, @dirs);
633 }
634 }
636 $result = myrealpath($ARGV[0]);
637 if (!$result) {
638 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
639 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
642 }
647 "Perl script to produce output suitable for use with `file-truename'
648 on the remote file system.
649 Escape sequence %s is replaced with name of Perl binary.
653 "%s -e '
655 @files = readdir(d); closedir(d);
656 foreach $f (@files) {
659 }
660 else {
662 }
663 }
666 "Perl script to produce output suitable for use with
667 `file-name-all-completions' on the remote file system. Escape
668 sequence %s is replaced with name of Perl binary. This string is
671 ;; Perl script to implement `file-attributes' in a Lisp `read'able
672 ;; output. If you are hacking on this, note that you get *no* output
673 ;; unless this spits out a complete line, including the '\n' at the
674 ;; end.
675 ;; The device number is returned as "-1", because there will be a virtual
676 ;; device number set in `tramp-sh-handle-file-attributes'.
678 "%s -e '
679 @stat = lstat($ARGV[0]);
680 if (!@stat) {
682 exit 0;
683 }
684 if (($stat[2] & 0170000) == 0120000)
685 {
686 $type = readlink($ARGV[0]);
689 }
690 elsif (($stat[2] & 0170000) == 040000)
691 {
693 }
694 else
695 {
697 };
700 printf(
702 $type,
703 $stat[3],
704 $uid,
705 $gid,
706 $stat[8] >> 16 & 0xffff,
707 $stat[8] & 0xffff,
708 $stat[9] >> 16 & 0xffff,
709 $stat[9] & 0xffff,
710 $stat[10] >> 16 & 0xffff,
711 $stat[10] & 0xffff,
712 $stat[7],
713 $stat[2],
714 $stat[1] >> 16 & 0xffff,
715 $stat[1] & 0xffff
717 "Perl script to produce output suitable for use with `file-attributes'
718 on the remote file system.
719 Escape sequence %s is replaced with name of Perl binary.
723 "%s -e '
726 @list = readdir(DIR);
727 closedir(DIR);
728 $n = scalar(@list);
730 for($i = 0; $i < $n; $i++)
731 {
732 $filename = $list[$i];
733 @stat = lstat($filename);
734 if (($stat[2] & 0170000) == 0120000)
735 {
736 $type = readlink($filename);
739 }
740 elsif (($stat[2] & 0170000) == 040000)
741 {
743 }
744 else
745 {
747 };
751 printf(
752 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
753 $filename,
754 $type,
755 $stat[3],
756 $uid,
757 $gid,
758 $stat[8] >> 16 & 0xffff,
759 $stat[8] & 0xffff,
760 $stat[9] >> 16 & 0xffff,
761 $stat[9] & 0xffff,
762 $stat[10] >> 16 & 0xffff,
763 $stat[10] & 0xffff,
764 $stat[7],
765 $stat[2],
766 $stat[1] >> 16 & 0xffff,
767 $stat[1] & 0xffff,
768 $stat[0] >> 16 & 0xffff,
769 $stat[0] & 0xffff);
770 }
772 "Perl script implementing `directory-files-attributes' as Lisp `read'able
773 output.
774 Escape sequence %s is replaced with name of Perl binary.
777 ;; These two use base64 encoding.
779 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
780 "Perl program to use for encoding a file.
781 Escape sequence %s is replaced with name of Perl binary.
782 This string is passed to `format', so percent characters need to be doubled.
783 This implementation requires the MIME::Base64 Perl module to be installed
787 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
788 "Perl program to use for decoding a file.
789 Escape sequence %s is replaced with name of Perl binary.
790 This string is passed to `format', so percent characters need to be doubled.
791 This implementation requires the MIME::Base64 Perl module to be installed
795 "%s -e '
796 # This script contributed by Juanma Barranquero <lektu@terra.es>.
797 # Copyright (C) 2002-2017 Free Software Foundation, Inc.
798 use strict;
800 my %%trans = do {
801 my $i = 0;
802 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
803 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
804 };
805 my $data;
807 # We read in chunks of 54 bytes, to generate output lines
808 # of 72 chars (plus end of line)
809 while (read STDIN, $data, 54) {
810 my $pad = q();
812 # Only for the last chunk, and only if did not fill the last three-byte packet
813 if (eof) {
814 my $mod = length($data) %% 3;
815 $pad = q(=) x (3 - $mod) if $mod;
816 }
818 # Not the fastest method, but it is simple: unpack to binary string, split
819 # by groups of 6 bits and convert back from binary to byte; then map into
820 # the translation table
821 print
822 join q(),
823 map($trans{$_},
824 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
825 $pad,
827 }' 2>/dev/null"
828 "Perl program to use for encoding a file.
829 Escape sequence %s is replaced with name of Perl binary.
833 "%s -e '
834 # This script contributed by Juanma Barranquero <lektu@terra.es>.
835 # Copyright (C) 2002-2017 Free Software Foundation, Inc.
836 use strict;
838 my %%trans = do {
839 my $i = 0;
840 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
841 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
842 };
844 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
848 # We are going to accumulate into $pending to accept any line length
849 # (we do not check they are <= 76 chars as the RFC says)
850 my $pending = q();
852 while (my $data = <STDIN>) {
853 chomp $data;
855 # If we find one or two =, we have reached the end and
856 # any following data is to be discarded
857 my $finished = $data =~ s/(==?).*/$1/;
858 $pending .= $data;
860 my $len = length($pending);
861 my $chunk = substr($pending, 0, $len & ~3);
862 $pending = substr($pending, $len & ~3 + 1);
864 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
865 # split in 8-bit chunks and convert back to char.
866 print join q(),
867 map $bytes{$_},
868 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
870 last if $finished;
871 }' 2>/dev/null"
872 "Perl program to use for decoding a file.
873 Escape sequence %s is replaced with name of Perl binary.
877 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
878 "Perl program to use for encoding a file.
882 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
883 "Perl program to use for decoding a file.
888 BEGIN {
891 }
892 {
893 for (c=1; c<=length($0); c++) {
894 d=index(b16, substr($0,c,1))
895 if (d--) {
896 for (b=1; b<=4; b++) {
897 o=o*2+int(d/8); d=(d*2)%%16
898 if (++obc==6) {
899 printf substr(b64,o+1,1)
901 obc=0; o=0
902 }
903 }
904 }
905 }
906 }
907 END {
908 if (obc) {
910 while (obc++<6) { o=o*2 }
912 } else {
914 }
915 printf tail
916 }'"
917 "Awk program to use for encoding a file.
922 BEGIN {
924 }
925 {
926 for (i=1; i<=length($0); i++) {
927 c=index(b64, substr($0,i,1))
928 if(c--) {
929 for(b=0; b<6; b++) {
930 o=o*2+int(c/32); c=(c*2)%%64
931 if(++obc==8) {
932 if (o) {
934 } else {
936 }
937 obc=0; o=0
938 }
939 }
940 }
941 }
942 }'"
943 "Awk program to use for decoding a file.
947 "test -c /dev/zero && \
948 od -v -t x1 -A n </dev/null && \
949 busybox awk '{}' </dev/null"
960 while read file; do
963 else
965 fi
968 else
970 fi
971 done
973 "Script to check existence of VC related files.
974 It must be send formatted with two strings; the tests for file
975 existence, and file readability. Input shall be read via
976 here-document, otherwise the command could exceed maximum length
979 ;; New handlers should be added here.
983 ;; `byte-compiler-base-file-name' performed by default handler.
988 ;; `diff-latest-backup-file' performed by default handler.
992 . tramp-sh-handle-directory-files-and-attributes)
1012 ;; `file-name-sans-versions' performed by default handler.
1026 ;; `find-file-noselect' performed by default handler.
1027 ;; `get-file-buffer' performed by default handler.
1050 "Alist of handler functions.
1053 ;; This must be the last entry, because `identity' always matches.
1054 ;;;###tramp-autoload
1058 ;;; File Name Handler Functions:
1062 "Like `make-symbolic-link' for Tramp files.
1063 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1064 the symlink. If LINKNAME is a Tramp file, only the localname component is
1065 used as the target of the symlink.
1067 If LINKNAME is a Tramp file and the localname component is relative, then
1068 it is expanded first, before the localname component is taken. Note that
1069 this can give surprising results if the user/host for the source and
1070 target of the symlink differ."
1077 l 'file-error
1080 ;; Do the 'confirm if exists' thing.
1082 ;; What to do?
1087 "File %s already exists; make it a link anyway? "
1088 l-localname)))))
1093 ;; If FILENAME is a Tramp name, use just the localname component.
1102 ;; Right, they are on the same host, regardless of user, method,
1103 ;; etc. We now make the link on the remote machine. This will
1104 ;; occur as the user that FILENAME belongs to.
1109 "%s -sf %s %s"
1110 ln
1112 ;; The command could exceed PATH_MAX, so we use
1113 ;; relative file names. However, relative file names
1114 ;; could start with "-". `tramp-shell-quote-argument'
1115 ;; does not handle this, we must do it ourselves.
1120 "Like `file-truename' for Tramp files."
1122 "%s%s"
1125 method user host
1132 ;; Use GNU readlink --canonicalize-missing where available.
1135 v
1143 ;; Use Perl implementation.
1151 v
1155 ;; Do it yourself.
1159 ;; Don't make the following value larger than
1160 ;; necessary. People expect an error message in a
1161 ;; timely fashion when something is wrong;
1162 ;; otherwise they might think that Emacs is hung.
1163 ;; Of course, correctness has to come first.
1165 symlink-target)
1177 method user host
1189 ;; It's a symlink, follow it.
1195 ;; If the symlink was absolute, we'll get a
1196 ;; string like "/user@host:/some/target";
1197 ;; extract the "/some/target" part from it.
1201 v 'file-error
1202 "Symlink target `%s' on wrong host"
1203 symlink-target))
1209 ;; It's a file.
1213 v 'file-error
1216 ;; Combine list to form string.
1226 result))))
1228 ;; Preserve trailing "/".
1231 ;; Basic functions.
1234 "Like `file-exists-p' for Tramp files."
1242 v
1244 "%s %s"
1249 "Like `file-attributes' for Tramp files."
1252 ;; Don't modify `last-coding-system-used' by accident.
1259 v
1267 ;; The scripts could fail, for example with huge file size.
1271 "Implement `file-attributes' for Tramp files using the ls(1) command."
1273 res-inode res-filemodes res-numlinks
1274 res-uid res-gid res-size res-symlink-target)
1276 ;; We cannot send all three commands combined, it could exceed
1277 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1279 vec
1284 vec
1289 vec
1293 ;; On systems which have no quoting style, file names
1294 ;; with special characters could fail.
1302 ;; Parse `ls -l' output ...
1306 ;; ... inode
1322 ;; ... file mode flags
1324 ;; ... number links
1326 ;; ... uid and gid
1338 ;; ... size
1340 ;; From the file modes, figure out other stuff.
1343 ;; If symlink, find out file name pointed to.
1350 ;; Return data gathered.
1352 ;; 0. t for directory, string (name linked to) for symbolic
1353 ;; link, or nil.
1355 ;; 1. Number of links to file.
1356 res-numlinks
1357 ;; 2. File uid.
1358 res-uid
1359 ;; 3. File gid.
1360 res-gid
1361 ;; 4. Last access time, as a list of integers. Normally
1362 ;; this would be in the same format as `current-time', but
1363 ;; the subseconds part is not currently implemented, and
1364 ;; (0 0) denotes an unknown time.
1365 ;; 5. Last modification time, likewise.
1366 ;; 6. Last status change time, likewise.
1368 ;; 7. Size in bytes (-1, if number is out of range).
1369 res-size
1370 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1371 res-filemodes
1372 ;; 9. t if file's gid would change if file were deleted and
1373 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1374 t
1375 ;; 10. Inode number.
1376 res-inode
1377 ;; 11. Device number. Will be replaced by a virtual device number.
1382 "Implement `file-attributes' for Tramp files using a Perl script."
1387 vec
1393 "Implement `file-attributes' for Tramp files using stat(1) command."
1396 vec
1399 ;; On Opsware, pdksh (which is the true name of ksh there)
1400 ;; doesn't parse correctly the sequence "((". Therefore, we add
1401 ;; a space. Apostrophes in the stat output are masked as
1402 ;; `tramp-stat-marker', in order to make a proper shell escape of
1403 ;; them in file names.
1404 "( (%s %s || %s -h %s) && (%s -c "
1405 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1412 tramp-stat-marker tramp-stat-marker
1417 tramp-stat-marker tramp-stat-marker
1419 tramp-stat-quoted-marker)))
1422 "Like `set-visited-file-modtime' for Tramp files."
1429 coding-system-used)
1433 ;; '(-1 65535) means file doesn't exists yet.
1437 ;; We use '(0 0) as a don't-know value. See also
1438 ;; `tramp-do-file-attributes-with-ls'.
1443 v
1451 nil)))))
1453 ;; This function makes the same assumption as
1454 ;; `tramp-sh-handle-set-visited-file-modtime'.
1456 "Like `verify-visited-file-modtime' for Tramp files.
1457 At the time `verify-visited-file-modtime' calls this function, we
1458 already know that the buffer is visiting a file and that
1459 `visited-file-modtime' does not return 0. Do not call this
1460 function directly, unless those two cases are already taken care
1461 of."
1464 ;; There is no file visiting the buffer, or the buffer has no
1465 ;; recorded last modification time, or there is no established
1466 ;; connection.
1470 t
1478 ;; File exists, and has a known modtime.
1481 modtime
1482 ;; For compatibility, deal with both the old
1483 ;; (HIGH . LOW) and the new (HIGH LOW) return
1484 ;; values of `visited-file-modtime'.
1487 mt)))
1489 ;; Modtime has the don't know value.
1492 v
1499 attr
1502 ;; If file does not exist, say it is not modified if and
1503 ;; only if that agrees with the buffer's record.
1507 "Like `set-file-modes' for Tramp files."
1511 ;; FIXME: extract the proper text from chmod's stderr.
1513 v
1518 "Like `set-file-times' for Tramp files."
1525 time)))
1528 "env TZ=UTC %s %s %s"
1536 "Set the ownership for FILENAME.
1537 If UID and GID are provided, these values are used; otherwise uid
1538 and gid of the corresponding user is taken. Both parameters must
1539 be non-negative integers."
1540 ;; Modern Unices allow chown only for root. So we might need
1541 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1542 ;; working with su(do)? when it is needed, so it shall succeed in
1543 ;; the majority of cases.
1544 ;; Don't modify `last-coding-system-used' by accident.
1549 ;; If we are root on the local host, we can do it directly.
1557 "chown %d:%d %s" uid gid
1560 ;; We handle also the local part, because there doesn't exist
1561 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1562 ;; timeout for this.
1567 nil "chown" nil nil nil
1571 "Check, whether SELINUX is enabled on the remote host."
1576 "Like `file-selinux-context' for Tramp files."
1585 "%s -d -Z %s"
1593 ;; Return the context.
1594 context))))
1597 "Like `set-file-selinux-context' for Tramp files."
1617 t)))))
1620 "Check, whether ACL is enabled on the remote host."
1625 "Like `file-acl' for Tramp files."
1631 "getfacl -ac %s"
1640 "Like `set-file-acl' for Tramp files."
1647 tramp-end-of-heredoc
1648 acl-string
1649 tramp-end-of-heredoc))
1651 ;; Success.
1654 t)
1655 ;; In case of errors, we return nil.
1657 nil)))
1659 ;; Simple functions using the `test' command.
1662 "Like `file-executable-p' for Tramp files."
1665 ;; Examine `file-attributes' cache to see if request can be
1666 ;; satisfied without remote operation.
1671 "Like `file-readable-p' for Tramp files."
1674 ;; Examine `file-attributes' cache to see if request can be
1675 ;; satisfied without remote operation.
1679 ;; When the remote shell is started, it looks for a shell which groks
1680 ;; tilde expansion. Here, we assume that all shells which grok tilde
1681 ;; expansion will also provide a `test' command which groks `-nt' (for
1682 ;; newer than). If this breaks, tell me about it and I'll try to do
1683 ;; something smarter about it.
1685 "Like `file-newer-than-file-p' for Tramp files."
1687 nil)
1689 t)
1690 ;; We are sure both files exist at this point.
1693 ;; We try to get the mtime of both files. If they are not
1694 ;; equal to the "dont-know" value, then we subtract the times
1695 ;; and obtain the result.
1708 ;; If one of them is the dont-know value, then we can
1709 ;; still try to run a shell command on the remote host.
1710 ;; However, this only works if both files are Tramp
1711 ;; files and both have the same method, same user, same
1712 ;; host.
1717 v 'file-error
1718 "Files %s and %s must have same method, user, host"
1719 file1 file2)))
1724 ;; Functions implemented using the basic functions above.
1727 "Like `file-directory-p' for Tramp files."
1729 ;; `file-directory-p' is used as predicate for file name completion.
1730 ;; Sometimes, when a connection is not established yet, it is
1731 ;; desirable to return t immediately for "/method:foo:". It can
1732 ;; be expected that this is always a directory.
1738 "Like `file-writable-p' for Tramp files."
1742 ;; Examine `file-attributes' cache to see if request can be
1743 ;; satisfied without remote operation.
1746 ;; If file doesn't exist, check if directory is writable.
1751 "Like `file-ownership-preserved-p' for Tramp files."
1755 ;; Return t if the file doesn't exist, since it's true that no
1756 ;; information would be lost by an (attempted) delete and create.
1765 ;; Directory listings.
1769 "Like `directory-files-and-attributes' for Tramp files."
1777 v localname
1788 v localname id-format))
1791 v localname id-format))
1793 result item)
1803 result
1805 ;; The scripts could fail, for example with huge file size.
1807 directory full match nosort id-format)))))
1811 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1814 vec tramp-perl-directory-files-and-attributes
1818 vec
1822 object))
1826 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1829 vec
1832 ;; We must care about file names with spaces, or starting with
1833 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1834 ;; but it does not work on all remote systems. Apostrophes in
1835 ;; the stat output are masked as `tramp-stat-marker', in order to
1836 ;; make a proper shell escape of them in file names.
1838 "xargs %s -c "
1839 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1843 ;; On systems which have no quoting style, file names with special
1844 ;; characters could fail.
1852 tramp-stat-marker tramp-stat-marker
1853 tramp-stat-marker tramp-stat-marker
1858 tramp-stat-marker tramp-stat-marker
1859 tramp-stat-quoted-marker)))
1861 ;; This function should return "foo/" for directories and "bar" for
1862 ;; files.
1864 "Like `file-name-all-completions' for Tramp files."
1867 filename
1871 ;; Get a list of directories and files, including reliably
1872 ;; tagging the directories with a trailing "/". Because I
1873 ;; rock. --daniel@danann.net
1875 v
1879 v tramp-perl-file-name-all-completions
1885 "(cd %s 2>&1 && %s -a 2>/dev/null"
1886 " | while IFS= read f; do"
1894 ;; Now grab the output.
1898 ;; Check result code, found in last line of output.
1902 ;; Grab error message from line before last line
1903 ;; (it was put there by `cd 2>&1').
1906 v 'file-error
1907 "tramp-sh-handle-file-name-all-completions: %s"
1909 ;; For peace of mind, if buffer doesn't end in `fail'
1910 ;; then it should end in `ok'. If neither are in the
1911 ;; buffer something went seriously wrong on the remote
1912 ;; side.
1916 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1921 result))))))
1923 ;; cp, mv and ln
1927 "Like `add-name-to-file' for Tramp files."
1932 v 'file-error
1933 "add-name-to-file: %s"
1942 "File %s already exists; make it a new name anyway? "
1943 newname)))
1945 v2 'file-already-exists
1951 v1
1955 "error with add-name-to-file, see buffer `%s' for details"
1960 preserve-uid-gid preserve-extended-attributes)
1961 "Like `copy-file' for Tramp files."
1965 ;; At least one file a Tramp file?
1969 'copy filename newname ok-if-already-exists keep-date
1970 preserve-uid-gid preserve-extended-attributes))
1971 ;; Compat section. PRESERVE-EXTENDED-ATTRIBUTES has been
1972 ;; introduced with Emacs 24.1 (as PRESERVE-SELINUX-CONTEXT), and
1973 ;; renamed in Emacs 24.3.
1976 'copy-file
1978 preserve-uid-gid preserve-extended-attributes)))
1981 'copy-file
1986 "Like `copy-directory' for Tramp files."
1992 ;; When DIRNAME and NEWNAME are remote, they must have
1993 ;; the same method.
1999 ;; scp or rsync DTRT.
2013 ;; We must do it file-wise.
2015 'copy-directory
2020 ;; When newname did exist, we have wrong cached values.
2028 "Like `rename-file' for Tramp files."
2029 ;; Check if both files are local -- invoke normal rename-file.
2030 ;; Otherwise, use Tramp from local system.
2033 ;; At least one file a Tramp file?
2037 'rename filename newname ok-if-already-exists
2044 preserve-uid-gid preserve-extended-attributes)
2045 "Copy or rename a remote file.
2046 OP must be `copy' or `rename' and indicates the operation to perform.
2047 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2048 the new file (for copy) or the new name of the file (for rename).
2049 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2050 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2051 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2052 the uid and gid if both files are on the same host.
2053 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2055 This function is invoked by `tramp-sh-handle-copy-file' and
2056 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2057 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2058 file names."
2076 filename newname)
2079 ;; Both are Tramp files.
2084 ;; Shortcut: if method, host, user are the same for
2085 ;; both files, we invoke `cp' or `mv' on the remote
2086 ;; host directly.
2089 op filename newname
2090 ok-if-already-exists keep-date preserve-uid-gid))
2092 ;; Try out-of-band operation.
2097 op filename newname keep-date))
2099 ;; No shortcut was possible. So we copy the file
2100 ;; first. If the operation was `rename', we go back
2101 ;; and delete the original file (if the copy was
2102 ;; successful). The approach is simple-minded: we
2103 ;; create a new buffer, insert the contents of the
2104 ;; source file into it, then write out the buffer to
2105 ;; the target file. The advantage is that it doesn't
2106 ;; matter which file name handlers are used for the
2107 ;; source and target file.
2110 op filename newname keep-date))))))
2112 ;; One file is a Tramp file, the other one is local.
2115 ;; Fast track on local machine.
2118 op filename newname
2119 ok-if-already-exists keep-date preserve-uid-gid))
2121 ;; If the Tramp file has an out-of-band method, the
2122 ;; corresponding copy-program can be invoked.
2125 op filename newname keep-date))
2127 ;; Use the inline method via a Tramp buffer.
2129 op filename newname keep-date))))
2132 ;; One of them must be a Tramp file.
2135 ;; Handle `preserve-extended-attributes'. We ignore possible
2136 ;; errors, because ACL strings could be incompatible.
2141 ;; In case of `rename', we must flush the cache of the source file.
2147 ;; When newname did exist, we have wrong cached values.
2154 "Use an Emacs buffer to copy or rename a file.
2155 First arg OP is either `copy' or `rename' and indicates the operation.
2156 FILENAME is the source file, NEWNAME the target file.
2157 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2158 ;; We must disable multibyte, because binary data shall not be
2159 ;; converted. We don't want the target file to be compressed, so we
2160 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2161 ;; be called either. We remove `tramp-file-name-handler' from
2162 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2163 ;; `insert-file-contents' might be deactivated in some corner cases.
2174 ;; KEEP-DATE handling.
2177 newname
2180 ;; Set the mode.
2182 ;; If the operation was `rename', delete the original file.
2187 "Invokes `cp' or `mv' on the remote system.
2188 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2189 respectively. FILENAME specifies the file to copy or rename,
2190 NEWNAME is the name of the new file (for copy) or the new name of
2191 the file (for rename). Both files must reside on the same host.
2192 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2193 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2194 the uid and gid from FILENAME."
2205 v 'file-error
2206 "Unknown operation `%s', must be `copy' or `rename'"
2207 op))))
2211 cmd-result)
2214 ;; Both files are on a remote host, with same user.
2226 ;; Mask cp -f error.
2228 tramp-operation-not-permitted-regexp nil t))
2229 cmd-result)
2231 nil v 'file-error
2232 "Copying directly failed, see buffer `%s' for details."
2235 ;; We are on the local host.
2238 ;; We can do it directly.
2241 ;; No sticky bit when renaming.
2252 localname1 localname2 ok-if-already-exists
2253 keep-date preserve-uid-gid)
2257 ;; We can do it directly with `tramp-send-command'
2265 ok-if-already-exists keep-date t)
2266 ;; We must change the ownership to the local user.
2272 ;; We need a temporary file in between.
2274 ;; Create the temporary file.
2282 "%s %s %s" cmd
2285 "Copying directly failed, see buffer `%s' for details."
2287 ;; We must change the ownership as remote user.
2288 ;; Since this does not work reliable, we also
2289 ;; give read permissions.
2299 localname1 tmpfile t keep-date preserve-uid-gid)
2302 ;; We must change the ownership as local user.
2303 ;; Since this does not work reliable, we also
2304 ;; give read permissions.
2307 tmpfile
2311 ;; Move the temporary file to its destination.
2316 "cp -f -p %s %s"
2319 "Copying directly failed, see buffer `%s' for details."
2323 'rename-file
2326 ;; Save exit.
2329 ;; Set the time and mode. Mask possible errors.
2336 "Invoke `scp' program to copy.
2337 The method used must be an out-of-band method."
2341 copy-program copy-args copy-env copy-keep-date port listener spec
2342 options source target remote-copy-program remote-copy-args)
2347 ;; Both are Tramp files. We shall optimize it when the
2348 ;; methods for FILENAME and NEWNAME are the same.
2358 op filename tmpfile keep-date)
2361 ;; Save exit.
2368 ;; Set variables for computing the prompt for reading
2369 ;; password.
2376 ;; Check which ones of source and target are Tramp files.
2380 'file-name-as-directory
2389 ;; Check for host and port number.
2393 ;; Check for user. There might be an interactive setting.
2397 ;; Check for listener port.
2404 ;; Compose copy command.
2413 ?h host ?u user ?p port ?r listener ?c options
2419 copy-args
2421 ;; " " has either been a replacement of "%k" (when
2422 ;; keep-date argument is non-nil), or a replacement
2423 ;; for the whole keep-date sublist.
2424 " "
2429 copy-args
2433 copy-env
2435 nil
2442 remote-copy-program
2448 remote-copy-args
2452 ;; Check for local copy program.
2457 ;; Install listener on the remote side. The prompt must be
2458 ;; consumed later on, when the process does not listen anymore.
2465 v 'file-error
2469 'identity
2477 v 'file-error
2478 "Listener process not running on remote host: `%s'"
2479 remote-copy-program))
2487 ;; The default directory must be remote.
2491 ;; Set the transfer process properties.
2501 copy-args
2503 copy-args
2508 ;; Use an asynchronous process. By this, password can
2509 ;; be handled. We don't set a timeout, because the
2510 ;; copying of large files can last longer than 60 secs.
2520 command))))
2525 ;; We must adapt `tramp-local-end-of-line' for
2526 ;; sending the password.
2529 p v nil tramp-actions-copy-out-of-band))))
2531 ;; Reset the transfer process properties.
2534 ;; Clear the remote prompt.
2537 ;; Houston, we have a problem! Likely, the listener is
2538 ;; still running, so let's clear everything (but the
2539 ;; cached password).
2542 ;; Handle KEEP-DATE argument.
2545 newname
2549 ;; Set the mode.
2554 ;; If the operation was `rename', delete the original file.
2561 "Like `make-directory' for Tramp files."
2573 "Like `delete-directory' for Tramp files."
2585 "Like `delete-file' for Tramp files."
2596 ;; Dired.
2602 "Like `dired-compress-file' for Tramp files."
2603 ;; Code stolen mainly from dired-aux.el.
2608 suffix)
2609 ;; See if any suffix rule matches this file name.
2617 nil)
2619 ;; We found an uncompression rule.
2629 ;; We don't recognize the file as compressed, so compress it.
2630 ;; Try gzip.
2644 "Like `insert-directory' for Tramp files."
2651 filename switches wildcard full-directory-p)
2673 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2674 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2677 v
2680 switches
2682 localname
2685 v
2689 "Couldn't `cd %s'"
2693 v
2696 switches
2701 ""
2709 ;; We cannot use `insert-buffer-substring' because the Tramp
2710 ;; buffer changes its contents before insertion due to calling
2711 ;; `expand-file-name' and alike.
2716 ;; Check for "--dired" output.
2723 ;; Now read the numeric positions of file names.
2729 ;; End is followed by \n or by " -> ".
2731 ;; Remove trailing lines.
2737 ;; Some busyboxes are reluctant to discard colors.
2745 ;; Decode the output, it could be multibyte.
2750 ;; The inserted file could be from somewhere else.
2757 "."
2764 ;; Canonicalization of file names.
2767 "Like `expand-file-name' for Tramp files.
2769 the result will be a local, non-Tramp, file name."
2770 ;; If DIR is not given, use `default-directory' or "/".
2772 ;; Unless NAME is absolute, concat DIR and NAME.
2775 ;; If connection is not established yet, run the real handler.
2778 ;; Dissect NAME.
2782 ;; Tilde expansion if necessary. This needs a shell which
2783 ;; groks tilde expansion! The function `tramp-find-shell' is
2784 ;; supposed to find such a shell on the remote host. Please
2785 ;; tell me about it when this doesn't work on your system.
2789 ;; We cannot simply apply "~/", because under sudo "~/" is
2790 ;; expanded to the local user home directory but to the
2791 ;; root home directory. On the other hand, using always
2792 ;; the default user name for tilde expansion is not
2793 ;; appropriate either, because ssh and companions might
2794 ;; use a user name from the config file.
2806 ;; There might be a double slash, for example when "~/"
2807 ;; expands to "/". Remove this.
2810 ;; No tilde characters in file name, do normal
2811 ;; `expand-file-name' (this does "/./" and "/../").
2812 ;; `default-directory' is bound, because on Windows there would
2813 ;; be problems with UNC shares or Cygwin mounts.
2816 method user host
2820 hop)))))
2822 ;;; Remote commands:
2825 "Flush file caches."
2833 ;; We use BUFFER also as connection buffer during setup. Because of
2834 ;; this, its original contents must be saved, and restored once
2835 ;; connection has been setup.
2837 "Like `start-file-process' for Tramp files."
2842 ;; BUFFER can be nil. We use a temporary buffer.
2844 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2845 ;; it might be that the arguments exceed the command line
2846 ;; length. Therefore, we modify the command.
2851 ;; When PROGRAM is nil, we just provide a tty.
2857 args
2861 ;; Use a human-friendly prompt, for example for `shell'.
2862 ;; We discard hops, if existing, that's why we cannot use
2863 ;; `file-remote-p'.
2870 tramp-initial-end-of-output))
2871 ;; We use as environment the difference to toplevel
2872 ;; `process-environment'.
2873 env uenv
2887 "unset %s &&"
2902 ;; We do not want to raise an error when
2903 ;; `start-file-process' has been started several times in
2904 ;; `eshell' and friends.
2908 ;; NAME must be unique as process name.
2912 ;; Set the new process properties.
2918 ;; We catch this event. Otherwise, `start-process' could
2919 ;; be called on the local host.
2922 ;; Activate narrowing in order to save BUFFER
2923 ;; contents. Clear also the modification time;
2924 ;; otherwise we might be interrupted by
2925 ;; `verify-visited-file-modtime'.
2931 ;; We call `tramp-maybe-open-connection', in order
2932 ;; to cleanup the prompt afterwards.
2938 ;; Now do it.
2940 ;; Send the command.
2942 ;; Check, whether a pty is associated.
2946 v 'file-error
2949 ;; Set query flag and process marker for this
2950 ;; process. We ignore errors, because the process
2951 ;; could have finished already.
2955 ;; Return process.
2956 p))))
2958 ;; Save exit.
2969 "Like `process-file' for Tramp files."
2970 ;; The implementation is not complete yet.
2976 ;; Compute command.
2979 ;; We use as environment the difference to toplevel `process-environment'.
2990 "env %s %s"
2995 "unset %s && %s"
2997 ;; Determine input.
3002 ;; INFILE is on the same remote host.
3004 ;; INFILE must be copied to remote host.
3010 ;; Determine output.
3012 ;; Just a buffer.
3015 ;; A buffer name.
3018 ;; (REAL-DESTINATION ERROR-DESTINATION)
3020 ;; output.
3028 ;; stderr.
3033 ;; stderr is on the same remote host.
3036 ;; stderr must be copied to remote host. The temporary
3037 ;; file must be deleted after execution.
3040 method user host stderr))))
3041 ;; stderr to be discarded.
3044 ;; 't
3049 ;; Send the command. It might not return in time, so we protect
3050 ;; it. Call it in a subshell, in order to preserve working
3051 ;; directory.
3058 command)
3059 t t)
3061 ;; We should add the output anyway.
3068 ;; When the user did interrupt, we should do it also. We use
3069 ;; return code -1 as marker.
3073 ;; Handle errors.
3078 ;; Provide error file.
3081 ;; Cleanup. We remove all file cache values for the connection,
3082 ;; because the remote process could have changed them.
3088 ;; Return exit status.
3091 ret))))
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."
3179 ;; Following part commented out because we don't know what to do about
3180 ;; file locking, and it does not appear to be a problem to ignore it.
3181 ;; Ange-ftp ignores it, too.
3182 ;; (when (and lockname (stringp lockname))
3183 ;; (setq lockname (expand-file-name lockname)))
3184 ;; (unless (or (eq lockname nil)
3185 ;; (string= lockname filename))
3186 ;; (error
3187 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3201 ;; `file-writable-p' calls `file-expand-file-name'. We
3202 ;; cannot use `tramp-run-real-handler' therefore.
3208 ;; Short track: if we are on the local host, we can run directly.
3210 'write-region
3214 ;; We use this to save the value of
3215 ;; `last-coding-system-used' after writing the tmp
3216 ;; file. At the end of the function, we set
3217 ;; `last-coding-system-used' to this saved value. This
3218 ;; way, any intermediary coding systems used while
3219 ;; talking to the remote shell or suchlike won't hose
3220 ;; this variable. This approach was snarfed from
3221 ;; ange-ftp.el.
3222 coding-system-used
3223 ;; Write region into a tmp file. This isn't really
3224 ;; needed if we use an encoding function, but currently
3225 ;; we use it always because this makes the logic
3226 ;; simpler. We must also set `temporary-file-directory',
3227 ;; because it could point to a remote directory.
3233 ;; If `append' is non-nil, we copy the file locally, and let
3234 ;; the native `write-region' implementation do the job.
3237 ;; We say `no-message' here because we don't want the
3238 ;; visited file modtime data to be clobbered from the temp
3239 ;; file. We call `set-visited-file-modtime' ourselves later
3240 ;; on. We must ensure that `file-coding-system-alist'
3241 ;; matches `tmpfile'.
3247 'write-region
3254 ;; Now, `last-coding-system-used' has the right value. Remember it.
3257 ;; The permissions of the temporary file should be set. If
3258 ;; FILENAME does not exist (eq modes nil) it has been
3259 ;; renamed to the backup file. This case `save-buffer'
3260 ;; handles permissions.
3261 ;; Ensure that it is still readable.
3264 tmpfile
3267 ;; This is a bit lengthy due to the different methods
3268 ;; possible for file transfer. First, we check whether the
3269 ;; method uses an scp program. If so, we call it.
3270 ;; Otherwise, both encoding and decoding command must be
3271 ;; specified. However, if the method _also_ specifies an
3272 ;; encoding function, then that is used for encoding the
3273 ;; contents of the tmp file.
3279 ;; `copy-file' handles direct copy and out-of-band methods.
3289 ;; We keep the local file for performance
3290 ;; reasons, useful for "rsync".
3297 ;; Don't rename, in order to keep context in SELinux.
3302 ;; Use inline file transfer.
3304 ;; Encode tmpfile.
3308 ;; Use encoding function or command.
3311 "Encoding local file `%s' using `%s'"
3312 tmpfile loc-enc)
3314 ;; The following `let' is a workaround for
3315 ;; the base64.el that comes with pgnus-0.84.
3316 ;; If both of the following conditions are
3317 ;; satisfied, it tries to write to a local
3318 ;; file in default-directory, but at this
3319 ;; point, default-directory is remote.
3320 ;; (`call-process-region' can't write to
3321 ;; remote files, it seems.) The file in
3322 ;; question is a tmp file anyway.
3330 loc-enc tmpfile t))
3332 v 'file-error
3335 filename loc-enc))))
3337 ;; Send buffer into remote decoding command which
3338 ;; writes to remote file. Because this happens on
3339 ;; the remote host, we cannot use the function.
3342 "Decoding remote file `%s' using `%s'"
3343 filename rem-dec)
3347 v
3351 tramp-end-of-heredoc
3353 tramp-end-of-heredoc))
3355 v nil
3356 "Couldn't write region to `%s', decode using `%s' failed"
3357 filename rem-dec)
3358 ;; When `file-precious-flag' is set, the region is
3359 ;; written to a temporary file. Check that the
3360 ;; checksum is equal to that from the local tmpfile.
3364 ;; cksum runs locally, if possible.
3366 ;; cksum runs remotely.
3368 v
3371 ;; ... they are different.
3378 v 'file-error
3381 filename rem-dec)))))
3383 ;; Save exit.
3386 ;; That's not expected.
3389 v 'file-error
3392 method))))
3394 ;; Make `last-coding-system-used' have the right value.
3401 ;; We must protect `last-coding-system-used', now we have set it
3402 ;; to its correct value.
3404 ;; Set file modification time.
3408 ;; We must pass modtime explicitly, because FILENAME can
3409 ;; be different from (buffer-file-name), f.e. if
3410 ;; `file-precious-flag' is set.
3416 ;; Set the ownership.
3426 ;; VC backends check for the existence of various different special
3427 ;; files. This is very time consuming, because every single check
3428 ;; requires a remote command (the file cache must be invalidated).
3429 ;; Therefore, we apply a kind of optimization. We install the file
3430 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3431 ;; remembers all file names for which `file-exists-p' or
3432 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3433 ;; is performed. Afterwards, a script is applied for all collected
3434 ;; file names, using just one remote command. The result of this
3435 ;; script is used to fill the file cache with actual values. Now we
3436 ;; can reset the file name handlers, and we make a second run of
3437 ;; `vc-registered', which returns the expected result without sending
3438 ;; any other remote command.
3440 "Like `vc-registered' for Tramp files."
3446 ;; There could be new files, created by the vc backend. We
3447 ;; cannot reuse the old cache entries, therefore. In
3448 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3449 ;; could also be a timestamp as `current-time' returns. This
3450 ;; means invalidate all cache entries with an older timestamp.
3456 ;; Here we collect only file names, which need an operation.
3460 ;; Send just one command, in order to fill the cache.
3463 v
3472 ;; We cannot use `tramp-send-command-and-read',
3473 ;; because this does not cooperate well with
3474 ;; heredoc documents.
3476 v
3479 tramp-end-of-heredoc
3481 tramp-vc-registered-file-names
3483 tramp-end-of-heredoc))
3485 ;; Read the expression.
3492 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3493 ;; calls shall be answered from the file cache. We unset
3494 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3495 ;; in order to keep the cache.
3497 remote-file-name-inhibit-cache process-file-side-effects)
3498 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3517 ;; Run.
3521 ;;;###tramp-autoload
3523 "Invoke remote-shell Tramp file name handler.
3524 Fall back to normal file name handler if no Tramp handler exists."
3542 "Invoke special file name handler, which collects files to be handled."
3550 ;; That's what we want: file names, for which checks are
3551 ;; applied. We assume that VC uses only `file-exists-p' and
3552 ;; `file-readable-p' checks; otherwise we must extend the
3553 ;; list. We do not perform any action, but return nil, in
3554 ;; order to keep `vc-registered' running.
3557 nil)
3558 ;; `process-file' and `start-file-process' shall be ignored.
3561 ;; Tramp file name handlers like `expand-file-name'. They
3562 ;; must still work.
3564 ;; Default file name handlers, we don't care.
3568 "Like `file-notify-add-watch' for Tramp files."
3572 command events filter p sequence)
3574 ;; gvfs-monitor-dir.
3577 events
3581 attribute-changed))
3586 ;; inotifywait.
3589 events
3599 ;; Make events a list of symbols.
3600 events
3604 ;; None.
3606 v 'file-notify-error
3607 "No file notification program found on %s"
3609 ;; Start process.
3611 'start-file-process
3615 sequence))
3616 ;; Return the process object as watch-descriptor.
3619 v 'file-notify-error
3620 "`%s' failed to start on remote host"
3624 ;; Needed for process filter.
3629 ;; There might be an error if the monitor is not supported.
3630 ;; Give the filter a chance to read the output.
3635 p))))
3639 file-notify events."
3649 ;; Attribute change is returned in unused wording.
3661 string)
3666 proc
3671 ;; File names are returned as absolute paths. We must
3672 ;; add the remote prefix.
3676 ;; Remove watch when file or directory to be watched is deleted.
3680 ;; Usually, we would add an Emacs event now. Unfortunately,
3681 ;; `unread-command-events' does not accept several events at
3682 ;; once. Therefore, we apply the handler directly.
3685 'file-notify-handle-event
3688 ;; Save rest of the string.
3698 ;; Check, whether there is a problem.
3704 line)
3709 proc
3716 ;; Remove watch when file or directory to be watched is deleted.
3719 ;; Usually, we would add an Emacs event now. Unfortunately,
3720 ;; `unread-command-events' does not accept several events at
3721 ;; once. Therefore, we apply the handler directly.
3724 'file-notify-handle-event
3727 ;;; Internal Functions:
3730 "Define in remote shell function NAME implemented as SCRIPT.
3731 Only send the definition if it has not already been done."
3732 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3733 ;; might be nil.
3739 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3740 ;; could result in unwanted command expansion. Avoid this.
3743 ;; The script could contain a call of Perl. This is masked with `%s'.
3748 vec
3756 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3757 Returns the exit code of the `test' program."
3760 v
3762 "%s %s %s"
3764 switch
3768 "Run `test'-like program on the remote system, given FILE1, FILE2.
3769 FORMAT-STRING contains the program name, switches, and place holders.
3770 Returns the exit code of the `test' program. Barfs if the methods,
3771 hosts, or files, disagree."
3775 v 'file-error
3780 v1
3787 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3788 First arg VEC specifies the connection, PROGNAME is the program
3789 to search for, and DIRLIST gives the list of directories to
3790 search. If IGNORE-TILDE is non-nil, directory names starting
3791 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3792 only in DIRLIST.
3794 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3796 This function expects to be in the right *tramp* buffer."
3799 ;; Check whether the executable is in $PATH. "which(1)" does not
3800 ;; report always a correct error code; therefore we check the
3801 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3802 ;; 5.11") have problems with this command, we disable the call
3803 ;; therefore.
3814 ;; Remove all ~/foo directories from dirlist.
3823 vec
3825 "do if test -x $d/%s && test -f $d/%s; "
3826 "then echo tramp_executable $d/%s; "
3829 progname progname progname
3830 tramp-end-of-heredoc
3832 tramp-end-of-heredoc))
3838 result)))
3841 "Sets the remote environment PATH to existing directories.
3842 I.e., for each directory in `tramp-remote-path', it is tested
3843 whether it exists and if so, it is added to the environment
3844 variable PATH."
3850 ;; ------------------------------------------------------------
3851 ;; -- Communication with external shell --
3852 ;; ------------------------------------------------------------
3855 "Find a command on the remote host for checking if a file exists.
3856 Here, we are looking for a command which has zero exit status if the
3857 file exists and nonzero exit status otherwise."
3861 result)
3862 ;; The algorithm is as follows: we try a list of several commands.
3863 ;; For each command, we first run `$cmd /' -- this should return
3864 ;; true, as the root directory always exists. And then we run
3865 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3866 ;; does not exist. This should return false. We use the first
3867 ;; command we find that seems to work.
3868 ;; The list of commands to try is as follows:
3869 ;; `ls -d' This works on most systems, but NetBSD 1.4
3870 ;; has a bug: `ls' always returns zero exit
3871 ;; status, even for files which don't exist.
3872 ;; `test -e' Some Bourne shells have a `test' builtin
3873 ;; which does not know the `-e' option.
3874 ;; `/bin/test -e' For those, the `test' binary on disk normally
3875 ;; provides the option. Alas, the binary
3876 ;; is sometimes `/bin/test' and sometimes it's
3877 ;; `/usr/bin/test'.
3878 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3906 result))
3909 "Opens shell SHELL."
3912 ;; Find arguments for this shell.
3914 item extra-args)
3919 ;; It is useful to set the prompt in the following command
3920 ;; because some people have a setting for $PS1 which /bin/sh
3921 ;; doesn't know about and thus /bin/sh will display a strange
3922 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3923 ;; ksh will display the current working directory but /bin/sh
3924 ;; will display a dollar sign. The following command line sets
3925 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3926 ;; well as csh-like shells. We also unset the variable $ENV
3927 ;; because that is read by some sh implementations (eg, bash
3928 ;; when called as sh) on startup; this way, we avoid the startup
3929 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3930 ;; the prompt in /bin/bash, it must be discarded as well.
3931 ;; $HISTFILE is set according to `tramp-histfile-override'.
3934 "exec env ENV=%s %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3940 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3944 t)
3945 ;; Check proper HISTFILE setting. We give up when not working.
3949 vec
3951 "(cd %s)"
3954 "`tramp-histfile-override' uses invalid file `%s'"
3955 tramp-histfile-override)))
3961 "Opens a shell on the remote host which groks tilde expansion."
3964 shell)
3967 ;; CCC: "root" does not exist always, see my QNAP TS-459.
3968 ;; Which check could we apply instead?
3971 ;; The default shell (ksh93) of OpenSolaris and
3972 ;; Solaris is buggy. We've got reports for
3973 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3982 ;; Maybe it works at least for some other commands.
3984 default-shell
3986 vec 2
3988 "Couldn't find a remote shell which groks tilde "
3990 default-shell)))
3992 default-shell)))
3994 ;; Open a new shell if needed.
4000 ;; Utility functions.
4003 "Wait for shell prompt and barf if none appears.
4004 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4005 seconds. If not, it produces an error message with the given ERROR-ARGS."
4009 proc timeout
4018 "Set up an interactive shell.
4019 Mainly sets the prompt and the echo correctly. PROC is the shell
4020 process to set up. VEC specifies the connection."
4025 ;; Disable echo expansion.
4029 ;; Check whether the echo has really been disabled. Some
4030 ;; implementations, like busybox of embedded GNU/Linux, don't
4031 ;; support disabling.
4038 ;; Make sure backspaces and their echo are enabled and no line
4039 ;; width magic interferes with them.
4046 t)
4048 ;; Check whether the output of "uname -sr" has been changed. If
4049 ;; yes, this is a strong indication that we must expire all
4050 ;; connection properties. We start again with
4051 ;; `tramp-maybe-open-connection', it will be caught there.
4056 vec "uname"
4060 vec 3
4061 "Connection reset, because remote host changed from `%s' to `%s'"
4062 old-uname uname)
4063 ;; We want to keep the password.
4067 ;; Try to set up the coding system correctly.
4068 ;; CCC this can't be the right way to do it. Hm.
4071 ;; Use MULE to select the right EOL convention for communicating
4072 ;; with the process.
4078 cs-decode cs-encode)
4082 cs-encode
4089 ;; Special setting for macOS.
4100 ;; Check whether the remote host suffers from buggy
4101 ;; `send-process-string'. This is known for FreeBSD (see comment
4102 ;; in `send_process', file process.c). I've tested sending 624
4103 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4104 ;; hack when this host type is detected locally. It cannot handle
4105 ;; remote hosts, though.
4109 tramp-chunksize)
4115 ;; Set remote PATH variable.
4118 ;; Search for a good shell before searching for a command which
4119 ;; checks if a file exists. This is done because Tramp wants to
4120 ;; use "test foo; echo $?" to check if various conditions hold,
4121 ;; and there are buggy /bin/sh implementations which don't execute
4122 ;; the "echo $?" part if the "test" part has an error. In
4123 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4124 ;; also other problems with /bin/sh of OpenSolaris, like
4125 ;; redirection of stderr in function declarations, or changing
4126 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4127 ;; by bash, when detected.
4130 ;; Disable unexpected output.
4133 ;; IRIX64 bash expands "!" even when in single quotes. This
4134 ;; destroys our shell functions, we must disable it. See
4135 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4139 ;; Disable tab expansion.
4144 ;; Set utf8 encoding. Needed for macOS, for example. This is
4145 ;; non-POSIX, so we must expect errors on some systems.
4148 ;; Set `remote-tty' process property.
4153 ;; Dump stty settings in the traces.
4157 ;; Set the environment.
4171 vec
4174 tramp-end-of-heredoc
4176 tramp-end-of-heredoc)
4177 t))
4182 ;; Old text from documentation of tramp-methods:
4183 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4184 ;; of the base64 methods instead since base64 encoding is much more
4185 ;; reliable and the commands are more standardized between the different
4186 ;; Unix versions. But if you can't use base64 for some reason, please
4187 ;; note that the default uudecode command does not work well for some
4188 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4189 ;; the following command for uudecode:
4190 ;;
4191 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4192 ;;
4193 ;; For Irix, no solution is known yet.
4201 "List of local coding commands for inline transfer.
4202 Each item is a list that looks like this:
4204 \(FORMAT ENCODING DECODING)
4206 FORMAT is symbol describing the encoding/decoding format. It can be
4207 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4209 ENCODING and DECODING can be strings, giving commands, or symbols,
4210 giving functions. If they are strings, then they can contain
4212 file name will be put into the command line at that spot. If the
4213 specifier is not present, the input should be read from standard
4214 input.
4216 If they are functions, they will be called with two arguments, start
4217 and end of region, and are expected to replace the region contents
4222 ;; "-i" is more robust with older base64 from GNU coreutils.
4223 ;; However, I don't know whether all base64 versions do supports
4224 ;; this option.
4232 ;; This is painful slow, so we put it on the end.
4239 "List of remote coding commands for inline transfer.
4240 Each item is a list that looks like this:
4242 \(FORMAT ENCODING DECODING [TEST])
4244 FORMAT is a symbol describing the encoding/decoding format. It can be
4245 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4247 ENCODING and DECODING can be strings, giving commands, or symbols,
4248 giving variables. If they are strings, then they can contain
4250 file name will be put into the command line at that spot. If the
4251 specifier is not present, the input should be read from standard
4252 input.
4254 If they are variables, this variable is a string containing a
4255 Perl or Shell implementation for this functionality. This
4256 program will be transferred to the remote host, and it is
4258 specifier in the variable value denotes a temporary file.
4260 The optional TEST command can be used for further tests, whether
4264 "Find an inline transfer encoding that works.
4265 Goes through the list `tramp-local-coding-commands' and
4266 `tramp-remote-coding-commands'."
4271 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4279 ;; If the local encoder or decoder is a string, the
4280 ;; corresponding command has to work locally.
4287 loc-enc nil nil))
4295 loc-dec nil nil))
4297 ;; Search for remote coding commands with the same format
4305 ;; Check the remote test command if exists.
4311 ;; Check if remote perl exists when necessary.
4316 ;; Check if remote encoding and decoding commands can be
4317 ;; called remotely with null input and output. This makes
4318 ;; sure there are no syntax errors and the command is really
4319 ;; found. Note that we do not redirect stdout to /dev/null,
4320 ;; for two reasons: when checking the decoding command, we
4321 ;; actually check the output it gives. And also, when
4322 ;; redirecting "mimencode" output to /dev/null, then as root
4323 ;; it might change the permissions of /dev/null!
4331 vec 5
4340 tmpfile)
4347 tramp-temp-name-prefix
4349 value
4351 value
4353 ?t
4358 vec 5
4361 vec
4363 t)
4371 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4377 ;; Set connection properties. Since the commands are risky
4378 ;; (due to output direction), we cache them in the process cache.
4389 "Call the local encoding or decoding command.
4391 Otherwise, INPUT is passed via standard input.
4392 INPUT can also be nil which means `/dev/null'.
4393 OUTPUT can be a string (which specifies a file name), or t (which
4394 means standard output and thus the current buffer), or nil (which
4395 means discard it)."
4397 nil tramp-encoding-shell
4400 nil
4401 tramp-encoding-command-switch
4411 "List of compress and decompress commands for inline transfer.
4412 Each item is a list that looks like this:
4414 \(COMPRESS DECOMPRESS)
4419 "Find an inline transfer compress command that works.
4420 Goes through the list `tramp-inline-compress-commands'."
4425 item compress decompress found)
4432 vec 5
4433 "Checking local compress commands `%s', `%s' for sanity"
4434 compress decompress)
4439 ;; Windows shells need the program file name after
4440 ;; the pipe symbol be quoted if they use forward
4441 ;; slashes as directory separators.
4448 vec 5
4449 "Checking remote compress commands `%s', `%s' for sanity"
4450 compress decompress)
4456 ;; Did we find something?
4459 ;; Set connection properties. Since the commands are
4460 ;; risky (due to output direction), we cache them in the
4461 ;; process cache.
4475 "Expands VEC according to `tramp-default-proxies-alist'."
4479 choices proxy)
4481 ;; Ad-hoc proxy definitions.
4486 tramp-prefix-format proxy tramp-postfix-host-format)))
4491 proxy)
4492 ;; Add the hop.
4494 'tramp-default-proxies-alist
4497 proxy))
4499 ;; Save the new value.
4504 ;; Look for proxy hosts to be passed.
4510 ;; Host.
4513 ;; User.
4517 ;; No more hops needed.
4519 ;; Replace placeholders.
4522 proxy
4527 ;; Add the hop.
4529 ;; Start next search.
4532 ;; Foreign and out-of-band methods are not supported for multi-hops.
4539 vec 'file-error
4540 "Method `%s' is not supported for multi-hops."
4543 ;; In case the host name is not used for the remote shell
4544 ;; command, the user could be misguided by applying a random
4545 ;; host name.
4551 ;; There are multi-hops.
4553 ;; The host name is used for the remote shell command.
4555 ;; The host is local. We cannot use `tramp-local-host-p'
4556 ;; here, because it opens a connection as well.
4559 v 'file-error
4560 "Host `%s' looks like a remote host, `%s' can only use the local host"
4561 host method)))
4563 ;; Result.
4564 target-alist))
4567 "Return the Control* arguments of the local ssh."
4569 ;; No options to be computed.
4574 ;; There is already a value to be used.
4577 ;; Determine the options.
4589 ;; We use a non-existing IP address, in order to avoid
4590 ;; useless connections, and DNS timeouts.
4597 " -o ControlPath='tramp.%%r@%%h:%%p'"
4606 tramp-ssh-controlmaster-options)))
4609 "Maybe open a connection VEC.
4610 Does not do anything if a connection is already open, but re-opens the
4611 connection if a previous connection has died for some reason."
4619 ;; If Tramp opens the same connection within a short time frame,
4620 ;; there is a problem. We shall signal this.
4629 ;; If too much time has passed since last command was sent, look
4630 ;; whether process is still alive. If it isn't, kill it. When
4631 ;; using ssh, it can sometimes happen that the remote end has hung
4632 ;; up but the local ssh client doesn't recognize this until it
4633 ;; tries to send some data to the remote end. So that's why we
4634 ;; try to send a command from time to time, then look again
4635 ;; whether the process is really alive.
4646 ;; The error will be caught locally.
4652 ;; New connection must be opened.
4656 ;; If `non-essential' is non-nil, don't reopen a new connection.
4657 ;; This variable has been introduced with Emacs 24.1.
4658 ;; We check this for the process related to
4659 ;; `tramp-buffer-name'; otherwise `start-file-process'
4660 ;; wouldn't run ever when `non-essential' is non-nil.
4666 vec 3
4677 ;; Start new process.
4694 ;; We will apply `tramp-ssh-controlmaster-options'
4695 ;; only for the first hop.
4699 ;; There are unfortunate settings for "cmdproxy" on
4700 ;; W32 systems.
4703 ;; This must be done in order to avoid our file
4704 ;; name handler.
4708 'start-process
4713 tramp-encoding-command-interactive)
4716 ;; Set sentinel and query flag.
4727 ;; Check whether process is alive.
4729 p 10
4732 ;; Now do all the connections as specified.
4751 ;; We don't create the temporary file. In
4752 ;; fact, it is just a prefix for the
4753 ;; ControlPath option of ssh; the real
4754 ;; temporary file has another name, and it is
4755 ;; created and protected by ssh. It is also
4756 ;; removed by ssh when the connection is
4757 ;; closed. The temporary file name is cached
4758 ;; in the main connection process, therefore
4759 ;; we cannot use `tramp-get-connection-process'.
4765 tramp-temp-name-prefix
4767 spec r-shell)
4769 ;; Add arguments for asynchronous processes.
4773 ;; Check for port number. Until now, there's no
4774 ;; need for handling like method, user, host.
4779 ;; Check, whether there is a restricted shell.
4784 ;; Set variables for computing the prompt for
4785 ;; reading password.
4787 tramp-current-user l-user
4788 tramp-current-host l-host)
4790 ;; Add login environment.
4793 login-env
4798 login-env))
4802 "%s=%s %s"
4805 command)))
4808 ;; Replace `login-args' place holders.
4816 ?h l-host ?u l-user ?p l-port ?c options)
4817 command
4819 ;; We do not want to see the trailing local
4820 ;; prompt in `start-file-process'.
4822 command " "
4828 ;; Local shell could be a Windows COMSPEC. It
4829 ;; doesn't know the ";" syntax, but we must exit
4830 ;; always for `start-file-process'. It could
4831 ;; also be a restricted shell, which does not
4832 ;; allow "exec".
4835 ;; Send the command.
4839 p vec
4842 tramp-actions-before-shell
4846 ;; Next hop.
4850 ;; Set connection-local variables.
4853 ;; Make initial shell settings.
4856 ;; Mark it as connected.
4859 ;; Cleanup, and propagate the signal.
4865 "Send the COMMAND to connection VEC.
4866 Erases temporary buffer before sending the command. If optional
4867 arg NEVEROPEN is non-nil, never try to open the connection. This
4868 is meant to be used from `tramp-maybe-open-connection' only. The
4869 function waits for output unless NOOUTPUT is set."
4873 ;; We mark the command string that it can be erased in the output buffer.
4875 ;; If we put `tramp-echo-mark' after a trailing newline (which
4876 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4877 ;; that newline and adds `tramp-rsh-end-of-line' right after
4878 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4879 ;; trailing line endings and sends two prompts after executing
4880 ;; the command, which confuses `tramp-wait-for-output'.
4884 ;; No need to restore a trailing newline here since `tramp-send-string'
4885 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4887 ;; Send the command.
4893 "Wait for output from remote command."
4899 ;; be leading escape sequences, which must be ignored.
4900 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4901 ;; option send also escape sequences, which must be
4902 ;; ignored.
4905 tramp-device-escape-sequence-regexp))
4906 ;; Sometimes, the commands do not return a newline but a
4907 ;; null byte before the shell prompt, for example "git
4908 ;; ls-files -c -z ...".
4913 ;; A simple-minded busybox has sent " ^H" sequences.
4914 ;; Delete them.
4919 ;; Delete the prompt.
4925 proc 'file-error
4926 "[[Remote prompt `%s' not found in %d secs]]"
4927 tramp-end-of-output timeout)
4929 proc 'file-error
4931 ;; Return value is whether end-of-output sentinel was found.
4932 found)))
4936 "Run COMMAND and check its exit status.
4937 Sends `echo $?' along with the COMMAND for checking the exit status.
4938 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4939 status is 0, and nil otherwise.
4941 If the optional argument SUBSHELL is non-nil, the command is
4942 executed in a subshell, ie surrounded by parentheses. If
4943 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4945 vec
4947 command
4949 "echo tramp_exit_status $?"
4963 "Run COMMAND, check exit status, throw error if exit status not okay.
4964 Similar to `tramp-send-command-and-check' but accepts two more arguments
4965 FMT and ARGS which are passed to `error'."
4970 "Run COMMAND and return the output, which must be a Lisp expression.
4971 If MARKER is a regexp, read the output after that string.
4972 In case there is no valid Lisp expression and NOERROR is nil, it
4973 raises an error."
4980 ;; Read the marker.
4986 vec 'file-error
4987 "`%s' does not return the marker `%s': `%s'"
4989 ;; Read the expression.
4992 ;; Error handling.
4997 vec 'file-error
4998 "`%s' does not return a valid Lisp expression: `%s'"
5002 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5003 Convert file mode bits to string and set virtual device number.
5004 Return ATTR."
5006 ;; Remove color escape sequences from symlink.
5010 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5011 ;; indication of unusable value.
5022 ;; Convert last access time.
5027 ;; Convert last modification time.
5032 ;; Convert last status change time.
5037 ;; Convert file size.
5043 ;; Convert file mode bits to string.
5048 ;; Convert directory indication bit.
5051 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5057 ;; Set file's gid change bit.
5065 ;; Convert inode.
5071 ;; Inodes can be incredible huge. We must hide this.
5073 ;; Set virtual device number.
5076 attr))
5079 "Converts STRING to shell glob pattern which ignores case."
5085 string
5089 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5101 localname)
5107 "Return t if this is an out-of-band method, nil otherwise."
5109 ;; It shall be an out-of-band method.
5111 ;; There must be a size, otherwise the file doesn't exist.
5113 ;; Either the file size is large enough, or (in rare cases) there
5114 ;; does not exist a remote encoding.
5119 ;; Variables local to connection.
5122 "Compile list of remote directories for $PATH.
5123 Nonexistent directories are removed from spec."
5125 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5126 ;; cache the result for the session only. Otherwise, the result
5127 ;; is cached persistently.
5130 vec)
5131 "remote-path"
5140 ;; Default if "getconf" is not available.
5143 vec 3
5148 ;; The login shell could return more than just the $PATH
5149 ;; string. So we use `tramp-end-of-heredoc' as marker.
5153 vec
5158 'identity
5162 'identity
5170 nil)))))
5172 ;; Replace place holder `tramp-default-remote-path'.
5180 ;; Replace place holder `tramp-own-remote-path'.
5188 ;; Remove double entries.
5195 ;; Remove non-existing directories.
5197 nil
5207 x))
5208 x))
5209 remote-path)))))
5212 "Determine remote locale, supporting UTF8 if possible."
5216 locale)
5223 candidates nil)
5225 ;; Return value.
5229 "Determine remote `ls' command."
5236 result)
5238 ;; Check parameters. On busybox, "ls" output coloring is
5239 ;; enabled by default sometimes. So we try to disable it
5240 ;; when possible. $LS_COLORING is not supported there.
5241 ;; Some "ls" versions are sensible wrt the order of
5242 ;; arguments, they fail when "-al" is after the
5243 ;; "--color=never" argument (for example on FreeBSD).
5255 "Check, whether the remote `ls' command supports the --dired option."
5259 ;; Some "ls" versions are sensible wrt the order of arguments,
5260 ;; they fail when "-al" is after the "--dired" argument (for
5261 ;; example on FreeBSD).
5266 "Check, whether the remote `ls' command supports the --quoting-style option."
5275 "Check, whether the remote `ls' command supports the -w option."
5279 ;; Option "-w" is available on BSD systems. No argument is
5280 ;; given, because this could return wrong results in case "ls"
5281 ;; supports the "-w NUM" argument, as for busyboxes.
5286 "Determine remote `test' command."
5290 "test"
5294 "Check, whether the remote `test' command supports the -nt option."
5295 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5296 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5297 ;; for otherwise the shell crashes.
5309 vec
5316 "Determine remote command for file existing check."
5322 "Determine remote `ln' command."
5328 "Determine remote `perl' command."
5334 ;; Perform a basic check.
5339 ;; We must check also for some Perl modules.
5347 result)))
5350 "Determine remote `stat' command."
5355 tmp)
5356 ;; Check whether stat(1) returns usable syntax. "%s" does not
5357 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5358 ;; use shell quoted format for "%N", we check the boundaries "`"
5359 ;; and "'", therefore. See Bug#23422 in coreutils.
5360 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5361 ;; supported.
5370 result)))
5373 "Determine remote `readlink' command."
5381 result))))
5384 "Determine remote `trash' command."
5390 "Determine remote `touch' command."
5399 ;; Busyboxes do support the "-t" option only when they have been
5400 ;; built with the DESKTOP config option. Let's check it.
5403 vec "touch-t"
5405 vec
5407 "%s -t %s %s"
5408 result
5412 result)))
5415 "Determine remote `gvfs-monitor-dir' command."
5418 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5419 ;; establish better timeouts in filenotify-tests.el. Any better
5420 ;; distinction approach would be welcome!
5427 "Determine remote `inotifywait' command."
5433 "Determine remote `id' command."
5439 result)
5441 ;; Check POSIX parameter.
5447 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5449 vec
5457 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5459 vec
5463 "print $>"
5467 "Determine remote `python' command."
5475 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5477 vec
5481 "import os; print (os.getuid())"
5485 "The uid of the remote connection VEC, in ID-FORMAT.
5486 ID-FORMAT valid values are `string' and `integer'."
5497 ;; Ensure there is a valid result.
5500 tramp-unknown-id-integer)
5502 tramp-unknown-id-string)
5506 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5508 vec
5516 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5518 vec
5526 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5528 vec
5532 "import os; print (os.getgid())"
5536 "The gid of the remote connection VEC, in ID-FORMAT.
5537 ID-FORMAT valid values are `string' and `integer'."
5548 ;; Ensure there is a valid result.
5551 tramp-unknown-id-integer)
5553 tramp-unknown-id-string)
5557 "Check, whether the remote `env' command supports the -u option."
5560 ;; Option "-u" is a GNU extension.
5564 ;; Some predefined connection properties.
5566 "Return the compress command related to PROP.
5567 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5568 the length of the file to be compressed.
5570 If no corresponding command is found, nil is returned."
5579 "Return the coding command related to PROP.
5580 PROP is either `remote-encoding', `remote-decoding',
5581 `local-encoding' or `local-decoding'.
5583 SIZE is the length of the file to be coded. Depending on SIZE,
5584 compression might be applied.
5586 If no corresponding command is found, nil is returned.
5587 Otherwise, either a string is returned which contains a `%s' mark
5588 to be used for the respective input or output file; or a Lisp
5589 function cell is returned to be applied on a buffer."
5590 ;; We must catch the errors, because we want to return nil, when
5591 ;; no inline coding is found.
5601 compress)
5602 ;; The connection property might have been cached. So we must
5603 ;; send the script to the remote side - maybe.
5611 ;; Check for the `compress' command.
5613 ;; Return the value.
5634 coding)
5637 ;; Windows shells need the program file name after
5638 ;; the pipe symbol be quoted if they use forward
5639 ;; slashes as directory separators.
5646 coding compress))
5649 ;; Windows shells need the program file name after
5650 ;; the pipe symbol be quoted if they use forward
5651 ;; slashes as directory separators.
5656 compress coding))
5670 ;;; TODO:
5672 ;; * Don't use globbing for directories with many files, as this is
5673 ;; likely to produce long command lines, and some shells choke on
5674 ;; long command lines.
5675 ;;
5676 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5677 ;; then look if it's the right version (with `perl -v').
5678 ;;
5679 ;; * When editing a remote CVS controlled file as a different user, VC
5680 ;; gets confused about the file locking status. Try to find out why
5681 ;; the workaround doesn't work.
5682 ;;
5683 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5684 ;; until the last but one hop via `start-file-process'. Apply it
5685 ;; also for ftp and smb.
5686 ;;
5687 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5688 ;; some shell with root privileges, it would be nice if I could
5689 ;; just call
5690 ;; trampclient filename.c
5691 ;; as an editor, and the _current_ shell would connect to an Emacs
5692 ;; server and would be used in an existing non-privileged Emacs
5693 ;; session for doing the editing in question.
5694 ;; That way, I need not tell Emacs my password again and be afraid
5695 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5696 ;; once display a just typed password in the context of a keyboard
5697 ;; sequence prompt for a question immediately following in a shell
5698 ;; script run within Emacs -- nasty).
5699 ;; And if I have some ssh session running to a different computer,
5700 ;; having the possibility of passing a local file there to a local
5701 ;; Emacs session (in case I can arrange for a connection back) would
5702 ;; be nice.
5703 ;; Likely the corresponding Tramp server should not allow the
5704 ;; equivalent of the emacsclient -eval option in order to make this
5705 ;; reasonably unproblematic. And maybe trampclient should have some
5706 ;; way of passing credentials, like by using an SSL socket or
5707 ;; something. (David Kastrup)
5708 ;;
5709 ;; * Reconnect directly to a compliant shell without first going
5710 ;; through the user's default shell. (Pete Forman)
5711 ;;
5712 ;; * How can I interrupt the remote process with a signal
5713 ;; (interrupt-process seems not to work)? (Markus Triska)
5714 ;;
5715 ;; * Avoid the local shell entirely for starting remote processes. If
5716 ;; so, I think even a signal, when delivered directly to the local
5717 ;; SSH instance, would correctly be propagated to the remote process
5718 ;; automatically; possibly SSH would have to be started with
5719 ;; "-t". (Markus Triska)
5720 ;;
5721 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5722 ;; isn't on the remote host. (Mark A. Hershberger)
5723 ;;
5724 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5725 ;;
5726 ;; * Optimize out-of-band copying when both methods are scp-like (not
5727 ;; rsync).
5728 ;;
5729 ;; * Keep a second connection open for out-of-band methods like scp or
5730 ;; rsync.
5731 ;;
5732 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5733 ;;
5734 ;; * I think you could get the best of both worlds by using an
5735 ;; approach similar to Tramp but running a little tramp-daemon on
5736 ;; the other end, such that we can use a more efficient
5737 ;; communication protocol (e.g. when saving a file we could locally
5738 ;; diff it against the last version (of which the remote daemon
5739 ;; would also keep a copy), and then only send the diff).
5740 ;;
5741 ;; This said, even using such a daemon it might be difficult to get
5742 ;; good performance: part of the problem is the number of
5743 ;; round-trips. E.g. when saving a file we have to check if the
5744 ;; file was modified in the mean time and whether saving into a new
5745 ;; inode would change the owner (etc...), which each require a
5746 ;; round-trip. To get rid of these round-trips, we'd have to
5747 ;; shortcut this code and delegate the higher-level "save file"
5748 ;; operation to the remote server, which then has to perform those
5749 ;; tasks but still obeying the locally set customizations about how
5750 ;; to do each one of those tasks.
5751 ;;
5752 ;; We could either put higher-level ops in there (like
5753 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5754 ;; behavior, which is a lot of work and likely to be not 100%
5755 ;; faithful.
5756 ;;
5757 ;; Or we could introduce new low-level ops that are asynchronous,
5758 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5759 ;; start with a bunch of calls like `start-getting-file-attributes'
5760 ;; which could immediately be passed on to the remote side, and
5761 ;; later on checks the return value of those calls as and when
5762 ;; needed. (Stefan Monnier)
5764 ;;; tramp-sh.el ends here