| blob | 50b380100ba0b84af6a83e08e738b91bd4d39385 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections -*- lexical-binding:t -*-
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 ;; 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 <http://www.gnu.org/licenses/>.
28 ;;; Code:
32 ;; Pacify byte-compiler.
43 ;;;###tramp-autoload
45 "The minimum size of compressing where inline transfer.
46 When inline transfer, compress transferred data of file
47 whose size is this value or above (up to `tramp-copy-size-limit').
48 If it is nil, no compression at all will be applied."
53 ;;;###tramp-autoload
55 "The maximum file size where inline copying is preferred over an \
56 out-of-the-band copy.
57 If it is nil, out-of-the-band copy will be used without a check."
62 ;;;###tramp-autoload
64 "Value of TERM environment variable for logging in to remote host.
65 Because Tramp wants to parse the output of the remote shell, it is easily
66 confused by ANSI color escape sequences and suchlike. Often, shell init
67 files conditionalize this setup based on the TERM environment variable."
72 ;;;###tramp-autoload
74 "When invoking a shell, override the HISTFILE with this value.
75 When setting to a string, it redirects the shell history to that
79 The value t unsets any setting of HISTFILE, and sets both
80 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
81 however, the *override* is disabled, so the history will go to
90 ;;;###tramp-autoload
94 ;;;###tramp-autoload
98 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
99 ;; root users. It uses the `$' character for other users. In order
100 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
104 "///%s#$"
106 "String used to recognize end of output.
107 The `$' character at the end is quoted; the string cannot be
110 ;;;###tramp-autoload
117 ;;;###tramp-autoload
119 "Whether to use `tramp-ssh-controlmaster-options'."
126 "Which ssh Control* arguments to use.
128 If it is a string, it should have the form
131 spec must be doubled, because the string is used as format string.
133 Otherwise, it will be auto-detected by Tramp, if
134 `tramp-use-ssh-controlmaster-options' is non-nil. The value
135 depends on the installed local ssh version.
139 ;; Initialize `tramp-methods' with the supported methods.
140 ;;;###tramp-autoload
152 ;;;###tramp-autoload
163 ;;;###tramp-autoload
177 ;;;###tramp-autoload
192 ;;;###tramp-autoload
208 ;;;###tramp-autoload
216 ;;;###tramp-autoload
224 ;;;###tramp-autoload
234 ;;;###tramp-autoload
244 ;;;###tramp-autoload
252 ;;;###tramp-autoload
261 ;; We use "-v" for better error tracking.
264 ;; We use "-p" as required for newer busyboxes. For older
265 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
266 ;; can be achieved by tweaking `tramp-connection-properties'.
268 ;;;###tramp-autoload
277 ;;;###tramp-autoload
279 'tramp-methods
286 ;;;###tramp-autoload
290 ;; The password template must be masked. Otherwise, it could be
291 ;; interpreted as password prompt if the remote host echoes the command.
294 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
300 ;;;###tramp-autoload
308 ;;;###tramp-autoload
317 ;;;###tramp-autoload
325 ;;;###tramp-autoload
329 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
333 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
334 tramp-terminal-type
335 tramp-initial-end-of-output))
340 ;;;###tramp-autoload
346 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
347 tramp-terminal-type
348 tramp-initial-end-of-output))
353 ;;;###tramp-autoload
360 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
361 tramp-terminal-type
362 tramp-initial-end-of-output))
372 ;;;###tramp-autoload
379 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
380 tramp-terminal-type
381 tramp-initial-end-of-output))
390 ;;;###tramp-autoload
402 ;;;###tramp-autoload
406 ;;;###tramp-autoload
410 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
411 ;; Do not add "plink" based methods, they ask interactively for the user.
412 ;;;###tramp-autoload
421 ;;;###tramp-autoload
427 ;;;###tramp-autoload
443 ;;;###tramp-autoload
448 ;;;###tramp-autoload
453 ;;;###tramp-autoload
458 ;;;###tramp-autoload
466 ;;;###tramp-autoload
495 ;; "getconf PATH" yields:
496 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
497 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
498 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
499 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
500 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
501 ;; IRIX64: /usr/bin
502 ;; QNAP QTS: ---
503 ;;;###tramp-autoload
509 "List of directories to search for executables on remote host.
510 For every remote host, this variable will be set buffer local,
511 keeping the list of existing directories on that host.
513 You can use `~' in this list, but when searching for a shell which groks
514 tilde expansion, all directory names starting with `~' will be ignored.
516 `Default Directories' represent the list of directories given by
518 entry on head of this list, because these are the default
519 directories for POSIX compatible commands. On remote hosts which
520 do not offer the getconf command (like cygwin), the value
522 the list by the special value `tramp-default-remote-path'.
524 `Private Directories' are the settings of the $PATH environment,
525 as given in your `~/.profile'. This entry is represented in
526 the list by the special value `tramp-own-remote-path'."
534 ;;;###tramp-autoload
541 "List of environment variables to be set on the remote host.
543 Each element should be a string of the form ENVVARNAME=VALUE. An
544 entry ENVVARNAME= disables the corresponding environment variable,
545 which might have been set in the init files like ~/.profile.
547 Special handling is applied to the PATH environment, which should
548 not be set here. Instead, it should be set via `tramp-remote-path'."
554 ;;;###tramp-autoload
556 "Alist specifying extra arguments to pass to the remote shell.
557 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
558 matching the shell file name and ARGS is a string specifying the
559 arguments.
561 This variable is only used when Tramp needs to start up another shell
562 for tilde expansion. The extra arguments should typically prevent the
563 shell from reading its init file."
565 ;; This might be the wrong way to test whether the widget type
566 ;; `alist' is available. Who knows the right way to test it?
582 "List of pattern/action pairs.
583 Whenever a pattern matches, the corresponding action is performed.
584 Each item looks like (PATTERN ACTION).
586 The PATTERN should be a symbol, a variable. The value of this
587 variable gives the regular expression to search for. Note that the
589 appended to it.
591 The ACTION should also be a symbol, but a function. When the
599 "List of pattern/action pairs.
600 This list is used for copying/renaming with out-of-band methods.
605 "(echo begin 600 %t; tail -n +2) | uudecode
606 cat %t
607 rm -f %t"
608 "Shell function to implement `uudecode' to standard output.
609 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
610 for this or `uudecode -p', but some systems don't, and for them
614 "%s -e '
615 use File::Spec;
618 sub myrealpath {
619 my ($file) = @_;
620 return realpath($file) if -e $file;
621 }
623 sub recursive {
624 my ($volume, @dirs) = @_;
625 my $real = myrealpath(File::Spec->catpath(
627 if ($real) {
628 my ($vol, $dir) = File::Spec->splitpath($real, 1);
629 return ($vol, File::Spec->splitdir($dir));
630 }
631 else {
632 my $last = pop(@dirs);
633 ($volume, @dirs) = recursive($volume, @dirs);
634 push(@dirs, $last);
635 return ($volume, @dirs);
636 }
637 }
639 $result = myrealpath($ARGV[0]);
640 if (!$result) {
641 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
642 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
645 }
650 "Perl script to produce output suitable for use with `file-truename'
651 on the remote file system.
652 Escape sequence %s is replaced with name of Perl binary.
656 "%s -e '
658 @files = readdir(d); closedir(d);
659 foreach $f (@files) {
662 }
663 else {
665 }
666 }
669 "Perl script to produce output suitable for use with
670 `file-name-all-completions' on the remote file system. Escape
671 sequence %s is replaced with name of Perl binary. This string is
674 ;; Perl script to implement `file-attributes' in a Lisp `read'able
675 ;; output. If you are hacking on this, note that you get *no* output
676 ;; unless this spits out a complete line, including the '\n' at the
677 ;; end.
678 ;; The device number is returned as "-1", because there will be a virtual
679 ;; device number set in `tramp-sh-handle-file-attributes'.
681 "%s -e '
682 @stat = lstat($ARGV[0]);
683 if (!@stat) {
685 exit 0;
686 }
687 if (($stat[2] & 0170000) == 0120000)
688 {
689 $type = readlink($ARGV[0]);
692 }
693 elsif (($stat[2] & 0170000) == 040000)
694 {
696 }
697 else
698 {
700 };
703 printf(
705 $type,
706 $stat[3],
707 $uid,
708 $gid,
709 $stat[8] >> 16 & 0xffff,
710 $stat[8] & 0xffff,
711 $stat[9] >> 16 & 0xffff,
712 $stat[9] & 0xffff,
713 $stat[10] >> 16 & 0xffff,
714 $stat[10] & 0xffff,
715 $stat[7],
716 $stat[2],
717 $stat[1] >> 16 & 0xffff,
718 $stat[1] & 0xffff
720 "Perl script to produce output suitable for use with `file-attributes'
721 on the remote file system.
722 Escape sequence %s is replaced with name of Perl binary.
726 "%s -e '
729 @list = readdir(DIR);
730 closedir(DIR);
731 $n = scalar(@list);
733 for($i = 0; $i < $n; $i++)
734 {
735 $filename = $list[$i];
736 @stat = lstat($filename);
737 if (($stat[2] & 0170000) == 0120000)
738 {
739 $type = readlink($filename);
742 }
743 elsif (($stat[2] & 0170000) == 040000)
744 {
746 }
747 else
748 {
750 };
754 printf(
755 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
756 $filename,
757 $type,
758 $stat[3],
759 $uid,
760 $gid,
761 $stat[8] >> 16 & 0xffff,
762 $stat[8] & 0xffff,
763 $stat[9] >> 16 & 0xffff,
764 $stat[9] & 0xffff,
765 $stat[10] >> 16 & 0xffff,
766 $stat[10] & 0xffff,
767 $stat[7],
768 $stat[2],
769 $stat[1] >> 16 & 0xffff,
770 $stat[1] & 0xffff,
771 $stat[0] >> 16 & 0xffff,
772 $stat[0] & 0xffff);
773 }
775 "Perl script implementing `directory-files-attributes' as Lisp `read'able
776 output.
777 Escape sequence %s is replaced with name of Perl binary.
780 ;; These two use base64 encoding.
782 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
783 "Perl program to use for encoding a file.
784 Escape sequence %s is replaced with name of Perl binary.
785 This string is passed to `format', so percent characters need to be doubled.
786 This implementation requires the MIME::Base64 Perl module to be installed
790 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
791 "Perl program to use for decoding a file.
792 Escape sequence %s is replaced with name of Perl binary.
793 This string is passed to `format', so percent characters need to be doubled.
794 This implementation requires the MIME::Base64 Perl module to be installed
798 "%s -e '
799 # This script contributed by Juanma Barranquero <lektu@terra.es>.
800 # Copyright (C) 2002-2017 Free Software Foundation, Inc.
801 use strict;
803 my %%trans = do {
804 my $i = 0;
805 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
806 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
807 };
808 my $data;
810 # We read in chunks of 54 bytes, to generate output lines
811 # of 72 chars (plus end of line)
812 while (read STDIN, $data, 54) {
813 my $pad = q();
815 # Only for the last chunk, and only if did not fill the last three-byte packet
816 if (eof) {
817 my $mod = length($data) %% 3;
818 $pad = q(=) x (3 - $mod) if $mod;
819 }
821 # Not the fastest method, but it is simple: unpack to binary string, split
822 # by groups of 6 bits and convert back from binary to byte; then map into
823 # the translation table
824 print
825 join q(),
826 map($trans{$_},
827 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
828 $pad,
830 }' 2>/dev/null"
831 "Perl program to use for encoding a file.
832 Escape sequence %s is replaced with name of Perl binary.
836 "%s -e '
837 # This script contributed by Juanma Barranquero <lektu@terra.es>.
838 # Copyright (C) 2002-2017 Free Software Foundation, Inc.
839 use strict;
841 my %%trans = do {
842 my $i = 0;
843 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
844 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
845 };
847 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
851 # We are going to accumulate into $pending to accept any line length
852 # (we do not check they are <= 76 chars as the RFC says)
853 my $pending = q();
855 while (my $data = <STDIN>) {
856 chomp $data;
858 # If we find one or two =, we have reached the end and
859 # any following data is to be discarded
860 my $finished = $data =~ s/(==?).*/$1/;
861 $pending .= $data;
863 my $len = length($pending);
864 my $chunk = substr($pending, 0, $len & ~3);
865 $pending = substr($pending, $len & ~3 + 1);
867 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
868 # split in 8-bit chunks and convert back to char.
869 print join q(),
870 map $bytes{$_},
871 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
873 last if $finished;
874 }' 2>/dev/null"
875 "Perl program to use for decoding a file.
876 Escape sequence %s is replaced with name of Perl binary.
880 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
881 "Perl program to use for encoding a file.
885 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
886 "Perl program to use for decoding a file.
891 BEGIN {
894 }
895 {
896 for (c=1; c<=length($0); c++) {
897 d=index(b16, substr($0,c,1))
898 if (d--) {
899 for (b=1; b<=4; b++) {
900 o=o*2+int(d/8); d=(d*2)%%16
901 if (++obc==6) {
902 printf substr(b64,o+1,1)
904 obc=0; o=0
905 }
906 }
907 }
908 }
909 }
910 END {
911 if (obc) {
913 while (obc++<6) { o=o*2 }
915 } else {
917 }
918 printf tail
919 }'"
920 "Awk program to use for encoding a file.
925 BEGIN {
927 }
928 {
929 for (i=1; i<=length($0); i++) {
930 c=index(b64, substr($0,i,1))
931 if(c--) {
932 for(b=0; b<6; b++) {
933 o=o*2+int(c/32); c=(c*2)%%64
934 if(++obc==8) {
935 if (o) {
937 } else {
939 }
940 obc=0; o=0
941 }
942 }
943 }
944 }
945 }'"
946 "Awk program to use for decoding a file.
950 "test -c /dev/zero && \
951 od -v -t x1 -A n </dev/null && \
952 busybox awk '{}' </dev/null"
963 while read file; do
966 else
968 fi
971 else
973 fi
974 done
976 "Script to check existence of VC related files.
977 It must be send formatted with two strings; the tests for file
978 existence, and file readability. Input shall be read via
979 here-document, otherwise the command could exceed maximum length
982 ;; New handlers should be added here.
983 ;;;###tramp-autoload
987 ;; `byte-compiler-base-file-name' performed by default handler.
992 ;; `diff-latest-backup-file' performed by default handler.
996 . tramp-sh-handle-directory-files-and-attributes)
1016 ;; `file-name-sans-versions' performed by default handler.
1030 ;; `find-file-noselect' performed by default handler.
1031 ;; `get-file-buffer' performed by default handler.
1054 "Alist of handler functions.
1057 ;;; File Name Handler Functions:
1061 "Like `make-symbolic-link' for Tramp files.
1062 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1063 the symlink. If LINKNAME is a Tramp file, only the localname component is
1064 used as the target of the symlink.
1066 If LINKNAME is a Tramp file and the localname component is relative, then
1067 it is expanded first, before the localname component is taken. Note that
1068 this can give surprising results if the user/host for the source and
1069 target of the symlink differ."
1076 l 'file-error
1079 ;; Do the 'confirm if exists' thing.
1081 ;; What to do?
1086 "File %s already exists; make it a link anyway? "
1087 l-localname)))))
1091 ;; If FILENAME is a Tramp name, use just the localname component.
1100 ;; Right, they are on the same host, regardless of user, method,
1101 ;; etc. We now make the link on the remote machine. This will
1102 ;; occur as the user that FILENAME belongs to.
1107 "%s -sf %s %s"
1108 ln
1110 ;; The command could exceed PATH_MAX, so we use
1111 ;; relative file names. However, relative file names
1112 ;; could start with "-". `tramp-shell-quote-argument'
1113 ;; does not handle this, we must do it ourselves.
1118 "Like `file-truename' for Tramp files."
1120 "%s%s"
1123 method user domain host port
1130 ;; Use GNU readlink --canonicalize-missing where available.
1133 v
1141 ;; Use Perl implementation.
1149 v
1153 ;; Do it yourself.
1157 ;; Don't make the following value larger than
1158 ;; necessary. People expect an error message in a
1159 ;; timely fashion when something is wrong;
1160 ;; otherwise they might think that Emacs is hung.
1161 ;; Of course, correctness has to come first.
1163 symlink-target)
1175 method user domain host port
1187 ;; It's a symlink, follow it.
1193 ;; If the symlink was absolute, we'll get a
1194 ;; string like "/user@host:/some/target";
1195 ;; extract the "/some/target" part from it.
1199 v 'file-error
1200 "Symlink target `%s' on wrong host"
1201 symlink-target))
1207 ;; It's a file.
1211 v 'file-error
1214 ;; Combine list to form string.
1224 result))))
1226 ;; Preserve trailing "/".
1229 ;; Basic functions.
1232 "Like `file-exists-p' for Tramp files."
1240 v
1242 "%s %s"
1247 "Like `file-attributes' for Tramp files."
1250 ;; Don't modify `last-coding-system-used' by accident.
1257 v
1265 ;; The scripts could fail, for example with huge file size.
1269 "Implement `file-attributes' for Tramp files using the ls(1) command."
1271 res-inode res-filemodes res-numlinks
1272 res-uid res-gid res-size res-symlink-target)
1274 ;; We cannot send all three commands combined, it could exceed
1275 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1277 vec
1282 vec
1287 vec
1291 ;; On systems which have no quoting style, file names
1292 ;; with special characters could fail.
1300 ;; Parse `ls -l' output ...
1304 ;; ... inode
1306 ;; ... file mode flags
1308 ;; ... number links
1310 ;; ... uid and gid
1322 ;; ... size
1324 ;; From the file modes, figure out other stuff.
1327 ;; If symlink, find out file name pointed to.
1334 ;; Return data gathered.
1336 ;; 0. t for directory, string (name linked to) for symbolic
1337 ;; link, or nil.
1339 ;; 1. Number of links to file.
1340 res-numlinks
1341 ;; 2. File uid.
1342 res-uid
1343 ;; 3. File gid.
1344 res-gid
1345 ;; 4. Last access time, as a list of integers. Normally
1346 ;; this would be in the same format as `current-time', but
1347 ;; the subseconds part is not currently implemented, and
1348 ;; (0 0) denotes an unknown time.
1349 ;; 5. Last modification time, likewise.
1350 ;; 6. Last status change time, likewise.
1352 ;; 7. Size in bytes (-1, if number is out of range).
1353 res-size
1354 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1355 res-filemodes
1356 ;; 9. t if file's gid would change if file were deleted and
1357 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1358 t
1359 ;; 10. Inode number.
1360 res-inode
1361 ;; 11. Device number. Will be replaced by a virtual device number.
1366 "Implement `file-attributes' for Tramp files using a Perl script."
1371 vec
1377 "Implement `file-attributes' for Tramp files using stat(1) command."
1380 vec
1383 ;; On Opsware, pdksh (which is the true name of ksh there)
1384 ;; doesn't parse correctly the sequence "((". Therefore, we add
1385 ;; a space. Apostrophes in the stat output are masked as
1386 ;; `tramp-stat-marker', in order to make a proper shell escape of
1387 ;; them in file names.
1388 "( (%s %s || %s -h %s) && (%s -c "
1389 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1396 tramp-stat-marker tramp-stat-marker
1401 tramp-stat-marker tramp-stat-marker
1403 tramp-stat-quoted-marker)))
1406 "Like `set-visited-file-modtime' for Tramp files."
1413 coding-system-used)
1417 ;; '(-1 65535) means file doesn't exists yet.
1421 ;; We use '(0 0) as a don't-know value. See also
1422 ;; `tramp-do-file-attributes-with-ls'.
1427 v
1435 nil)))))
1437 ;; This function makes the same assumption as
1438 ;; `tramp-sh-handle-set-visited-file-modtime'.
1440 "Like `verify-visited-file-modtime' for Tramp files.
1441 At the time `verify-visited-file-modtime' calls this function, we
1442 already know that the buffer is visiting a file and that
1443 `visited-file-modtime' does not return 0. Do not call this
1444 function directly, unless those two cases are already taken care
1445 of."
1448 ;; There is no file visiting the buffer, or the buffer has no
1449 ;; recorded last modification time, or there is no established
1450 ;; connection.
1454 t
1462 ;; File exists, and has a known modtime.
1465 modtime
1466 ;; For compatibility, deal with both the old
1467 ;; (HIGH . LOW) and the new (HIGH LOW) return
1468 ;; values of `visited-file-modtime'.
1471 mt)))
1473 ;; Modtime has the don't know value.
1476 v
1483 attr
1486 ;; If file does not exist, say it is not modified if and
1487 ;; only if that agrees with the buffer's record.
1491 "Like `set-file-modes' for Tramp files."
1495 ;; FIXME: extract the proper text from chmod's stderr.
1497 v
1502 "Like `set-file-times' for Tramp files."
1509 time)))
1512 "env TZ=UTC %s %s %s"
1520 "Set the ownership for FILENAME.
1521 If UID and GID are provided, these values are used; otherwise uid
1522 and gid of the corresponding user is taken. Both parameters must
1523 be non-negative integers."
1524 ;; Modern Unices allow chown only for root. So we might need
1525 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1526 ;; working with su(do)? when it is needed, so it shall succeed in
1527 ;; the majority of cases.
1528 ;; Don't modify `last-coding-system-used' by accident.
1533 ;; If we are root on the local host, we can do it directly.
1541 "chown %d:%d %s" uid gid
1544 ;; We handle also the local part, because there doesn't exist
1545 ;; `set-file-uid-gid'. On W32 "chown" does not work.
1550 nil "chown" nil nil nil
1554 "Check, whether SELINUX is enabled on the remote host."
1559 "Like `file-selinux-context' for Tramp files."
1568 "%s -d -Z %s"
1576 ;; Return the context.
1577 context))))
1580 "Like `set-file-selinux-context' for Tramp files."
1600 t)))))
1603 "Check, whether ACL is enabled on the remote host."
1608 "Like `file-acl' for Tramp files."
1614 "getfacl -ac %s"
1623 "Like `set-file-acl' for Tramp files."
1630 tramp-end-of-heredoc
1631 acl-string
1632 tramp-end-of-heredoc))
1634 ;; Success.
1637 t)
1638 ;; In case of errors, we return nil.
1640 nil)))
1642 ;; Simple functions using the `test' command.
1645 "Like `file-executable-p' for Tramp files."
1648 ;; Examine `file-attributes' cache to see if request can be
1649 ;; satisfied without remote operation.
1654 "Like `file-readable-p' for Tramp files."
1657 ;; Examine `file-attributes' cache to see if request can be
1658 ;; satisfied without remote operation.
1662 ;; When the remote shell is started, it looks for a shell which groks
1663 ;; tilde expansion. Here, we assume that all shells which grok tilde
1664 ;; expansion will also provide a `test' command which groks `-nt' (for
1665 ;; newer than). If this breaks, tell me about it and I'll try to do
1666 ;; something smarter about it.
1668 "Like `file-newer-than-file-p' for Tramp files."
1670 nil)
1672 t)
1673 ;; We are sure both files exist at this point.
1676 ;; We try to get the mtime of both files. If they are not
1677 ;; equal to the "dont-know" value, then we subtract the times
1678 ;; and obtain the result.
1691 ;; If one of them is the dont-know value, then we can
1692 ;; still try to run a shell command on the remote host.
1693 ;; However, this only works if both files are Tramp
1694 ;; files and both have the same method, same user, same
1695 ;; host.
1700 v 'file-error
1701 "Files %s and %s must have same method, user, host"
1702 file1 file2)))
1707 ;; Functions implemented using the basic functions above.
1710 "Like `file-directory-p' for Tramp files."
1712 ;; `file-directory-p' is used as predicate for file name completion.
1713 ;; Sometimes, when a connection is not established yet, it is
1714 ;; desirable to return t immediately for "/method:foo:". It can
1715 ;; be expected that this is always a directory.
1721 "Like `file-writable-p' for Tramp files."
1725 ;; Examine `file-attributes' cache to see if request can be
1726 ;; satisfied without remote operation.
1729 ;; If file doesn't exist, check if directory is writable.
1734 "Like `file-ownership-preserved-p' for Tramp files."
1738 ;; Return t if the file doesn't exist, since it's true that no
1739 ;; information would be lost by an (attempted) delete and create.
1748 ;; Directory listings.
1752 "Like `directory-files-and-attributes' for Tramp files."
1760 v localname
1771 v localname id-format))
1774 v localname id-format))
1776 result item)
1786 result
1788 ;; The scripts could fail, for example with huge file size.
1790 directory full match nosort id-format)))))
1794 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1797 vec tramp-perl-directory-files-and-attributes
1801 vec
1805 object))
1809 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1812 vec
1815 ;; We must care about file names with spaces, or starting with
1816 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1817 ;; but it does not work on all remote systems. Apostrophes in
1818 ;; the stat output are masked as `tramp-stat-marker', in order to
1819 ;; make a proper shell escape of them in file names.
1821 "xargs %s -c "
1822 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1826 ;; On systems which have no quoting style, file names with special
1827 ;; characters could fail.
1835 tramp-stat-marker tramp-stat-marker
1836 tramp-stat-marker tramp-stat-marker
1841 tramp-stat-marker tramp-stat-marker
1842 tramp-stat-quoted-marker)))
1844 ;; This function should return "foo/" for directories and "bar" for
1845 ;; files.
1847 "Like `file-name-all-completions' for Tramp files."
1850 filename
1854 ;; Get a list of directories and files, including reliably
1855 ;; tagging the directories with a trailing "/". Because I
1856 ;; rock. --daniel@danann.net
1858 v
1862 v tramp-perl-file-name-all-completions
1868 "(cd %s 2>&1 && %s -a 2>/dev/null"
1869 " | while IFS= read f; do"
1877 ;; Now grab the output.
1881 ;; Check result code, found in last line of output.
1885 ;; Grab error message from line before last line
1886 ;; (it was put there by `cd 2>&1').
1889 v 'file-error
1890 "tramp-sh-handle-file-name-all-completions: %s"
1892 ;; For peace of mind, if buffer doesn't end in `fail'
1893 ;; then it should end in `ok'. If neither are in the
1894 ;; buffer something went seriously wrong on the remote
1895 ;; side.
1899 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1904 result))))))
1906 ;; cp, mv and ln
1910 "Like `add-name-to-file' for Tramp files."
1915 v 'file-error
1916 "add-name-to-file: %s"
1925 "File %s already exists; make it a new name anyway? "
1926 newname)))
1932 v1
1936 "error with add-name-to-file, see buffer `%s' for details"
1941 preserve-uid-gid preserve-extended-attributes)
1942 "Like `copy-file' for Tramp files."
1948 'copy filename newname ok-if-already-exists keep-date
1949 preserve-uid-gid preserve-extended-attributes)
1951 'copy-file
1953 preserve-uid-gid preserve-extended-attributes))))
1957 "Like `copy-directory' for Tramp files."
1963 ;; When DIRNAME and NEWNAME are remote, they must have
1964 ;; the same method.
1970 ;; scp or rsync DTRT.
1984 ;; We must do it file-wise.
1986 'copy-directory
1991 ;; When newname did exist, we have wrong cached values.
1999 "Like `rename-file' for Tramp files."
2000 ;; Check if both files are local -- invoke normal rename-file.
2001 ;; Otherwise, use Tramp from local system.
2004 ;; At least one file a Tramp file?
2008 'rename filename newname ok-if-already-exists
2015 preserve-uid-gid preserve-extended-attributes)
2016 "Copy or rename a remote file.
2017 OP must be `copy' or `rename' and indicates the operation to perform.
2018 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2019 the new file (for copy) or the new name of the file (for rename).
2020 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2021 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2022 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2023 the uid and gid if both files are on the same host.
2024 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2026 This function is invoked by `tramp-sh-handle-copy-file' and
2027 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2028 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2029 file names."
2046 filename newname)
2049 ;; Both are Tramp files.
2054 ;; Shortcut: if method, host, user are the same for
2055 ;; both files, we invoke `cp' or `mv' on the remote
2056 ;; host directly.
2059 op filename newname
2060 ok-if-already-exists keep-date preserve-uid-gid))
2062 ;; Try out-of-band operation.
2067 op filename newname keep-date))
2069 ;; No shortcut was possible. So we copy the file
2070 ;; first. If the operation was `rename', we go back
2071 ;; and delete the original file (if the copy was
2072 ;; successful). The approach is simple-minded: we
2073 ;; create a new buffer, insert the contents of the
2074 ;; source file into it, then write out the buffer to
2075 ;; the target file. The advantage is that it doesn't
2076 ;; matter which file name handlers are used for the
2077 ;; source and target file.
2080 op filename newname keep-date))))))
2082 ;; One file is a Tramp file, the other one is local.
2085 ;; Fast track on local machine.
2088 op filename newname
2089 ok-if-already-exists keep-date preserve-uid-gid))
2091 ;; If the Tramp file has an out-of-band method, the
2092 ;; corresponding copy-program can be invoked.
2095 op filename newname keep-date))
2097 ;; Use the inline method via a Tramp buffer.
2099 op filename newname keep-date))))
2102 ;; One of them must be a Tramp file.
2105 ;; Handle `preserve-extended-attributes'. We ignore possible
2106 ;; errors, because ACL strings could be incompatible.
2111 ;; In case of `rename', we must flush the cache of the source file.
2117 ;; When newname did exist, we have wrong cached values.
2124 "Use an Emacs buffer to copy or rename a file.
2125 First arg OP is either `copy' or `rename' and indicates the operation.
2126 FILENAME is the source file, NEWNAME the target file.
2127 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2128 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2129 ;; and `find-file-noselect', but that's not called here.
2133 ;; We must disable multibyte, because binary data shall not be
2134 ;; converted. We don't want the target file to be compressed, so we
2135 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2136 ;; be called either. We remove `tramp-file-name-handler' from
2137 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2138 ;; `insert-file-contents' might be deactivated in some corner cases.
2149 ;; KEEP-DATE handling.
2152 newname
2155 ;; Set the mode.
2157 ;; If the operation was `rename', delete the original file.
2162 "Invokes `cp' or `mv' on the remote system.
2163 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2164 respectively. FILENAME specifies the file to copy or rename,
2165 NEWNAME is the name of the new file (for copy) or the new name of
2166 the file (for rename). Both files must reside on the same host.
2167 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2168 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2169 the uid and gid from FILENAME."
2180 v 'file-error
2181 "Unknown operation `%s', must be `copy' or `rename'"
2182 op))))
2186 cmd-result)
2189 ;; Both files are on a remote host, with same user.
2201 ;; Mask cp -f error.
2203 tramp-operation-not-permitted-regexp nil t))
2204 cmd-result)
2206 nil v 'file-error
2207 "Copying directly failed, see buffer `%s' for details."
2210 ;; We are on the local host.
2213 ;; We can do it directly.
2216 ;; No sticky bit when renaming.
2227 localname1 localname2 ok-if-already-exists
2228 keep-date preserve-uid-gid)
2232 ;; We can do it directly with `tramp-send-command'
2240 ok-if-already-exists keep-date t)
2241 ;; We must change the ownership to the local user.
2247 ;; We need a temporary file in between.
2249 ;; Create the temporary file.
2257 "%s %s %s" cmd
2260 "Copying directly failed, see buffer `%s' for details."
2262 ;; We must change the ownership as remote user.
2263 ;; Since this does not work reliable, we also
2264 ;; give read permissions.
2274 localname1 tmpfile t keep-date preserve-uid-gid)
2277 ;; We must change the ownership as local user.
2278 ;; Since this does not work reliable, we also
2279 ;; give read permissions.
2282 tmpfile
2286 ;; Move the temporary file to its destination.
2291 "cp -f -p %s %s"
2294 "Copying directly failed, see buffer `%s' for details."
2298 'rename-file
2301 ;; Save exit.
2304 ;; Set the time and mode. Mask possible errors.
2311 "Invoke `scp' program to copy.
2312 The method used must be an out-of-band method."
2316 copy-program copy-args copy-env copy-keep-date listener spec
2317 options source target remote-copy-program remote-copy-args)
2322 ;; Both are Tramp files. We shall optimize it when the
2323 ;; methods for FILENAME and NEWNAME are the same.
2333 op filename tmpfile keep-date)
2336 ;; Save exit.
2343 ;; Set variables for computing the prompt for reading password.
2352 ;; Check which ones of source and target are Tramp files.
2356 'file-name-as-directory
2365 ;; Check for user. There might be an interactive setting.
2369 ;; Check for listener port.
2376 ;; Compose copy command.
2385 ?h host ?u user ?p port ?r listener ?c options
2391 copy-args
2393 ;; " " has either been a replacement of "%k" (when
2394 ;; keep-date argument is non-nil), or a replacement
2395 ;; for the whole keep-date sublist.
2396 " "
2401 copy-args
2405 copy-env
2407 nil
2414 remote-copy-program
2420 remote-copy-args
2424 ;; Check for local copy program.
2429 ;; Install listener on the remote side. The prompt must be
2430 ;; consumed later on, when the process does not listen anymore.
2437 v 'file-error
2441 'identity
2449 v 'file-error
2450 "Listener process not running on remote host: `%s'"
2451 remote-copy-program))
2459 ;; The default directory must be remote.
2463 ;; Set the transfer process properties.
2473 copy-args
2475 copy-args
2480 ;; Use an asynchronous process. By this, password can
2481 ;; be handled. We don't set a timeout, because the
2482 ;; copying of large files can last longer than 60 secs.
2492 command))))
2498 ;; We must adapt `tramp-local-end-of-line' for
2499 ;; sending the password.
2502 p v nil tramp-actions-copy-out-of-band))))
2504 ;; Reset the transfer process properties.
2507 ;; Clear the remote prompt.
2510 ;; Houston, we have a problem! Likely, the listener is
2511 ;; still running, so let's clear everything (but the
2512 ;; cached password).
2515 ;; Handle KEEP-DATE argument.
2518 newname
2522 ;; Set the mode.
2527 ;; If the operation was `rename', delete the original file.
2534 "Like `make-directory' for Tramp files."
2546 "Like `delete-directory' for Tramp files."
2559 "Like `delete-file' for Tramp files."
2570 ;; Dired.
2573 "Like `dired-compress-file' for Tramp files."
2574 ;; Code stolen mainly from dired-aux.el.
2579 suffix)
2580 ;; See if any suffix rule matches this file name.
2588 nil)
2590 ;; We found an uncompression rule.
2600 ;; We don't recognize the file as compressed, so compress it.
2601 ;; Try gzip.
2615 "Like `insert-directory' for Tramp files."
2622 filename switches wildcard full-directory-p)
2644 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2645 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2648 v
2651 switches
2653 localname
2656 v
2660 "Couldn't `cd %s'"
2664 v
2667 switches
2672 ""
2680 ;; We cannot use `insert-buffer-substring' because the Tramp
2681 ;; buffer changes its contents before insertion due to calling
2682 ;; `expand-file-name' and alike.
2687 ;; Check for "--dired" output.
2694 ;; Now read the numeric positions of file names.
2700 ;; End is followed by \n or by " -> ".
2702 ;; Remove trailing lines.
2708 ;; Some busyboxes are reluctant to discard colors.
2716 ;; Decode the output, it could be multibyte.
2721 ;; The inserted file could be from somewhere else.
2728 "."
2735 ;; Canonicalization of file names.
2738 "Like `expand-file-name' for Tramp files.
2740 the result will be a local, non-Tramp, file name."
2741 ;; If DIR is not given, use `default-directory' or "/".
2743 ;; Unless NAME is absolute, concat DIR and NAME.
2746 ;; If connection is not established yet, run the real handler.
2749 ;; Dissect NAME.
2753 ;; Tilde expansion if necessary. This needs a shell which
2754 ;; groks tilde expansion! The function `tramp-find-shell' is
2755 ;; supposed to find such a shell on the remote host. Please
2756 ;; tell me about it when this doesn't work on your system.
2760 ;; We cannot simply apply "~/", because under sudo "~/" is
2761 ;; expanded to the local user home directory but to the
2762 ;; root home directory. On the other hand, using always
2763 ;; the default user name for tilde expansion is not
2764 ;; appropriate either, because ssh and companions might
2765 ;; use a user name from the config file.
2777 ;; There might be a double slash, for example when "~/"
2778 ;; expands to "/". Remove this.
2781 ;; No tilde characters in file name, do normal
2782 ;; `expand-file-name' (this does "/./" and "/../").
2783 ;; `default-directory' is bound, because on Windows there would
2784 ;; be problems with UNC shares or Cygwin mounts.
2787 method user domain host port
2791 hop)))))
2793 ;;; Remote commands:
2796 "Flush file caches."
2804 ;; We use BUFFER also as connection buffer during setup. Because of
2805 ;; this, its original contents must be saved, and restored once
2806 ;; connection has been setup.
2808 "Like `start-file-process' for Tramp files."
2813 ;; BUFFER can be nil. We use a temporary buffer.
2815 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2816 ;; it might be that the arguments exceed the command line
2817 ;; length. Therefore, we modify the command.
2822 ;; When PROGRAM is nil, we just provide a tty.
2828 args
2832 ;; Use a human-friendly prompt, for example for `shell'.
2833 ;; We discard hops, if existing, that's why we cannot use
2834 ;; `file-remote-p'.
2843 tramp-initial-end-of-output))
2844 ;; We use as environment the difference to toplevel
2845 ;; `process-environment'.
2846 env uenv
2860 "unset %s &&"
2875 ;; We do not want to raise an error when
2876 ;; `start-file-process' has been started several times in
2877 ;; `eshell' and friends.
2879 p)
2882 ;; NAME must be unique as process name.
2886 ;; Set the new process properties.
2892 ;; We catch this event. Otherwise, `start-process' could
2893 ;; be called on the local host.
2896 ;; Activate narrowing in order to save BUFFER
2897 ;; contents. Clear also the modification time;
2898 ;; otherwise we might be interrupted by
2899 ;; `verify-visited-file-modtime'.
2905 ;; We call `tramp-maybe-open-connection', in order
2906 ;; to cleanup the prompt afterwards.
2910 ;; Set the pid of the remote shell. This is
2911 ;; needed when sending signals remotely.
2918 ;; Now do it.
2920 ;; Send the command.
2922 ;; Check, whether a pty is associated.
2925 v 'file-error
2927 ;; Set query flag and process marker for this
2928 ;; process. We ignore errors, because the process
2929 ;; could have finished already.
2933 ;; Return process.
2934 p)))
2936 ;; Save exit.
2947 "Like `process-file' for Tramp files."
2948 ;; The implementation is not complete yet.
2954 ;; Compute command.
2957 ;; We use as environment the difference to toplevel `process-environment'.
2968 "env %s %s"
2973 "unset %s && %s"
2975 ;; Determine input.
2980 ;; INFILE is on the same remote host.
2982 ;; INFILE must be copied to remote host.
2984 tmpinput
2989 ;; Determine output.
2991 ;; Just a buffer.
2994 ;; A buffer name.
2997 ;; (REAL-DESTINATION ERROR-DESTINATION)
2999 ;; output.
3007 ;; stderr.
3012 ;; stderr is on the same remote host.
3015 ;; stderr must be copied to remote host. The temporary
3016 ;; file must be deleted after execution.
3019 method user domain host port stderr))))
3020 ;; stderr to be discarded.
3023 ;; 't
3028 ;; Send the command. It might not return in time, so we protect
3029 ;; it. Call it in a subshell, in order to preserve working
3030 ;; directory.
3037 command)
3038 t t)
3040 ;; We should add the output anyway.
3047 ;; When the user did interrupt, we should do it also. We use
3048 ;; return code -1 as marker.
3052 ;; Handle errors.
3057 ;; Provide error file.
3060 ;; Cleanup. We remove all file cache values for the connection,
3061 ;; because the remote process could have changed them.
3067 ;; Return exit status.
3070 ret))))
3073 "Like `file-local-copy' for Tramp files."
3077 v tramp-file-missing
3088 ;; `copy-file' handles direct copy and out-of-band methods.
3093 ;; Use inline encoding for file transfer.
3097 v 3
3099 filename rem-enc)
3106 tmpfile loc-dec)
3108 ;; If local decoding is a function, we call it.
3109 ;; We must disable multibyte, because
3110 ;; `uudecode-decode-region' doesn't handle it
3111 ;; correctly. Unset `file-name-handler-alist'.
3112 ;; Otherwise, epa-file gets confused.
3120 ;; If tramp-decoding-function is not defined for this
3121 ;; method, we invoke tramp-decoding-command instead.
3123 ;; Unset `file-name-handler-alist'. Otherwise,
3124 ;; epa-file gets confused.
3132 loc-dec tmpfile2 tmpfile)
3135 ;; Set proper permissions.
3137 ;; Set local user ownership.
3140 ;; Oops, I don't know what to do.
3144 ;; Error handling.
3150 tmpfile)))
3152 ;; CCC grok LOCKNAME
3155 "Like `write-region' for Tramp files."
3173 ;; `file-writable-p' calls `file-expand-file-name'. We
3174 ;; cannot use `tramp-run-real-handler' therefore.
3180 ;; Short track: if we are on the local host, we can run directly.
3185 ;; We use this to save the value of
3186 ;; `last-coding-system-used' after writing the tmp
3187 ;; file. At the end of the function, we set
3188 ;; `last-coding-system-used' to this saved value. This
3189 ;; way, any intermediary coding systems used while
3190 ;; talking to the remote shell or suchlike won't hose
3191 ;; this variable. This approach was snarfed from
3192 ;; ange-ftp.el.
3193 coding-system-used
3194 ;; Write region into a tmp file. This isn't really
3195 ;; needed if we use an encoding function, but currently
3196 ;; we use it always because this makes the logic
3197 ;; simpler. We must also set `temporary-file-directory',
3198 ;; because it could point to a remote directory.
3204 ;; If `append' is non-nil, we copy the file locally, and let
3205 ;; the native `write-region' implementation do the job.
3208 ;; We say `no-message' here because we don't want the
3209 ;; visited file modtime data to be clobbered from the temp
3210 ;; file. We call `set-visited-file-modtime' ourselves later
3211 ;; on. We must ensure that `file-coding-system-alist'
3212 ;; matches `tmpfile'.
3218 'write-region
3225 ;; Now, `last-coding-system-used' has the right value. Remember it.
3228 ;; The permissions of the temporary file should be set. If
3229 ;; FILENAME does not exist (eq modes nil) it has been
3230 ;; renamed to the backup file. This case `save-buffer'
3231 ;; handles permissions.
3232 ;; Ensure that it is still readable.
3235 tmpfile
3238 ;; This is a bit lengthy due to the different methods
3239 ;; possible for file transfer. First, we check whether the
3240 ;; method uses an scp program. If so, we call it.
3241 ;; Otherwise, both encoding and decoding command must be
3242 ;; specified. However, if the method _also_ specifies an
3243 ;; encoding function, then that is used for encoding the
3244 ;; contents of the tmp file.
3250 ;; `copy-file' handles direct copy and out-of-band methods.
3260 ;; We keep the local file for performance
3261 ;; reasons, useful for "rsync".
3268 ;; Don't rename, in order to keep context in SELinux.
3273 ;; Use inline file transfer.
3275 ;; Encode tmpfile.
3279 ;; Use encoding function or command.
3282 "Encoding local file `%s' using `%s'"
3283 tmpfile loc-enc)
3285 ;; The following `let' is a workaround for
3286 ;; the base64.el that comes with pgnus-0.84.
3287 ;; If both of the following conditions are
3288 ;; satisfied, it tries to write to a local
3289 ;; file in default-directory, but at this
3290 ;; point, default-directory is remote.
3291 ;; (`call-process-region' can't write to
3292 ;; remote files, it seems.) The file in
3293 ;; question is a tmp file anyway.
3301 loc-enc tmpfile t))
3303 v 'file-error
3306 filename loc-enc))))
3308 ;; Send buffer into remote decoding command which
3309 ;; writes to remote file. Because this happens on
3310 ;; the remote host, we cannot use the function.
3313 "Decoding remote file `%s' using `%s'"
3314 filename rem-dec)
3318 v
3322 tramp-end-of-heredoc
3324 tramp-end-of-heredoc))
3326 v nil
3327 "Couldn't write region to `%s', decode using `%s' failed"
3328 filename rem-dec)
3329 ;; When `file-precious-flag' is set, the region is
3330 ;; written to a temporary file. Check that the
3331 ;; checksum is equal to that from the local tmpfile.
3335 ;; cksum runs locally, if possible.
3337 ;; cksum runs remotely.
3339 v
3342 ;; ... they are different.
3349 v 'file-error
3352 filename rem-dec)))))
3354 ;; Save exit.
3357 ;; That's not expected.
3360 v 'file-error
3363 method))))
3365 ;; Make `last-coding-system-used' have the right value.
3372 ;; We must protect `last-coding-system-used', now we have set it
3373 ;; to its correct value.
3375 ;; Set file modification time.
3379 ;; We must pass modtime explicitly, because FILENAME can
3380 ;; be different from (buffer-file-name), f.e. if
3381 ;; `file-precious-flag' is set.
3387 ;; Set the ownership.
3397 ;; VC backends check for the existence of various different special
3398 ;; files. This is very time consuming, because every single check
3399 ;; requires a remote command (the file cache must be invalidated).
3400 ;; Therefore, we apply a kind of optimization. We install the file
3401 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3402 ;; remembers all file names for which `file-exists-p' or
3403 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3404 ;; is performed. Afterwards, a script is applied for all collected
3405 ;; file names, using just one remote command. The result of this
3406 ;; script is used to fill the file cache with actual values. Now we
3407 ;; can reset the file name handlers, and we make a second run of
3408 ;; `vc-registered', which returns the expected result without sending
3409 ;; any other remote command.
3411 "Like `vc-registered' for Tramp files."
3417 ;; There could be new files, created by the vc backend. We
3418 ;; cannot reuse the old cache entries, therefore. In
3419 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3420 ;; could also be a timestamp as `current-time' returns. This
3421 ;; means invalidate all cache entries with an older timestamp.
3427 ;; Here we collect only file names, which need an operation.
3429 v "Error in 1st pass of `vc-registered': %s"
3433 ;; Send just one command, in order to fill the cache.
3436 v
3445 ;; We cannot use `tramp-send-command-and-read',
3446 ;; because this does not cooperate well with
3447 ;; heredoc documents.
3449 v
3452 tramp-end-of-heredoc
3454 tramp-vc-registered-file-names
3456 tramp-end-of-heredoc))
3458 ;; Read the expression.
3465 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3466 ;; calls shall be answered from the file cache. We unset
3467 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3468 ;; in order to keep the cache.
3470 remote-file-name-inhibit-cache process-file-side-effects)
3471 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3490 ;; Run.
3492 v "Error in 2nd pass of `vc-registered': %s"
3495 ;;;###tramp-autoload
3497 "Invoke remote-shell Tramp file name handler.
3498 Fall back to normal file name handler if no Tramp handler exists."
3504 ;; This must be the last entry, because `identity' always matches.
3505 ;;;###tramp-autoload
3510 "Invoke special file name handler, which collects files to be handled."
3518 ;; That's what we want: file names, for which checks are
3519 ;; applied. We assume that VC uses only `file-exists-p' and
3520 ;; `file-readable-p' checks; otherwise we must extend the
3521 ;; list. We do not perform any action, but return nil, in
3522 ;; order to keep `vc-registered' running.
3525 nil)
3526 ;; `process-file' and `start-file-process' shall be ignored.
3529 ;; Tramp file name handlers like `expand-file-name'. They
3530 ;; must still work.
3532 ;; Default file name handlers, we don't care.
3536 "Like `file-notify-add-watch' for Tramp files."
3540 command events filter p sequence)
3542 ;; gvfs-monitor-dir.
3545 events
3549 attribute-changed))
3554 ;; inotifywait.
3557 events
3567 ;; Make events a list of symbols.
3568 events
3572 ;; None.
3574 v 'file-notify-error
3575 "No file notification program found on %s"
3577 ;; Start process.
3579 'start-file-process
3583 sequence))
3584 ;; Return the process object as watch-descriptor.
3587 v 'file-notify-error
3588 "`%s' failed to start on remote host"
3592 ;; Needed for process filter.
3597 ;; There might be an error if the monitor is not supported.
3598 ;; Give the filter a chance to read the output.
3603 p))))
3607 file-notify events."
3617 ;; Attribute change is returned in unused wording.
3629 string)
3634 proc
3639 ;; File names are returned as absolute paths. We must
3640 ;; add the remote prefix.
3644 ;; Remove watch when file or directory to be watched is deleted.
3648 ;; Usually, we would add an Emacs event now. Unfortunately,
3649 ;; `unread-command-events' does not accept several events at
3650 ;; once. Therefore, we apply the handler directly.
3653 'file-notify-handle-event
3656 ;; Save rest of the string.
3666 ;; Check, whether there is a problem.
3672 line)
3677 proc
3684 ;; Remove watch when file or directory to be watched is deleted.
3687 ;; Usually, we would add an Emacs event now. Unfortunately,
3688 ;; `unread-command-events' does not accept several events at
3689 ;; once. Therefore, we apply the handler directly.
3692 'file-notify-handle-event
3695 ;;; Internal Functions:
3698 "Define in remote shell function NAME implemented as SCRIPT.
3699 Only send the definition if it has not already been done."
3700 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3701 ;; might be nil.
3707 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3708 ;; could result in unwanted command expansion. Avoid this.
3711 ;; The script could contain a call of Perl. This is masked with `%s'.
3716 vec
3724 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3725 Returns the exit code of the `test' program."
3728 v
3730 "%s %s %s"
3732 switch
3736 "Run `test'-like program on the remote system, given FILE1, FILE2.
3737 FORMAT-STRING contains the program name, switches, and place holders.
3738 Returns the exit code of the `test' program. Barfs if the methods,
3739 hosts, or files, disagree."
3743 v 'file-error
3748 v1
3755 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3756 First arg VEC specifies the connection, PROGNAME is the program
3757 to search for, and DIRLIST gives the list of directories to
3758 search. If IGNORE-TILDE is non-nil, directory names starting
3759 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3760 only in DIRLIST.
3762 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3764 This function expects to be in the right *tramp* buffer."
3767 ;; Check whether the executable is in $PATH. "which(1)" does not
3768 ;; report always a correct error code; therefore we check the
3769 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3770 ;; 5.11") have problems with this command, we disable the call
3771 ;; therefore.
3782 ;; Remove all ~/foo directories from dirlist.
3791 vec
3793 "do if test -x $d/%s && test -f $d/%s; "
3794 "then echo tramp_executable $d/%s; "
3797 progname progname progname
3798 tramp-end-of-heredoc
3800 tramp-end-of-heredoc))
3806 result)))
3809 "Sets the remote environment PATH to existing directories.
3810 I.e., for each directory in `tramp-remote-path', it is tested
3811 whether it exists and if so, it is added to the environment
3812 variable PATH."
3818 ;; ------------------------------------------------------------
3819 ;; -- Communication with external shell --
3820 ;; ------------------------------------------------------------
3823 "Find a command on the remote host for checking if a file exists.
3824 Here, we are looking for a command which has zero exit status if the
3825 file exists and nonzero exit status otherwise."
3829 result)
3830 ;; The algorithm is as follows: we try a list of several commands.
3831 ;; For each command, we first run `$cmd /' -- this should return
3832 ;; true, as the root directory always exists. And then we run
3833 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3834 ;; does not exist. This should return false. We use the first
3835 ;; command we find that seems to work.
3836 ;; The list of commands to try is as follows:
3837 ;; `ls -d' This works on most systems, but NetBSD 1.4
3838 ;; has a bug: `ls' always returns zero exit
3839 ;; status, even for files which don't exist.
3840 ;; `test -e' Some Bourne shells have a `test' builtin
3841 ;; which does not know the `-e' option.
3842 ;; `/bin/test -e' For those, the `test' binary on disk normally
3843 ;; provides the option. Alas, the binary
3844 ;; is sometimes `/bin/test' and sometimes it's
3845 ;; `/usr/bin/test'.
3846 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3874 result))
3877 "Opens shell SHELL."
3880 ;; Find arguments for this shell.
3882 item extra-args)
3887 ;; It is useful to set the prompt in the following command
3888 ;; because some people have a setting for $PS1 which /bin/sh
3889 ;; doesn't know about and thus /bin/sh will display a strange
3890 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3891 ;; ksh will display the current working directory but /bin/sh
3892 ;; will display a dollar sign. The following command line sets
3893 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3894 ;; well as csh-like shells. We also unset the variable $ENV
3895 ;; because that is read by some sh implementations (eg, bash
3896 ;; when called as sh) on startup; this way, we avoid the startup
3897 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3898 ;; the prompt in /bin/bash, it must be discarded as well.
3899 ;; $HISTFILE is set according to `tramp-histfile-override'.
3902 "exec env ENV=%s %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3908 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3912 t)
3913 ;; Check proper HISTFILE setting. We give up when not working.
3917 vec
3919 "(cd %s)"
3922 "`tramp-histfile-override' uses invalid file `%s'"
3923 tramp-histfile-override)))
3929 "Opens a shell on the remote host which groks tilde expansion."
3932 shell)
3935 ;; CCC: "root" does not exist always, see my QNAP TS-459.
3936 ;; Which check could we apply instead?
3939 ;; The default shell (ksh93) of OpenSolaris and
3940 ;; Solaris is buggy. We've got reports for
3941 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3950 ;; Maybe it works at least for some other commands.
3952 default-shell
3954 vec 2
3956 "Couldn't find a remote shell which groks tilde "
3958 default-shell)))
3960 default-shell)))
3962 ;; Open a new shell if needed.
3968 ;; Utility functions.
3971 "Wait for shell prompt and barf if none appears.
3972 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3973 seconds. If not, it produces an error message with the given ERROR-ARGS."
3977 proc timeout
3986 "Set up an interactive shell.
3987 Mainly sets the prompt and the echo correctly. PROC is the shell
3988 process to set up. VEC specifies the connection."
3993 ;; Disable echo expansion.
3997 ;; Check whether the echo has really been disabled. Some
3998 ;; implementations, like busybox of embedded GNU/Linux, don't
3999 ;; support disabling.
4006 ;; Make sure backspaces and their echo are enabled and no line
4007 ;; width magic interferes with them.
4014 t)
4016 ;; Check whether the output of "uname -sr" has been changed. If
4017 ;; yes, this is a strong indication that we must expire all
4018 ;; connection properties. We start again with
4019 ;; `tramp-maybe-open-connection', it will be caught there.
4024 vec "uname"
4028 vec 3
4029 "Connection reset, because remote host changed from `%s' to `%s'"
4030 old-uname uname)
4031 ;; We want to keep the password.
4035 ;; Try to set up the coding system correctly.
4036 ;; CCC this can't be the right way to do it. Hm.
4039 ;; Use MULE to select the right EOL convention for communicating
4040 ;; with the process.
4046 cs-decode cs-encode)
4050 cs-encode
4057 ;; Special setting for macOS.
4068 ;; Check whether the remote host suffers from buggy
4069 ;; `send-process-string'. This is known for FreeBSD (see comment
4070 ;; in `send_process', file process.c). I've tested sending 624
4071 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4072 ;; hack when this host type is detected locally. It cannot handle
4073 ;; remote hosts, though.
4077 tramp-chunksize)
4083 ;; Set remote PATH variable.
4086 ;; Search for a good shell before searching for a command which
4087 ;; checks if a file exists. This is done because Tramp wants to
4088 ;; use "test foo; echo $?" to check if various conditions hold,
4089 ;; and there are buggy /bin/sh implementations which don't execute
4090 ;; the "echo $?" part if the "test" part has an error. In
4091 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4092 ;; also other problems with /bin/sh of OpenSolaris, like
4093 ;; redirection of stderr in function declarations, or changing
4094 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4095 ;; by bash, when detected.
4098 ;; Disable unexpected output.
4101 ;; IRIX64 bash expands "!" even when in single quotes. This
4102 ;; destroys our shell functions, we must disable it. See
4103 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4107 ;; Disable tab expansion.
4112 ;; Set utf8 encoding. Needed for macOS, for example. This is
4113 ;; non-POSIX, so we must expect errors on some systems.
4116 ;; Set `remote-tty' process property.
4122 ;; Dump stty settings in the traces.
4126 ;; Set the environment.
4140 vec
4143 tramp-end-of-heredoc
4145 tramp-end-of-heredoc)
4146 t))
4151 ;; Old text from documentation of tramp-methods:
4152 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4153 ;; of the base64 methods instead since base64 encoding is much more
4154 ;; reliable and the commands are more standardized between the different
4155 ;; Unix versions. But if you can't use base64 for some reason, please
4156 ;; note that the default uudecode command does not work well for some
4157 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4158 ;; the following command for uudecode:
4159 ;;
4160 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4161 ;;
4162 ;; For Irix, no solution is known yet.
4170 "List of local coding commands for inline transfer.
4171 Each item is a list that looks like this:
4173 \(FORMAT ENCODING DECODING)
4175 FORMAT is symbol describing the encoding/decoding format. It can be
4176 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4178 ENCODING and DECODING can be strings, giving commands, or symbols,
4179 giving functions. If they are strings, then they can contain
4181 file name will be put into the command line at that spot. If the
4182 specifier is not present, the input should be read from standard
4183 input.
4185 If they are functions, they will be called with two arguments, start
4186 and end of region, and are expected to replace the region contents
4191 ;; "-i" is more robust with older base64 from GNU coreutils.
4192 ;; However, I don't know whether all base64 versions do supports
4193 ;; this option.
4201 ;; This is painful slow, so we put it on the end.
4208 "List of remote coding commands for inline transfer.
4209 Each item is a list that looks like this:
4211 \(FORMAT ENCODING DECODING [TEST])
4213 FORMAT is a symbol describing the encoding/decoding format. It can be
4214 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4216 ENCODING and DECODING can be strings, giving commands, or symbols,
4217 giving variables. If they are strings, then they can contain
4219 file name will be put into the command line at that spot. If the
4220 specifier is not present, the input should be read from standard
4221 input.
4223 If they are variables, this variable is a string containing a
4224 Perl or Shell implementation for this functionality. This
4225 program will be transferred to the remote host, and it is
4227 specifier in the variable value denotes a temporary file.
4229 The optional TEST command can be used for further tests, whether
4233 "Find an inline transfer encoding that works.
4234 Goes through the list `tramp-local-coding-commands' and
4235 `tramp-remote-coding-commands'."
4240 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4248 ;; If the local encoder or decoder is a string, the
4249 ;; corresponding command has to work locally.
4256 loc-enc nil nil))
4264 loc-dec nil nil))
4266 ;; Search for remote coding commands with the same format
4274 ;; Check the remote test command if exists.
4280 ;; Check if remote perl exists when necessary.
4285 ;; Check if remote encoding and decoding commands can be
4286 ;; called remotely with null input and output. This makes
4287 ;; sure there are no syntax errors and the command is really
4288 ;; found. Note that we do not redirect stdout to /dev/null,
4289 ;; for two reasons: when checking the decoding command, we
4290 ;; actually check the output it gives. And also, when
4291 ;; redirecting "mimencode" output to /dev/null, then as root
4292 ;; it might change the permissions of /dev/null!
4300 vec 5
4309 tmpfile)
4316 tramp-temp-name-prefix
4318 value
4320 value
4322 ?t
4327 vec 5
4330 vec
4332 t)
4340 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4346 ;; Set connection properties. Since the commands are risky
4347 ;; (due to output direction), we cache them in the process cache.
4358 "Call the local encoding or decoding command.
4360 Otherwise, INPUT is passed via standard input.
4361 INPUT can also be nil which means `/dev/null'.
4362 OUTPUT can be a string (which specifies a file name), or t (which
4363 means standard output and thus the current buffer), or nil (which
4364 means discard it)."
4366 nil tramp-encoding-shell
4369 nil
4370 tramp-encoding-command-switch
4380 "List of compress and decompress commands for inline transfer.
4381 Each item is a list that looks like this:
4383 \(COMPRESS DECOMPRESS)
4388 "Find an inline transfer compress command that works.
4389 Goes through the list `tramp-inline-compress-commands'."
4394 item compress decompress found)
4401 vec 5
4402 "Checking local compress commands `%s', `%s' for sanity"
4403 compress decompress)
4408 ;; Windows shells need the program file name after
4409 ;; the pipe symbol be quoted if they use forward
4410 ;; slashes as directory separators.
4414 magic compress decompress)
4415 nil nil))
4418 vec 5
4419 "Checking remote compress commands `%s', `%s' for sanity"
4420 compress decompress)
4426 ;; Did we find something?
4429 ;; Set connection properties. Since the commands are
4430 ;; risky (due to output direction), we cache them in the
4431 ;; process cache.
4445 "Expands VEC according to `tramp-default-proxies-alist'."
4449 choices proxy)
4451 ;; Ad-hoc proxy definitions.
4461 proxy)
4462 ;; Add the hop.
4464 'tramp-default-proxies-alist
4467 proxy))
4469 ;; Save the new value.
4474 ;; Look for proxy hosts to be passed.
4480 ;; Host.
4483 ;; User.
4487 ;; No more hops needed.
4489 ;; Replace placeholders.
4492 proxy
4497 ;; Add the hop.
4499 ;; Start next search.
4502 ;; Foreign and out-of-band methods are not supported for multi-hops.
4509 vec 'file-error
4510 "Method `%s' is not supported for multi-hops."
4513 ;; In case the host name is not used for the remote shell
4514 ;; command, the user could be misguided by applying a random
4515 ;; host name.
4521 ;; There are multi-hops.
4523 ;; The host name is used for the remote shell command.
4525 ;; The host is local. We cannot use `tramp-local-host-p'
4526 ;; here, because it opens a connection as well.
4529 v 'file-error
4530 "Host `%s' looks like a remote host, `%s' can only use the local host"
4531 host method)))
4533 ;; Result.
4534 target-alist))
4537 "Return the Control* arguments of the local ssh."
4539 ;; No options to be computed.
4544 ;; There is already a value to be used.
4547 ;; Determine the options.
4562 ;; We use a non-existing IP address, in order to
4563 ;; avoid useless connections, and DNS timeouts.
4564 ;; Setting ConnectTimeout is needed since OpenSSH 7.
4566 vec "ssh" nil t nil
4572 " -o ControlPath='tramp.%%r@%%h:%%p'"
4581 tramp-ssh-controlmaster-options)))
4584 "Maybe open a connection VEC.
4585 Does not do anything if a connection is already open, but re-opens the
4586 connection if a previous connection has died for some reason."
4592 ;; If Tramp opens the same connection within a short time frame,
4593 ;; there is a problem. We shall signal this.
4602 ;; If too much time has passed since last command was sent, look
4603 ;; whether process is still alive. If it isn't, kill it. When
4604 ;; using ssh, it can sometimes happen that the remote end has hung
4605 ;; up but the local ssh client doesn't recognize this until it
4606 ;; tries to send some data to the remote end. So that's why we
4607 ;; try to send a command from time to time, then look again
4608 ;; whether the process is really alive.
4619 ;; The error will be caught locally.
4625 ;; New connection must be opened.
4629 ;; During completion, don't reopen a new connection. We
4630 ;; check this for the process related to
4631 ;; `tramp-buffer-name'; otherwise `start-file-process'
4632 ;; wouldn't run ever when `non-essential' is non-nil.
4638 vec 3
4649 ;; Start new process.
4666 ;; We will apply `tramp-ssh-controlmaster-options'
4667 ;; only for the first hop.
4671 ;; There are unfortunate settings for "cmdproxy" on
4672 ;; W32 systems.
4675 ;; This must be done in order to avoid our file
4676 ;; name handler.
4680 'start-process
4685 tramp-encoding-command-interactive)
4688 ;; Set sentinel and query flag.
4699 ;; Check whether process is alive.
4701 p 10
4704 ;; Now do all the connections as specified.
4724 ;; We don't create the temporary file. In
4725 ;; fact, it is just a prefix for the
4726 ;; ControlPath option of ssh; the real
4727 ;; temporary file has another name, and it is
4728 ;; created and protected by ssh. It is also
4729 ;; removed by ssh when the connection is
4730 ;; closed. The temporary file name is cached
4731 ;; in the main connection process, therefore
4732 ;; we cannot use `tramp-get-connection-process'.
4738 tramp-temp-name-prefix
4740 spec r-shell)
4742 ;; Add arguments for asynchronous processes.
4746 ;; Check, whether there is a restricted shell.
4751 ;; Set variables for computing the prompt for
4752 ;; reading password.
4754 tramp-current-user l-user
4755 tramp-current-domain l-domain
4756 tramp-current-host l-host
4757 tramp-current-port l-port)
4759 ;; Add login environment.
4762 login-env
4767 login-env))
4771 "%s=%s %s"
4774 command)))
4777 ;; Replace `login-args' place holders.
4785 ?h l-host ?u l-user ?p l-port ?c options)
4786 command
4788 ;; We do not want to see the trailing local
4789 ;; prompt in `start-file-process'.
4791 command " "
4797 ;; Local shell could be a Windows COMSPEC. It
4798 ;; doesn't know the ";" syntax, but we must exit
4799 ;; always for `start-file-process'. It could
4800 ;; also be a restricted shell, which does not
4801 ;; allow "exec".
4804 ;; Send the command.
4808 p vec
4811 tramp-actions-before-shell
4815 ;; Next hop.
4819 ;; Set connection-local variables.
4822 ;; Make initial shell settings.
4825 ;; Mark it as connected.
4828 ;; Cleanup, and propagate the signal.
4834 "Send the COMMAND to connection VEC.
4835 Erases temporary buffer before sending the command. If optional
4836 arg NEVEROPEN is non-nil, never try to open the connection. This
4837 is meant to be used from `tramp-maybe-open-connection' only. The
4838 function waits for output unless NOOUTPUT is set."
4842 ;; We mark the command string that it can be erased in the output buffer.
4844 ;; If we put `tramp-echo-mark' after a trailing newline (which
4845 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4846 ;; that newline and adds `tramp-rsh-end-of-line' right after
4847 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4848 ;; trailing line endings and sends two prompts after executing
4849 ;; the command, which confuses `tramp-wait-for-output'.
4853 ;; No need to restore a trailing newline here since `tramp-send-string'
4854 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4856 ;; Send the command.
4862 "Wait for output from remote command."
4868 ;; be leading escape sequences, which must be ignored.
4869 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4870 ;; option send also escape sequences, which must be
4871 ;; ignored.
4874 tramp-device-escape-sequence-regexp))
4875 ;; Sometimes, the commands do not return a newline but a
4876 ;; null byte before the shell prompt, for example "git
4877 ;; ls-files -c -z ...".
4882 ;; A simple-minded busybox has sent " ^H" sequences.
4883 ;; Delete them.
4888 ;; Delete the prompt.
4894 proc 'file-error
4895 "[[Remote prompt `%s' not found in %d secs]]"
4896 tramp-end-of-output timeout)
4898 proc 'file-error
4900 ;; Return value is whether end-of-output sentinel was found.
4901 found)))
4905 "Run COMMAND and check its exit status.
4906 Sends `echo $?' along with the COMMAND for checking the exit status.
4907 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4908 status is 0, and nil otherwise.
4910 If the optional argument SUBSHELL is non-nil, the command is
4911 executed in a subshell, ie surrounded by parentheses. If
4912 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4914 vec
4916 command
4918 "echo tramp_exit_status $?"
4932 "Run COMMAND, check exit status, throw error if exit status not okay.
4933 Similar to `tramp-send-command-and-check' but accepts two more arguments
4934 FMT and ARGS which are passed to `error'."
4939 "Run COMMAND and return the output, which must be a Lisp expression.
4940 If MARKER is a regexp, read the output after that string.
4941 In case there is no valid Lisp expression and NOERROR is nil, it
4942 raises an error."
4949 ;; Read the marker.
4955 vec 'file-error
4956 "`%s' does not return the marker `%s': `%s'"
4958 ;; Read the expression.
4961 ;; Error handling.
4966 vec 'file-error
4967 "`%s' does not return a valid Lisp expression: `%s'"
4971 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4972 Convert file mode bits to string and set virtual device number.
4973 Return ATTR."
4975 ;; Remove color escape sequences from symlink.
4979 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
4980 ;; indication of unusable value.
4991 ;; Convert last access time.
4996 ;; Convert last modification time.
5001 ;; Convert last status change time.
5006 ;; Convert file size.
5012 ;; Convert file mode bits to string.
5017 ;; Convert directory indication bit.
5020 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5026 ;; Set file's gid change bit.
5034 ;; Convert inode.
5039 middle low)
5042 ;; The low 16 bits.
5047 ;; The middle 24 bits.
5051 ;; Inodes can be incredible huge. We must hide this.
5053 ;; Set virtual device number.
5056 attr))
5059 "Converts STRING to shell glob pattern which ignores case."
5065 string
5069 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5081 localname)
5087 "Return t if this is an out-of-band method, nil otherwise."
5089 ;; It shall be an out-of-band method.
5091 ;; There must be a size, otherwise the file doesn't exist.
5093 ;; Either the file size is large enough, or (in rare cases) there
5094 ;; does not exist a remote encoding.
5099 ;; Variables local to connection.
5102 "Compile list of remote directories for $PATH.
5103 Nonexistent directories are removed from spec."
5105 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5106 ;; cache the result for the session only. Otherwise, the result
5107 ;; is cached persistently.
5110 vec)
5111 "remote-path"
5120 ;; Default if "getconf" is not available.
5123 vec 3
5128 ;; The login shell could return more than just the $PATH
5129 ;; string. So we use `tramp-end-of-heredoc' as marker.
5133 vec
5138 'identity
5142 'identity
5150 nil)))))
5152 ;; Replace place holder `tramp-default-remote-path'.
5160 ;; Replace place holder `tramp-own-remote-path'.
5168 ;; Remove double entries.
5175 ;; Remove non-existing directories.
5177 nil
5189 x))
5190 x))
5191 remote-path)))))
5194 "Determine remote locale, supporting UTF8 if possible."
5198 locale)
5205 candidates nil)
5207 ;; Return value.
5211 "Determine remote `ls' command."
5218 result)
5220 ;; Check parameters. On busybox, "ls" output coloring is
5221 ;; enabled by default sometimes. So we try to disable it
5222 ;; when possible. $LS_COLORING is not supported there.
5223 ;; Some "ls" versions are sensible wrt the order of
5224 ;; arguments, they fail when "-al" is after the
5225 ;; "--color=never" argument (for example on FreeBSD).
5237 "Check, whether the remote `ls' command supports the --dired option."
5241 ;; Some "ls" versions are sensible wrt the order of arguments,
5242 ;; they fail when "-al" is after the "--dired" argument (for
5243 ;; example on FreeBSD).
5248 "Check, whether the remote `ls' command supports the --quoting-style option."
5257 "Check, whether the remote `ls' command supports the -w option."
5261 ;; Option "-w" is available on BSD systems. No argument is
5262 ;; given, because this could return wrong results in case "ls"
5263 ;; supports the "-w NUM" argument, as for busyboxes.
5268 "Determine remote `test' command."
5272 "test"
5276 "Check, whether the remote `test' command supports the -nt option."
5277 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5278 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5279 ;; for otherwise the shell crashes.
5291 vec
5298 "Determine remote command for file existing check."
5304 "Determine remote `ln' command."
5310 "Determine remote `perl' command."
5316 ;; Perform a basic check.
5321 ;; We must check also for some Perl modules.
5329 result)))
5332 "Determine remote `stat' command."
5337 tmp)
5338 ;; Check whether stat(1) returns usable syntax. "%s" does not
5339 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5340 ;; use shell quoted format for "%N", we check the boundaries "`"
5341 ;; and "'", therefore. See Bug#23422 in coreutils.
5342 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5343 ;; supported.
5352 result)))
5355 "Determine remote `readlink' command."
5363 result))))
5366 "Determine remote `trash' command.
5367 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5374 "Determine remote `touch' command."
5383 ;; Busyboxes do support the "-t" option only when they have been
5384 ;; built with the DESKTOP config option. Let's check it.
5387 vec "touch-t"
5389 vec
5391 "%s -t %s %s"
5392 result
5396 result)))
5399 "Determine remote `gvfs-monitor-dir' command."
5402 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5403 ;; establish better timeouts in filenotify-tests.el. Any better
5404 ;; distinction approach would be welcome!
5411 "Determine remote `inotifywait' command."
5417 "Determine remote `id' command."
5423 result)
5425 ;; Check POSIX parameter.
5431 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5433 vec
5441 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5443 vec
5447 "print $>"
5451 "Determine remote `python' command."
5459 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5461 vec
5465 "import os; print (os.getuid())"
5469 "The uid of the remote connection VEC, in ID-FORMAT.
5470 ID-FORMAT valid values are `string' and `integer'."
5481 ;; Ensure there is a valid result.
5484 tramp-unknown-id-integer)
5486 tramp-unknown-id-string)
5490 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5492 vec
5500 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5502 vec
5510 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5512 vec
5516 "import os; print (os.getgid())"
5520 "The gid of the remote connection VEC, in ID-FORMAT.
5521 ID-FORMAT valid values are `string' and `integer'."
5532 ;; Ensure there is a valid result.
5535 tramp-unknown-id-integer)
5537 tramp-unknown-id-string)
5541 "Check, whether the remote `env' command supports the -u option."
5544 ;; Option "-u" is a GNU extension.
5548 ;; Some predefined connection properties.
5550 "Return the compress command related to PROP.
5551 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5552 the length of the file to be compressed.
5554 If no corresponding command is found, nil is returned."
5563 "Return the coding command related to PROP.
5564 PROP is either `remote-encoding', `remote-decoding',
5565 `local-encoding' or `local-decoding'.
5567 SIZE is the length of the file to be coded. Depending on SIZE,
5568 compression might be applied.
5570 If no corresponding command is found, nil is returned.
5571 Otherwise, either a string is returned which contains a `%s' mark
5572 to be used for the respective input or output file; or a Lisp
5573 function cell is returned to be applied on a buffer."
5574 ;; We must catch the errors, because we want to return nil, when
5575 ;; no inline coding is found.
5585 compress)
5586 ;; The connection property might have been cached. So we must
5587 ;; send the script to the remote side - maybe.
5595 ;; Check for the `compress' command.
5597 ;; Return the value.
5618 coding)
5621 ;; Windows shells need the program file name after
5622 ;; the pipe symbol be quoted if they use forward
5623 ;; slashes as directory separators.
5630 coding compress))
5633 ;; Windows shells need the program file name after
5634 ;; the pipe symbol be quoted if they use forward
5635 ;; slashes as directory separators.
5640 compress coding))
5654 ;;; TODO:
5656 ;; * Don't use globbing for directories with many files, as this is
5657 ;; likely to produce long command lines, and some shells choke on
5658 ;; long command lines.
5659 ;;
5660 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5661 ;; then look if it's the right version (with `perl -v').
5662 ;;
5663 ;; * When editing a remote CVS controlled file as a different user, VC
5664 ;; gets confused about the file locking status. Try to find out why
5665 ;; the workaround doesn't work.
5666 ;;
5667 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5668 ;; until the last but one hop via `start-file-process'. Apply it
5669 ;; also for ftp and smb.
5670 ;;
5671 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5672 ;; some shell with root privileges, it would be nice if I could
5673 ;; just call
5674 ;; trampclient filename.c
5675 ;; as an editor, and the _current_ shell would connect to an Emacs
5676 ;; server and would be used in an existing non-privileged Emacs
5677 ;; session for doing the editing in question.
5678 ;; That way, I need not tell Emacs my password again and be afraid
5679 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5680 ;; once display a just typed password in the context of a keyboard
5681 ;; sequence prompt for a question immediately following in a shell
5682 ;; script run within Emacs -- nasty).
5683 ;; And if I have some ssh session running to a different computer,
5684 ;; having the possibility of passing a local file there to a local
5685 ;; Emacs session (in case I can arrange for a connection back) would
5686 ;; be nice.
5687 ;; Likely the corresponding Tramp server should not allow the
5688 ;; equivalent of the emacsclient -eval option in order to make this
5689 ;; reasonably unproblematic. And maybe trampclient should have some
5690 ;; way of passing credentials, like by using an SSL socket or
5691 ;; something. (David Kastrup)
5692 ;;
5693 ;; * Reconnect directly to a compliant shell without first going
5694 ;; through the user's default shell. (Pete Forman)
5695 ;;
5696 ;; * Avoid the local shell entirely for starting remote processes. If
5697 ;; so, I think even a signal, when delivered directly to the local
5698 ;; SSH instance, would correctly be propagated to the remote process
5699 ;; automatically; possibly SSH would have to be started with
5700 ;; "-t". (Markus Triska)
5701 ;;
5702 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5703 ;; isn't on the remote host. (Mark A. Hershberger)
5704 ;;
5705 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5706 ;;
5707 ;; * Optimize out-of-band copying when both methods are scp-like (not
5708 ;; rsync).
5709 ;;
5710 ;; * Keep a second connection open for out-of-band methods like scp or
5711 ;; rsync.
5712 ;;
5713 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5714 ;;
5715 ;; * I think you could get the best of both worlds by using an
5716 ;; approach similar to Tramp but running a little tramp-daemon on
5717 ;; the other end, such that we can use a more efficient
5718 ;; communication protocol (e.g. when saving a file we could locally
5719 ;; diff it against the last version (of which the remote daemon
5720 ;; would also keep a copy), and then only send the diff).
5721 ;;
5722 ;; This said, even using such a daemon it might be difficult to get
5723 ;; good performance: part of the problem is the number of
5724 ;; round-trips. E.g. when saving a file we have to check if the
5725 ;; file was modified in the mean time and whether saving into a new
5726 ;; inode would change the owner (etc...), which each require a
5727 ;; round-trip. To get rid of these round-trips, we'd have to
5728 ;; shortcut this code and delegate the higher-level "save file"
5729 ;; operation to the remote server, which then has to perform those
5730 ;; tasks but still obeying the locally set customizations about how
5731 ;; to do each one of those tasks.
5732 ;;
5733 ;; We could either put higher-level ops in there (like
5734 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5735 ;; behavior, which is a lot of work and likely to be not 100%
5736 ;; faithful.
5737 ;;
5738 ;; Or we could introduce new low-level ops that are asynchronous,
5739 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5740 ;; start with a bunch of calls like `start-getting-file-attributes'
5741 ;; which could immediately be passed on to the remote side, and
5742 ;; later on checks the return value of those calls as and when
5743 ;; needed. (Stefan Monnier)
5745 ;;; tramp-sh.el ends here