| blob | ff5d404aaacefbca1389ecce17fe7ca024e4087d |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections -*- lexical-binding:t -*-
3 ;; Copyright (C) 1998-2018 Free Software Foundation, Inc.
5 ;; (copyright statements below in code to be updated with the above notice)
7 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Maintainer: Michael Albinus <michael.albinus@gmx.de>
10 ;; Keywords: comm, processes
11 ;; Package: tramp
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
28 ;;; Code:
32 ;; Pacify byte-compiler.
43 ;;;###tramp-autoload
45 "The minimum size of compressing where inline transfer.
46 When inline transfer, compress transferred data of file
47 whose size is this value or above (up to `tramp-copy-size-limit').
48 If it is nil, no compression at all will be applied."
53 ;;;###tramp-autoload
55 "The maximum file size where inline copying is preferred over an \
56 out-of-the-band copy.
57 If it is nil, out-of-the-band copy will be used without a check."
62 ;;;###tramp-autoload
64 "Value of TERM environment variable for logging in to remote host.
65 Because Tramp wants to parse the output of the remote shell, it is easily
66 confused by ANSI color escape sequences and suchlike. Often, shell init
67 files conditionalize this setup based on the TERM environment variable."
72 ;;;###tramp-autoload
74 "When invoking a shell, override the HISTFILE with this value.
75 When setting to a string, it redirects the shell history to that
79 The value t unsets any setting of HISTFILE, and sets both
80 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
81 however, the *override* is disabled, so the history will go to
90 ;;;###tramp-autoload
94 ;;;###tramp-autoload
98 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
99 ;; root users. It uses the `$' character for other users. In order
100 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
104 "///%s#$"
106 "String used to recognize end of output.
107 The `$' character at the end is quoted; the string cannot be
110 ;;;###tramp-autoload
117 ;;;###tramp-autoload
119 "Whether to use `tramp-ssh-controlmaster-options'."
126 "Which ssh Control* arguments to use.
128 If it is a string, it should have the form
131 spec must be doubled, because the string is used as format string.
133 Otherwise, it will be auto-detected by Tramp, if
134 `tramp-use-ssh-controlmaster-options' is non-nil. The value
135 depends on the installed local ssh version.
139 ;; Initialize `tramp-methods' with the supported methods.
140 ;;;###tramp-autoload
152 ;;;###tramp-autoload
163 ;;;###tramp-autoload
177 ;;;###tramp-autoload
192 ;;;###tramp-autoload
208 ;;;###tramp-autoload
216 ;;;###tramp-autoload
224 ;;;###tramp-autoload
234 ;;;###tramp-autoload
244 ;;;###tramp-autoload
252 ;;;###tramp-autoload
261 ;; We use "-v" for better error tracking.
264 ;; We use "-p" as required for newer busyboxes. For older
265 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
266 ;; can be achieved by tweaking `tramp-connection-properties'.
268 ;;;###tramp-autoload
277 ;;;###tramp-autoload
279 'tramp-methods
286 ;;;###tramp-autoload
290 ;; The password template must be masked. Otherwise, it could be
291 ;; interpreted as password prompt if the remote host echoes the command.
294 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
300 ;;;###tramp-autoload
308 ;;;###tramp-autoload
317 ;;;###tramp-autoload
325 ;;;###tramp-autoload
329 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
333 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
334 tramp-terminal-type
335 tramp-initial-end-of-output))
340 ;;;###tramp-autoload
346 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
347 tramp-terminal-type
348 tramp-initial-end-of-output))
353 ;;;###tramp-autoload
360 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
361 tramp-terminal-type
362 tramp-initial-end-of-output))
372 ;;;###tramp-autoload
379 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
380 tramp-terminal-type
381 tramp-initial-end-of-output))
390 ;;;###tramp-autoload
402 ;;;###tramp-autoload
406 ;;;###tramp-autoload
410 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
411 ;; Do not add "plink" based methods, they ask interactively for the user.
412 ;;;###tramp-autoload
421 ;;;###tramp-autoload
427 ;;;###tramp-autoload
443 ;;;###tramp-autoload
448 ;;;###tramp-autoload
453 ;;;###tramp-autoload
458 ;;;###tramp-autoload
466 ;;;###tramp-autoload
495 ;; "getconf PATH" yields:
496 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
497 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
498 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
499 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
500 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
501 ;; IRIX64: /usr/bin
502 ;; QNAP QTS: ---
503 ;;;###tramp-autoload
509 "List of directories to search for executables on remote host.
510 For every remote host, this variable will be set buffer local,
511 keeping the list of existing directories on that host.
513 You can use `~' in this list, but when searching for a shell which groks
514 tilde expansion, all directory names starting with `~' will be ignored.
516 `Default Directories' represent the list of directories given by
518 entry on head of this list, because these are the default
519 directories for POSIX compatible commands. On remote hosts which
520 do not offer the getconf command (like cygwin), the value
522 the list by the special value `tramp-default-remote-path'.
524 `Private Directories' are the settings of the $PATH environment,
525 as given in your `~/.profile'. This entry is represented in
526 the list by the special value `tramp-own-remote-path'."
534 ;;;###tramp-autoload
539 "List of environment variables to be set on the remote host.
541 Each element should be a string of the form ENVVARNAME=VALUE. An
542 entry ENVVARNAME= disables the corresponding environment variable,
543 which might have been set in the init files like ~/.profile.
545 Special handling is applied to some environment variables,
546 which should not be set here:
548 The PATH environment variable should be set via `tramp-remote-path'.
550 The TERM environment variable should be set via `tramp-terminal-type'.
552 The INSIDE_EMACS environment variable will automatically be set
553 based on the TRAMP and Emacs versions, and should not be set here."
559 ;;;###tramp-autoload
561 "Alist specifying extra arguments to pass to the remote shell.
562 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
563 matching the shell file name and ARGS is a string specifying the
564 arguments.
566 This variable is only used when Tramp needs to start up another shell
567 for tilde expansion. The extra arguments should typically prevent the
568 shell from reading its init file."
583 "List of pattern/action pairs.
584 Whenever a pattern matches, the corresponding action is performed.
585 Each item looks like (PATTERN ACTION).
587 The PATTERN should be a symbol, a variable. The value of this
588 variable gives the regular expression to search for. Note that the
590 appended to it.
592 The ACTION should also be a symbol, but a function. When the
600 "List of pattern/action pairs.
601 This list is used for copying/renaming with out-of-band methods.
606 "(echo begin 600 %t; tail -n +2) | uudecode
607 cat %t
608 rm -f %t"
609 "Shell function to implement `uudecode' to standard output.
610 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
611 for this or `uudecode -p', but some systems don't, and for them
615 "%s -e '
616 use File::Spec;
619 sub myrealpath {
620 my ($file) = @_;
621 return realpath($file) if (-e $file || -l $file);
622 }
624 sub recursive {
625 my ($volume, @dirs) = @_;
626 my $real = myrealpath(File::Spec->catpath(
628 if ($real) {
629 my ($vol, $dir) = File::Spec->splitpath($real, 1);
630 return ($vol, File::Spec->splitdir($dir));
631 }
632 else {
633 my $last = pop(@dirs);
634 ($volume, @dirs) = recursive($volume, @dirs);
635 push(@dirs, $last);
636 return ($volume, @dirs);
637 }
638 }
640 $result = myrealpath($ARGV[0]);
641 if (!$result) {
642 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
643 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
646 }
651 "Perl script to produce output suitable for use with `file-truename'
652 on the remote file system.
653 Escape sequence %s is replaced with name of Perl binary.
657 "%s -e '
659 @files = readdir(d); closedir(d);
660 foreach $f (@files) {
663 }
664 else {
666 }
667 }
670 "Perl script to produce output suitable for use with
671 `file-name-all-completions' on the remote file system. Escape
672 sequence %s is replaced with name of Perl binary. This string is
675 ;; Perl script to implement `file-attributes' in a Lisp `read'able
676 ;; output. If you are hacking on this, note that you get *no* output
677 ;; unless this spits out a complete line, including the '\n' at the
678 ;; end.
679 ;; The device number is returned as "-1", because there will be a virtual
680 ;; device number set in `tramp-sh-handle-file-attributes'.
682 "%s -e '
683 @stat = lstat($ARGV[0]);
684 if (!@stat) {
686 exit 0;
687 }
688 if (($stat[2] & 0170000) == 0120000)
689 {
690 $type = readlink($ARGV[0]);
693 }
694 elsif (($stat[2] & 0170000) == 040000)
695 {
697 }
698 else
699 {
701 };
704 printf(
706 $type,
707 $stat[3],
708 $uid,
709 $gid,
710 $stat[8] >> 16 & 0xffff,
711 $stat[8] & 0xffff,
712 $stat[9] >> 16 & 0xffff,
713 $stat[9] & 0xffff,
714 $stat[10] >> 16 & 0xffff,
715 $stat[10] & 0xffff,
716 $stat[7],
717 $stat[2],
718 $stat[1] >> 16 & 0xffff,
719 $stat[1] & 0xffff
721 "Perl script to produce output suitable for use with `file-attributes'
722 on the remote file system.
723 Escape sequence %s is replaced with name of Perl binary.
727 "%s -e '
730 @list = readdir(DIR);
731 closedir(DIR);
732 $n = scalar(@list);
734 for($i = 0; $i < $n; $i++)
735 {
736 $filename = $list[$i];
737 @stat = lstat($filename);
738 if (($stat[2] & 0170000) == 0120000)
739 {
740 $type = readlink($filename);
743 }
744 elsif (($stat[2] & 0170000) == 040000)
745 {
747 }
748 else
749 {
751 };
755 printf(
756 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
757 $filename,
758 $type,
759 $stat[3],
760 $uid,
761 $gid,
762 $stat[8] >> 16 & 0xffff,
763 $stat[8] & 0xffff,
764 $stat[9] >> 16 & 0xffff,
765 $stat[9] & 0xffff,
766 $stat[10] >> 16 & 0xffff,
767 $stat[10] & 0xffff,
768 $stat[7],
769 $stat[2],
770 $stat[1] >> 16 & 0xffff,
771 $stat[1] & 0xffff,
772 $stat[0] >> 16 & 0xffff,
773 $stat[0] & 0xffff);
774 }
776 "Perl script implementing `directory-files-attributes' as Lisp `read'able
777 output.
778 Escape sequence %s is replaced with name of Perl binary.
781 ;; These two use base64 encoding.
783 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
784 "Perl program to use for encoding a file.
785 Escape sequence %s is replaced with name of Perl binary.
786 This string is passed to `format', so percent characters need to be doubled.
787 This implementation requires the MIME::Base64 Perl module to be installed
791 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
792 "Perl program to use for decoding a file.
793 Escape sequence %s is replaced with name of Perl binary.
794 This string is passed to `format', so percent characters need to be doubled.
795 This implementation requires the MIME::Base64 Perl module to be installed
799 "%s -e '
800 # This script contributed by Juanma Barranquero <lektu@terra.es>.
801 # Copyright (C) 2002-2018 Free Software Foundation, Inc.
802 use strict;
804 my %%trans = do {
805 my $i = 0;
806 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
807 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
808 };
809 my $data;
811 # We read in chunks of 54 bytes, to generate output lines
812 # of 72 chars (plus end of line)
813 while (read STDIN, $data, 54) {
814 my $pad = q();
816 # Only for the last chunk, and only if did not fill the last three-byte packet
817 if (eof) {
818 my $mod = length($data) %% 3;
819 $pad = q(=) x (3 - $mod) if $mod;
820 }
822 # Not the fastest method, but it is simple: unpack to binary string, split
823 # by groups of 6 bits and convert back from binary to byte; then map into
824 # the translation table
825 print
826 join q(),
827 map($trans{$_},
828 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
829 $pad,
831 }' 2>/dev/null"
832 "Perl program to use for encoding a file.
833 Escape sequence %s is replaced with name of Perl binary.
837 "%s -e '
838 # This script contributed by Juanma Barranquero <lektu@terra.es>.
839 # Copyright (C) 2002-2018 Free Software Foundation, Inc.
840 use strict;
842 my %%trans = do {
843 my $i = 0;
844 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
845 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
846 };
848 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
852 # We are going to accumulate into $pending to accept any line length
853 # (we do not check they are <= 76 chars as the RFC says)
854 my $pending = q();
856 while (my $data = <STDIN>) {
857 chomp $data;
859 # If we find one or two =, we have reached the end and
860 # any following data is to be discarded
861 my $finished = $data =~ s/(==?).*/$1/;
862 $pending .= $data;
864 my $len = length($pending);
865 my $chunk = substr($pending, 0, $len & ~3);
866 $pending = substr($pending, $len & ~3 + 1);
868 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
869 # split in 8-bit chunks and convert back to char.
870 print join q(),
871 map $bytes{$_},
872 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
874 last if $finished;
875 }' 2>/dev/null"
876 "Perl program to use for decoding a file.
877 Escape sequence %s is replaced with name of Perl binary.
881 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
882 "Perl program to use for encoding a file.
886 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
887 "Perl program to use for decoding a file.
892 BEGIN {
895 }
896 {
897 for (c=1; c<=length($0); c++) {
898 d=index(b16, substr($0,c,1))
899 if (d--) {
900 for (b=1; b<=4; b++) {
901 o=o*2+int(d/8); d=(d*2)%%16
902 if (++obc==6) {
903 printf substr(b64,o+1,1)
905 obc=0; o=0
906 }
907 }
908 }
909 }
910 }
911 END {
912 if (obc) {
914 while (obc++<6) { o=o*2 }
916 } else {
918 }
919 printf tail
920 }'"
921 "Awk program to use for encoding a file.
926 BEGIN {
928 }
929 {
930 for (i=1; i<=length($0); i++) {
931 c=index(b64, substr($0,i,1))
932 if(c--) {
933 for(b=0; b<6; b++) {
934 o=o*2+int(c/32); c=(c*2)%%64
935 if(++obc==8) {
936 if (o) {
938 } else {
940 }
941 obc=0; o=0
942 }
943 }
944 }
945 }
946 }'"
947 "Awk program to use for decoding a file.
951 "test -c /dev/zero && \
952 od -v -t x1 -A n </dev/null && \
953 busybox awk '{}' </dev/null"
964 while read file; do
967 else
969 fi
972 else
974 fi
975 done
977 "Script to check existence of VC related files.
978 It must be send formatted with two strings; the tests for file
979 existence, and file readability. Input shall be read via
980 here-document, otherwise the command could exceed maximum length
983 ;; New handlers should be added here.
984 ;;;###tramp-autoload
988 ;; `byte-compiler-base-file-name' performed by default handler.
993 ;; `diff-latest-backup-file' performed by default handler.
997 . tramp-sh-handle-directory-files-and-attributes)
1017 ;; `file-name-sans-versions' performed by default handler.
1032 ;; `find-file-noselect' performed by default handler.
1033 ;; `get-file-buffer' performed by default handler.
1039 ;; `make-directory-internal' performed by default handler.
1057 "Alist of handler functions.
1060 ;;; File Name Handler Functions:
1064 "Like `make-symbolic-link' for Tramp files.
1065 If TARGET is a non-Tramp file, it is used verbatim as the target
1066 of the symlink. If TARGET is a Tramp file, only the localname
1067 component is used as the target of the symlink."
1073 ;; If TARGET is a Tramp name, use just the localname component.
1080 ;; If TARGET is still remote, quote it.
1084 linkname ok-if-already-exists)
1091 v 'file-error
1094 ;; Do the 'confirm if exists' thing.
1096 ;; What to do?
1102 "File %s already exists; make it a link anyway? "
1103 localname)))))
1110 ;; Right, they are on the same host, regardless of user,
1111 ;; method, etc. We now make the link on the remote
1112 ;; machine. This will occur as the user that TARGET belongs to.
1117 "%s -sf %s %s" ln
1119 ;; The command could exceed PATH_MAX, so we use
1120 ;; relative file names. However, relative file
1121 ;; names could start with "-".
1122 ;; `tramp-shell-quote-argument' does not handle
1123 ;; this, we must do it ourselves.
1128 "Like `file-truename' for Tramp files."
1130 "%s%s"
1133 method user domain host port
1140 ;; Use GNU readlink --canonicalize-missing where available.
1143 v
1151 ;; Use Perl implementation.
1159 v
1163 ;; Do it yourself.
1167 ;; Don't make the following value larger than
1168 ;; necessary. People expect an error message in a
1169 ;; timely fashion when something is wrong;
1170 ;; otherwise they might think that Emacs is hung.
1171 ;; Of course, correctness has to come first.
1173 symlink-target)
1185 method user domain host port
1197 ;; It's a symlink, follow it.
1207 ;; It's a file.
1211 v 'file-error
1214 ;; Combine list to form string.
1222 ;; Detect cycle.
1226 v 'file-error
1228 ;; If the resulting localname looks remote, we must quote it
1229 ;; for security reasons.
1234 result))))
1236 ;; Preserve trailing "/".
1239 ;; Basic functions.
1242 "Like `file-exists-p' for Tramp files."
1250 v
1252 "%s %s"
1257 "Like `file-attributes' for Tramp files."
1260 ;; Don't modify `last-coding-system-used' by accident.
1267 v
1275 ;; The scripts could fail, for example with huge file size.
1279 "Implement `file-attributes' for Tramp files using the ls(1) command."
1281 res-inode res-filemodes res-numlinks
1282 res-uid res-gid res-size res-symlink-target)
1284 ;; We cannot send all three commands combined, it could exceed
1285 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1287 vec
1292 vec
1297 vec
1301 ;; On systems which have no quoting style, file names
1302 ;; with special characters could fail.
1310 ;; Parse `ls -l' output ...
1314 ;; ... inode
1316 ;; ... file mode flags
1318 ;; ... number links
1320 ;; ... uid and gid
1332 ;; ... size
1334 ;; From the file modes, figure out other stuff.
1337 ;; If symlink, find out file name pointed to.
1344 ;; Return data gathered.
1346 ;; 0. t for directory, string (name linked to) for symbolic
1347 ;; link, or nil.
1349 ;; 1. Number of links to file.
1350 res-numlinks
1351 ;; 2. File uid.
1352 res-uid
1353 ;; 3. File gid.
1354 res-gid
1355 ;; 4. Last access time, as a list of integers. Normally
1356 ;; this would be in the same format as `current-time', but
1357 ;; the subseconds part is not currently implemented, and
1358 ;; (0 0) denotes an unknown time.
1359 ;; 5. Last modification time, likewise.
1360 ;; 6. Last status change time, likewise.
1362 ;; 7. Size in bytes (-1, if number is out of range).
1363 res-size
1364 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1365 res-filemodes
1366 ;; 9. t if file's gid would change if file were deleted and
1367 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1368 t
1369 ;; 10. Inode number.
1370 res-inode
1371 ;; 11. Device number. Will be replaced by a virtual device number.
1376 "Implement `file-attributes' for Tramp files using a Perl script."
1381 vec
1387 "Implement `file-attributes' for Tramp files using stat(1) command."
1390 vec
1393 ;; On Opsware, pdksh (which is the true name of ksh there)
1394 ;; doesn't parse correctly the sequence "((". Therefore, we add
1395 ;; a space. Apostrophes in the stat output are masked as
1396 ;; `tramp-stat-marker', in order to make a proper shell escape of
1397 ;; them in file names.
1398 "( (%s %s || %s -h %s) && (%s -c "
1399 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1406 tramp-stat-marker tramp-stat-marker
1411 tramp-stat-marker tramp-stat-marker
1413 tramp-stat-quoted-marker)))
1416 "Like `set-visited-file-modtime' for Tramp files."
1423 coding-system-used)
1427 ;; '(-1 65535) means file doesn't exists yet.
1431 ;; We use '(0 0) as a don't-know value. See also
1432 ;; `tramp-do-file-attributes-with-ls'.
1437 v
1445 nil)))))
1447 ;; This function makes the same assumption as
1448 ;; `tramp-sh-handle-set-visited-file-modtime'.
1450 "Like `verify-visited-file-modtime' for Tramp files.
1451 At the time `verify-visited-file-modtime' calls this function, we
1452 already know that the buffer is visiting a file and that
1453 `visited-file-modtime' does not return 0. Do not call this
1454 function directly, unless those two cases are already taken care
1455 of."
1458 ;; There is no file visiting the buffer, or the buffer has no
1459 ;; recorded last modification time, or there is no established
1460 ;; connection.
1464 t
1472 ;; File exists, and has a known modtime.
1475 modtime
1476 ;; For compatibility, deal with both the old
1477 ;; (HIGH . LOW) and the new (HIGH LOW) return
1478 ;; values of `visited-file-modtime'.
1481 mt)))
1483 ;; Modtime has the don't know value.
1486 v
1493 attr
1496 ;; If file does not exist, say it is not modified if and
1497 ;; only if that agrees with the buffer's record.
1501 "Like `set-file-modes' for Tramp files."
1505 ;; FIXME: extract the proper text from chmod's stderr.
1507 v
1512 "Like `set-file-times' for Tramp files."
1519 time)))
1522 "env TZ=UTC %s %s %s"
1530 "Set the ownership for FILENAME.
1531 If UID and GID are provided, these values are used; otherwise uid
1532 and gid of the corresponding user is taken. Both parameters must
1533 be non-negative integers."
1534 ;; Modern Unices allow chown only for root. So we might need
1535 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1536 ;; working with su(do)? when it is needed, so it shall succeed in
1537 ;; the majority of cases.
1538 ;; Don't modify `last-coding-system-used' by accident.
1543 ;; If we are root on the local host, we can do it directly.
1551 "chown %d:%d %s" uid gid
1554 ;; We handle also the local part, because there doesn't exist
1555 ;; `set-file-uid-gid'. On W32 "chown" does not work.
1560 nil "chown" nil nil nil
1564 "Check, whether SELINUX is enabled on the remote host."
1569 "Like `file-selinux-context' for Tramp files."
1578 "%s -d -Z %s"
1586 ;; Return the context.
1587 context))))
1590 "Like `set-file-selinux-context' for Tramp files."
1609 t)))))
1612 "Check, whether ACL is enabled on the remote host."
1617 "Like `file-acl' for Tramp files."
1623 "getfacl -ac %s"
1632 "Like `set-file-acl' for Tramp files."
1639 tramp-end-of-heredoc
1640 acl-string
1641 tramp-end-of-heredoc))
1643 ;; Success.
1646 t)
1647 ;; In case of errors, we return nil.
1649 nil)))
1651 ;; Simple functions using the `test' command.
1654 "Like `file-executable-p' for Tramp files."
1657 ;; Examine `file-attributes' cache to see if request can be
1658 ;; satisfied without remote operation.
1663 "Like `file-readable-p' for Tramp files."
1666 ;; Examine `file-attributes' cache to see if request can be
1667 ;; satisfied without remote operation.
1671 ;; When the remote shell is started, it looks for a shell which groks
1672 ;; tilde expansion. Here, we assume that all shells which grok tilde
1673 ;; expansion will also provide a `test' command which groks `-nt' (for
1674 ;; newer than). If this breaks, tell me about it and I'll try to do
1675 ;; something smarter about it.
1677 "Like `file-newer-than-file-p' for Tramp files."
1679 nil)
1681 t)
1682 ;; We are sure both files exist at this point.
1685 ;; We try to get the mtime of both files. If they are not
1686 ;; equal to the "dont-know" value, then we subtract the times
1687 ;; and obtain the result.
1700 ;; If one of them is the dont-know value, then we can
1701 ;; still try to run a shell command on the remote host.
1702 ;; However, this only works if both files are Tramp
1703 ;; files and both have the same method, same user, same
1704 ;; host.
1709 v 'file-error
1710 "Files %s and %s must have same method, user, host"
1711 file1 file2)))
1716 ;; Functions implemented using the basic functions above.
1719 "Like `file-directory-p' for Tramp files."
1721 ;; `file-directory-p' is used as predicate for file name completion.
1722 ;; Sometimes, when a connection is not established yet, it is
1723 ;; desirable to return t immediately for "/method:foo:". It can
1724 ;; be expected that this is always a directory.
1730 "Like `file-writable-p' for Tramp files."
1734 ;; Examine `file-attributes' cache to see if request can be
1735 ;; satisfied without remote operation.
1738 ;; If file doesn't exist, check if directory is writable.
1743 "Like `file-ownership-preserved-p' for Tramp files."
1747 ;; Return t if the file doesn't exist, since it's true that no
1748 ;; information would be lost by an (attempted) delete and create.
1757 ;; Directory listings.
1761 "Like `directory-files-and-attributes' for Tramp files."
1769 v localname
1780 v localname id-format))
1783 v localname id-format))
1785 result item)
1795 result
1797 ;; The scripts could fail, for example with huge file size.
1799 directory full match nosort id-format)))))
1803 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1806 vec tramp-perl-directory-files-and-attributes
1810 vec
1814 object))
1818 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1821 vec
1824 ;; We must care about file names with spaces, or starting with
1825 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1826 ;; but it does not work on all remote systems. Apostrophes in
1827 ;; the stat output are masked as `tramp-stat-marker', in order to
1828 ;; make a proper shell escape of them in file names.
1830 "xargs %s -c "
1831 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1835 ;; On systems which have no quoting style, file names with special
1836 ;; characters could fail.
1844 tramp-stat-marker tramp-stat-marker
1845 tramp-stat-marker tramp-stat-marker
1850 tramp-stat-marker tramp-stat-marker
1851 tramp-stat-quoted-marker)))
1853 ;; This function should return "foo/" for directories and "bar" for
1854 ;; files.
1856 "Like `file-name-all-completions' for Tramp files."
1859 filename
1863 ;; Get a list of directories and files, including reliably
1864 ;; tagging the directories with a trailing "/". Because I
1865 ;; rock. --daniel@danann.net
1867 v
1871 v tramp-perl-file-name-all-completions
1877 "(cd %s 2>&1 && %s -a 2>/dev/null"
1878 " | while IFS= read f; do"
1886 ;; Now grab the output.
1890 ;; Check result code, found in last line of output.
1894 ;; Grab error message from line before last line
1895 ;; (it was put there by `cd 2>&1').
1898 v 'file-error
1899 "tramp-sh-handle-file-name-all-completions: %s"
1901 ;; For peace of mind, if buffer doesn't end in `fail'
1902 ;; then it should end in `ok'. If neither are in the
1903 ;; buffer something went seriously wrong on the remote
1904 ;; side.
1908 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1913 result))))))
1915 ;; cp, mv and ln
1919 "Like `add-name-to-file' for Tramp files."
1924 v 'file-error
1925 "add-name-to-file: %s"
1931 ;; Do the 'confirm if exists' thing.
1933 ;; What to do?
1938 "File %s already exists; make it a link anyway? "
1939 v2-localname)))))
1945 v1
1949 "error with add-name-to-file, see buffer `%s' for details"
1954 preserve-uid-gid preserve-extended-attributes)
1955 "Like `copy-file' for Tramp files."
1961 'copy filename newname ok-if-already-exists keep-date
1962 preserve-uid-gid preserve-extended-attributes)
1964 'copy-file
1966 preserve-uid-gid preserve-extended-attributes))))
1970 "Like `copy-directory' for Tramp files."
1976 ;; When DIRNAME and NEWNAME are remote, they must have
1977 ;; the same method.
1983 ;; scp or rsync DTRT.
2001 ;; We must do it file-wise.
2003 'copy-directory
2006 ;; When newname did exist, we have wrong cached values.
2014 "Like `rename-file' for Tramp files."
2015 ;; Check if both files are local -- invoke normal rename-file.
2016 ;; Otherwise, use Tramp from local system.
2019 ;; At least one file a Tramp file?
2023 'rename filename newname ok-if-already-exists
2030 preserve-uid-gid preserve-extended-attributes)
2031 "Copy or rename a remote file.
2032 OP must be `copy' or `rename' and indicates the operation to perform.
2033 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2034 the new file (for copy) or the new name of the file (for rename).
2035 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2036 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2037 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2038 the uid and gid if both files are on the same host.
2039 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2041 This function is invoked by `tramp-sh-handle-copy-file' and
2042 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2043 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2044 file names."
2067 filename newname)
2070 ;; Both are Tramp files.
2075 ;; Shortcut: if method, host, user are the same for
2076 ;; both files, we invoke `cp' or `mv' on the remote
2077 ;; host directly.
2080 op filename newname
2081 ok-if-already-exists keep-date preserve-uid-gid))
2083 ;; Try out-of-band operation.
2088 op filename newname keep-date))
2090 ;; No shortcut was possible. So we copy the file
2091 ;; first. If the operation was `rename', we go back
2092 ;; and delete the original file (if the copy was
2093 ;; successful). The approach is simple-minded: we
2094 ;; create a new buffer, insert the contents of the
2095 ;; source file into it, then write out the buffer to
2096 ;; the target file. The advantage is that it doesn't
2097 ;; matter which file name handlers are used for the
2098 ;; source and target file.
2101 op filename newname keep-date))))))
2103 ;; One file is a Tramp file, the other one is local.
2106 ;; Fast track on local machine.
2109 op filename newname
2110 ok-if-already-exists keep-date preserve-uid-gid))
2112 ;; If the Tramp file has an out-of-band method, the
2113 ;; corresponding copy-program can be invoked.
2116 op filename newname keep-date))
2118 ;; Use the inline method via a Tramp buffer.
2120 op filename newname keep-date))))
2123 ;; One of them must be a Tramp file.
2126 ;; Handle `preserve-extended-attributes'. We ignore possible
2127 ;; errors, because ACL strings could be incompatible.
2132 ;; In case of `rename', we must flush the cache of the source file.
2139 ;; When newname did exist, we have wrong cached values.
2147 "Use an Emacs buffer to copy or rename a file.
2148 First arg OP is either `copy' or `rename' and indicates the operation.
2149 FILENAME is the source file, NEWNAME the target file.
2150 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2151 ;; Check, whether file is too large. Emacs checks in `insert-file-1'
2152 ;; and `find-file-noselect', but that's not called here.
2156 ;; We must disable multibyte, because binary data shall not be
2157 ;; converted. We don't want the target file to be compressed, so we
2158 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2159 ;; be called either. We remove `tramp-file-name-handler' from
2160 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2161 ;; `insert-file-contents' might be deactivated in some corner cases.
2172 ;; KEEP-DATE handling.
2175 newname
2178 ;; Set the mode.
2180 ;; If the operation was `rename', delete the original file.
2185 "Invokes `cp' or `mv' on the remote system.
2186 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2187 respectively. FILENAME specifies the file to copy or rename,
2188 NEWNAME is the name of the new file (for copy) or the new name of
2189 the file (for rename). Both files must reside on the same host.
2190 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2191 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2192 the uid and gid from FILENAME."
2203 v 'file-error
2204 "Unknown operation `%s', must be `copy' or `rename'"
2205 op))))
2209 cmd-result)
2212 ;; Both files are on a remote host, with same user.
2224 ;; Mask cp -f error.
2226 tramp-operation-not-permitted-regexp nil t))
2227 cmd-result)
2229 nil v 'file-error
2230 "Copying directly failed, see buffer `%s' for details."
2233 ;; We are on the local host.
2236 ;; We can do it directly.
2239 ;; No sticky bit when renaming.
2250 localname1 localname2 ok-if-already-exists
2251 keep-date preserve-uid-gid)
2255 ;; We can do it directly with `tramp-send-command'
2263 ok-if-already-exists keep-date t)
2264 ;; We must change the ownership to the local user.
2270 ;; We need a temporary file in between.
2272 ;; Create the temporary file.
2280 "%s %s %s" cmd
2283 "Copying directly failed, see buffer `%s' for details."
2285 ;; We must change the ownership as remote user.
2286 ;; Since this does not work reliable, we also
2287 ;; give read permissions.
2297 localname1 tmpfile t keep-date preserve-uid-gid)
2300 ;; We must change the ownership as local user.
2301 ;; Since this does not work reliable, we also
2302 ;; give read permissions.
2305 tmpfile
2309 ;; Move the temporary file to its destination.
2314 "cp -f -p %s %s"
2317 "Copying directly failed, see buffer `%s' for details."
2321 'rename-file
2324 ;; Save exit.
2327 ;; Set the time and mode. Mask possible errors.
2334 "Invoke `scp' program to copy.
2335 The method used must be an out-of-band method."
2339 copy-program copy-args copy-env copy-keep-date listener spec
2340 options source target remote-copy-program remote-copy-args)
2345 ;; Both are Tramp files. We shall optimize it when the
2346 ;; methods for FILENAME and NEWNAME are the same.
2356 op filename tmpfile keep-date)
2359 ;; Save exit.
2366 ;; Check which ones of source and target are Tramp files.
2370 'file-name-as-directory
2379 ;; Check for user. There might be an interactive setting.
2383 ;; Check for listener port.
2390 ;; Compose copy command.
2399 ?h host ?u user ?p port ?r listener ?c options
2405 copy-args
2407 ;; " " has either been a replacement of "%k" (when
2408 ;; keep-date argument is non-nil), or a replacement
2409 ;; for the whole keep-date sublist.
2410 " "
2415 copy-args
2419 copy-env
2421 nil
2428 remote-copy-program
2434 remote-copy-args
2438 ;; Check for local copy program.
2443 ;; Install listener on the remote side. The prompt must be
2444 ;; consumed later on, when the process does not listen anymore.
2451 v 'file-error
2455 'identity
2463 v 'file-error
2464 "Listener process not running on remote host: `%s'"
2465 remote-copy-program))
2473 ;; The default directory must be remote.
2477 ;; We do not want to run timers.
2478 timer-list timer-idle-list)
2479 ;; Set the transfer process properties.
2489 copy-args
2491 copy-args
2496 ;; Use an asynchronous process. By this, password can
2497 ;; be handled. We don't set a timeout, because the
2498 ;; copying of large files can last longer than 60 secs.
2508 command))))
2514 ;; We must adapt `tramp-local-end-of-line' for
2515 ;; sending the password.
2518 p v nil tramp-actions-copy-out-of-band))))
2520 ;; Reset the transfer process properties.
2523 ;; Clear the remote prompt.
2526 ;; Houston, we have a problem! Likely, the listener is
2527 ;; still running, so let's clear everything (but the
2528 ;; cached password).
2531 ;; Handle KEEP-DATE argument.
2534 newname
2538 ;; Set the mode.
2543 ;; If the operation was `rename', delete the original file.
2550 "Like `make-directory' for Tramp files."
2562 "Like `delete-directory' for Tramp files."
2575 "Like `delete-file' for Tramp files."
2586 ;; Dired.
2589 "Like `dired-compress-file' for Tramp files."
2590 ;; Code stolen mainly from dired-aux.el.
2595 suffix)
2596 ;; See if any suffix rule matches this file name.
2604 nil)
2606 ;; We found an uncompression rule.
2616 ;; We don't recognize the file as compressed, so compress it.
2617 ;; Try gzip.
2631 "Like `insert-directory' for Tramp files."
2638 filename switches wildcard full-directory-p)
2660 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2661 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2664 v
2667 switches
2669 localname
2672 v
2676 "Couldn't `cd %s'"
2680 v
2683 switches
2688 ""
2696 ;; We cannot use `insert-buffer-substring' because the Tramp
2697 ;; buffer changes its contents before insertion due to calling
2698 ;; `expand-file-name' and alike.
2703 ;; Check for "--dired" output.
2710 ;; Now read the numeric positions of file names.
2716 ;; End is followed by \n or by " -> ".
2718 ;; Remove trailing lines.
2724 ;; Some busyboxes are reluctant to discard colors.
2732 ;; Decode the output, it could be multibyte.
2737 ;; The inserted file could be from somewhere else.
2744 "."
2749 ;; Try to insert the amount of free space.
2751 ;; First find the line to put it on.
2755 ;; Replace "total" with "total used", to avoid confusion.
2762 ;; Canonicalization of file names.
2765 "Like `expand-file-name' for Tramp files.
2767 the result will be a local, non-Tramp, file name."
2768 ;; If DIR is not given, use `default-directory' or "/".
2770 ;; Unless NAME is absolute, concat DIR and NAME.
2773 ;; If connection is not established yet, run the real handler.
2776 ;; Dissect NAME.
2780 ;; Tilde expansion if necessary. This needs a shell which
2781 ;; groks tilde expansion! The function `tramp-find-shell' is
2782 ;; supposed to find such a shell on the remote host. Please
2783 ;; tell me about it when this doesn't work on your system.
2787 ;; We cannot simply apply "~/", because under sudo "~/" is
2788 ;; expanded to the local user home directory but to the
2789 ;; root home directory. On the other hand, using always
2790 ;; the default user name for tilde expansion is not
2791 ;; appropriate either, because ssh and companions might
2792 ;; use a user name from the config file.
2804 ;; There might be a double slash, for example when "~/"
2805 ;; expands to "/". Remove this.
2808 ;; No tilde characters in file name, do normal
2809 ;; `expand-file-name' (this does "/./" and "/../").
2810 ;; `default-directory' is bound, because on Windows there would
2811 ;; be problems with UNC shares or Cygwin mounts.
2814 method user domain host port
2818 hop)))))
2820 ;;; Remote commands:
2823 "Flush file caches."
2831 ;; We use BUFFER also as connection buffer during setup. Because of
2832 ;; this, its original contents must be saved, and restored once
2833 ;; connection has been setup.
2835 "Like `start-file-process' for Tramp files."
2840 ;; BUFFER can be nil. We use a temporary buffer.
2842 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2843 ;; it might be that the arguments exceed the command line
2844 ;; length. Therefore, we modify the command.
2849 ;; When PROGRAM is nil, we just provide a tty.
2855 args
2859 ;; Use a human-friendly prompt, for example for `shell'.
2860 ;; We discard hops, if existing, that's why we cannot use
2861 ;; `file-remote-p'.
2864 tramp-initial-end-of-output))
2865 ;; We use as environment the difference to toplevel
2866 ;; `process-environment'.
2867 env uenv
2881 "unset %s &&"
2896 ;; We do not want to raise an error when
2897 ;; `start-file-process' has been started several times in
2898 ;; `eshell' and friends.
2899 tramp-current-connection
2900 ;; We do not want to run timers.
2901 timer-list timer-idle-list
2902 p)
2905 ;; NAME must be unique as process name.
2909 ;; Set the new process properties.
2915 ;; We catch this event. Otherwise, `start-process' could
2916 ;; be called on the local host.
2919 ;; Activate narrowing in order to save BUFFER
2920 ;; contents. Clear also the modification time;
2921 ;; otherwise we might be interrupted by
2922 ;; `verify-visited-file-modtime'.
2928 ;; We call `tramp-maybe-open-connection', in order
2929 ;; to cleanup the prompt afterwards.
2933 ;; Set the pid of the remote shell. This is
2934 ;; needed when sending signals remotely.
2941 ;; Now do it.
2943 ;; Send the command.
2945 ;; Check, whether a pty is associated.
2948 v 'file-error
2950 ;; Set query flag and process marker for this
2951 ;; process. We ignore errors, because the process
2952 ;; could have finished already.
2956 ;; Return process.
2957 p)))
2959 ;; Save exit.
2970 "Like `process-file' for Tramp files."
2971 ;; The implementation is not complete yet.
2977 ;; Compute command.
2980 ;; We use as environment the difference to toplevel `process-environment'.
2991 "env %s %s"
2996 "unset %s && %s"
2998 ;; Determine input.
3003 ;; INFILE is on the same remote host.
3005 ;; INFILE must be copied to remote host.
3007 tmpinput
3012 ;; Determine output.
3014 ;; Just a buffer.
3017 ;; A buffer name.
3020 ;; (REAL-DESTINATION ERROR-DESTINATION)
3022 ;; output.
3030 ;; stderr.
3035 ;; stderr is on the same remote host.
3038 ;; stderr must be copied to remote host. The temporary
3039 ;; file must be deleted after execution.
3042 method user domain host port stderr))))
3043 ;; stderr to be discarded.
3046 ;; 't
3051 ;; Send the command. It might not return in time, so we protect
3052 ;; it. Call it in a subshell, in order to preserve working
3053 ;; directory.
3060 command)
3061 t t)
3063 ;; We should add the output anyway.
3070 ;; When the user did interrupt, we should do it also. We use
3071 ;; return code -1 as marker.
3075 ;; Handle errors.
3080 ;; Provide error file.
3083 ;; Cleanup. We remove all file cache values for the connection,
3084 ;; because the remote process could have changed them.
3090 ;; Return exit status.
3093 ret))))
3096 "Like `file-local-copy' for Tramp files."
3100 v tramp-file-missing
3111 ;; `copy-file' handles direct copy and out-of-band methods.
3116 ;; Use inline encoding for file transfer.
3120 v 3
3122 filename rem-enc)
3129 tmpfile loc-dec)
3131 ;; If local decoding is a function, we call it.
3132 ;; We must disable multibyte, because
3133 ;; `uudecode-decode-region' doesn't handle it
3134 ;; correctly. Unset `file-name-handler-alist'.
3135 ;; Otherwise, epa-file gets confused.
3143 ;; If tramp-decoding-function is not defined for this
3144 ;; method, we invoke tramp-decoding-command instead.
3146 ;; Unset `file-name-handler-alist'. Otherwise,
3147 ;; epa-file gets confused.
3155 loc-dec tmpfile2 tmpfile)
3158 ;; Set proper permissions.
3160 ;; Set local user ownership.
3163 ;; Oops, I don't know what to do.
3167 ;; Error handling.
3173 tmpfile)))
3175 ;; CCC grok LOCKNAME
3178 "Like `write-region' for Tramp files."
3196 ;; `file-writable-p' calls `file-expand-file-name'. We
3197 ;; cannot use `tramp-run-real-handler' therefore.
3203 ;; Short track: if we are on the local host, we can run directly.
3208 ;; We use this to save the value of
3209 ;; `last-coding-system-used' after writing the tmp
3210 ;; file. At the end of the function, we set
3211 ;; `last-coding-system-used' to this saved value. This
3212 ;; way, any intermediary coding systems used while
3213 ;; talking to the remote shell or suchlike won't hose
3214 ;; this variable. This approach was snarfed from
3215 ;; ange-ftp.el.
3216 coding-system-used
3217 ;; Write region into a tmp file. This isn't really
3218 ;; needed if we use an encoding function, but currently
3219 ;; we use it always because this makes the logic
3220 ;; simpler. We must also set `temporary-file-directory',
3221 ;; because it could point to a remote directory.
3227 ;; If `append' is non-nil, we copy the file locally, and let
3228 ;; the native `write-region' implementation do the job.
3231 ;; We say `no-message' here because we don't want the
3232 ;; visited file modtime data to be clobbered from the temp
3233 ;; file. We call `set-visited-file-modtime' ourselves later
3234 ;; on. We must ensure that `file-coding-system-alist'
3235 ;; matches `tmpfile'.
3241 'write-region
3248 ;; Now, `last-coding-system-used' has the right value. Remember it.
3251 ;; The permissions of the temporary file should be set. If
3252 ;; FILENAME does not exist (eq modes nil) it has been
3253 ;; renamed to the backup file. This case `save-buffer'
3254 ;; handles permissions.
3255 ;; Ensure that it is still readable.
3258 tmpfile
3261 ;; This is a bit lengthy due to the different methods
3262 ;; possible for file transfer. First, we check whether the
3263 ;; method uses an scp program. If so, we call it.
3264 ;; Otherwise, both encoding and decoding command must be
3265 ;; specified. However, if the method _also_ specifies an
3266 ;; encoding function, then that is used for encoding the
3267 ;; contents of the tmp file.
3273 ;; `copy-file' handles direct copy and out-of-band methods.
3283 ;; We keep the local file for performance
3284 ;; reasons, useful for "rsync".
3291 ;; Don't rename, in order to keep context in SELinux.
3296 ;; Use inline file transfer.
3298 ;; Encode tmpfile.
3302 ;; Use encoding function or command.
3305 "Encoding local file `%s' using `%s'"
3306 tmpfile loc-enc)
3308 ;; The following `let' is a workaround for
3309 ;; the base64.el that comes with pgnus-0.84.
3310 ;; If both of the following conditions are
3311 ;; satisfied, it tries to write to a local
3312 ;; file in default-directory, but at this
3313 ;; point, default-directory is remote.
3314 ;; (`call-process-region' can't write to
3315 ;; remote files, it seems.) The file in
3316 ;; question is a tmp file anyway.
3324 loc-enc tmpfile t))
3326 v 'file-error
3329 filename loc-enc))))
3331 ;; Send buffer into remote decoding command which
3332 ;; writes to remote file. Because this happens on
3333 ;; the remote host, we cannot use the function.
3336 "Decoding remote file `%s' using `%s'"
3337 filename rem-dec)
3341 v
3345 tramp-end-of-heredoc
3347 tramp-end-of-heredoc))
3349 v nil
3350 "Couldn't write region to `%s', decode using `%s' failed"
3351 filename rem-dec)
3352 ;; When `file-precious-flag' is set, the region is
3353 ;; written to a temporary file. Check that the
3354 ;; checksum is equal to that from the local tmpfile.
3358 ;; cksum runs locally, if possible.
3360 ;; cksum runs remotely.
3362 v
3365 ;; ... they are different.
3372 v 'file-error
3375 filename rem-dec)))))
3377 ;; Save exit.
3380 ;; That's not expected.
3383 v 'file-error
3386 method))))
3388 ;; Make `last-coding-system-used' have the right value.
3395 ;; We must protect `last-coding-system-used', now we have set it
3396 ;; to its correct value.
3398 ;; Set file modification time.
3402 ;; We must pass modtime explicitly, because FILENAME can
3403 ;; be different from (buffer-file-name), f.e. if
3404 ;; `file-precious-flag' is set.
3410 ;; Set the ownership.
3421 ;; VC backends check for the existence of various different special
3422 ;; files. This is very time consuming, because every single check
3423 ;; requires a remote command (the file cache must be invalidated).
3424 ;; Therefore, we apply a kind of optimization. We install the file
3425 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3426 ;; remembers all file names for which `file-exists-p' or
3427 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3428 ;; is performed. Afterwards, a script is applied for all collected
3429 ;; file names, using just one remote command. The result of this
3430 ;; script is used to fill the file cache with actual values. Now we
3431 ;; can reset the file name handlers, and we make a second run of
3432 ;; `vc-registered', which returns the expected result without sending
3433 ;; any other remote command.
3435 "Like `vc-registered' for Tramp files."
3441 ;; There could be new files, created by the vc backend. We
3442 ;; cannot reuse the old cache entries, therefore. In
3443 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3444 ;; could also be a timestamp as `current-time' returns. This
3445 ;; means invalidate all cache entries with an older timestamp.
3451 ;; Here we collect only file names, which need an operation.
3453 v "Error in 1st pass of `vc-registered': %s"
3457 ;; Send just one command, in order to fill the cache.
3460 v
3469 ;; We cannot use `tramp-send-command-and-read',
3470 ;; because this does not cooperate well with
3471 ;; heredoc documents.
3473 v
3476 tramp-end-of-heredoc
3478 tramp-vc-registered-file-names
3480 tramp-end-of-heredoc))
3482 ;; Read the expression.
3489 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3490 ;; calls shall be answered from the file cache. We unset
3491 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3492 ;; in order to keep the cache.
3494 remote-file-name-inhibit-cache process-file-side-effects)
3495 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3514 ;; Run.
3516 v "Error in 2nd pass of `vc-registered': %s"
3519 ;;;###tramp-autoload
3521 "Invoke remote-shell Tramp file name handler.
3522 Fall back to normal file name handler if no Tramp handler exists."
3528 ;; This must be the last entry, because `identity' always matches.
3529 ;;;###tramp-autoload
3534 "Invoke special file name handler, which collects files to be handled."
3542 ;; That's what we want: file names, for which checks are
3543 ;; applied. We assume that VC uses only `file-exists-p' and
3544 ;; `file-readable-p' checks; otherwise we must extend the
3545 ;; list. We do not perform any action, but return nil, in
3546 ;; order to keep `vc-registered' running.
3549 nil)
3550 ;; `process-file' and `start-file-process' shall be ignored.
3553 ;; Tramp file name handlers like `expand-file-name'. They
3554 ;; must still work.
3556 ;; Default file name handlers, we don't care.
3560 "Like `file-notify-add-watch' for Tramp files."
3564 command events filter p sequence)
3566 ;; "inotifywait".
3569 events
3579 ;; Make events a list of symbols.
3580 events
3584 ;; "gio monitor".
3587 events
3591 attribute-changed))
3596 ;; "gvfs-monitor-dir".
3599 events
3603 attribute-changed))
3608 ;; None.
3610 v 'file-notify-error
3611 "No file notification program found on %s"
3613 ;; Start process.
3615 'start-file-process
3619 sequence))
3620 ;; Return the process object as watch-descriptor.
3623 v 'file-notify-error
3624 "`%s' failed to start on remote host"
3628 ;; Needed for process filter.
3633 ;; There might be an error if the monitor is not supported.
3634 ;; Give the filter a chance to read the output.
3639 p))))
3652 ;; Fix action names.
3659 ;; https://bugs.launchpad.net/bugs/1742946
3668 string)
3674 proc
3677 ;; File names are returned as absolute paths. We must
3678 ;; add the remote prefix.
3682 ;; Remove watch when file or directory to be watched is deleted.
3686 ;; Usually, we would add an Emacs event now. Unfortunately,
3687 ;; `unread-command-events' does not accept several events at
3688 ;; once. Therefore, we apply the handler directly.
3691 'file-notify-handle-event
3694 ;; Save rest of the string.
3701 file-notify events."
3711 ;; Attribute change is returned in unused wording.
3721 string)
3726 proc
3731 ;; File names are returned as absolute paths. We must
3732 ;; add the remote prefix.
3736 ;; Remove watch when file or directory to be watched is deleted.
3740 ;; Usually, we would add an Emacs event now. Unfortunately,
3741 ;; `unread-command-events' does not accept several events at
3742 ;; once. Therefore, we apply the handler directly.
3745 'file-notify-handle-event
3748 ;; Save rest of the string.
3758 ;; Check, whether there is a problem.
3763 line)
3768 proc
3775 ;; Remove watch when file or directory to be watched is deleted.
3778 ;; Usually, we would add an Emacs event now. Unfortunately,
3779 ;; `unread-command-events' does not accept several events at
3780 ;; once. Therefore, we apply the handler directly.
3783 'file-notify-handle-event
3787 "Like `file-system-info' for Tramp files."
3794 "%s --block-size=1 --output=size,used,avail %s"
3804 ;; The second value is the used size. We need the
3805 ;; free size.
3810 ;;; Internal Functions:
3813 "Define in remote shell function NAME implemented as SCRIPT.
3814 Only send the definition if it has not already been done."
3815 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3816 ;; might be nil.
3822 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3823 ;; could result in unwanted command expansion. Avoid this.
3826 ;; The script could contain a call of Perl. This is masked with `%s'.
3831 vec
3839 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3840 Returns the exit code of the `test' program."
3843 v
3845 "%s %s %s"
3847 switch
3851 "Run `test'-like program on the remote system, given FILE1, FILE2.
3852 FORMAT-STRING contains the program name, switches, and place holders.
3853 Returns the exit code of the `test' program. Barfs if the methods,
3854 hosts, or files, disagree."
3858 v 'file-error
3863 v1
3870 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3871 First arg VEC specifies the connection, PROGNAME is the program
3872 to search for, and DIRLIST gives the list of directories to
3873 search. If IGNORE-TILDE is non-nil, directory names starting
3874 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3875 only in DIRLIST.
3877 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3879 This function expects to be in the right *tramp* buffer."
3882 ;; Check whether the executable is in $PATH. "which(1)" does not
3883 ;; report always a correct error code; therefore we check the
3884 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3885 ;; 5.11") have problems with this command, we disable the call
3886 ;; therefore.
3897 ;; Remove all ~/foo directories from dirlist.
3906 vec
3908 "do if test -x $d/%s && test -f $d/%s; "
3909 "then echo tramp_executable $d/%s; "
3912 progname progname progname
3913 tramp-end-of-heredoc
3915 tramp-end-of-heredoc))
3921 result)))
3924 "Sets the remote environment PATH to existing directories.
3925 I.e., for each directory in `tramp-remote-path', it is tested
3926 whether it exists and if so, it is added to the environment
3927 variable PATH."
3933 ;; ------------------------------------------------------------
3934 ;; -- Communication with external shell --
3935 ;; ------------------------------------------------------------
3938 "Find a command on the remote host for checking if a file exists.
3939 Here, we are looking for a command which has zero exit status if the
3940 file exists and nonzero exit status otherwise."
3944 result)
3945 ;; The algorithm is as follows: we try a list of several commands.
3946 ;; For each command, we first run `$cmd /' -- this should return
3947 ;; true, as the root directory always exists. And then we run
3948 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3949 ;; does not exist. This should return false. We use the first
3950 ;; command we find that seems to work.
3951 ;; The list of commands to try is as follows:
3952 ;; `ls -d' This works on most systems, but NetBSD 1.4
3953 ;; has a bug: `ls' always returns zero exit
3954 ;; status, even for files which don't exist.
3955 ;; `test -e' Some Bourne shells have a `test' builtin
3956 ;; which does not know the `-e' option.
3957 ;; `/bin/test -e' For those, the `test' binary on disk normally
3958 ;; provides the option. Alas, the binary
3959 ;; is sometimes `/bin/test' and sometimes it's
3960 ;; `/usr/bin/test'.
3961 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3989 result))
3992 "Opens shell SHELL."
3995 ;; Find arguments for this shell.
3997 item extra-args)
4002 ;; It is useful to set the prompt in the following command
4003 ;; because some people have a setting for $PS1 which /bin/sh
4004 ;; doesn't know about and thus /bin/sh will display a strange
4005 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4006 ;; ksh will display the current working directory but /bin/sh
4007 ;; will display a dollar sign. The following command line sets
4008 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4009 ;; well as csh-like shells. We also unset the variable $ENV
4010 ;; because that is read by some sh implementations (eg, bash
4011 ;; when called as sh) on startup; this way, we avoid the startup
4012 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4013 ;; the prompt in /bin/bash, it must be discarded as well.
4014 ;; $HISTFILE is set according to `tramp-histfile-override'.
4015 ;; $TERM and $INSIDE_EMACS set here to ensure they have the
4016 ;; correct values when the shell starts, not just processes
4017 ;; run within the shell. (Which processes include our
4018 ;; initial probes to ensure the remote shell is usable.)
4022 "exec env TERM='%s' INSIDE_EMACS='%s,tramp:%s' "
4024 tramp-terminal-type
4025 emacs-version tramp-version ; INSIDE_EMACS
4031 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4035 t)
4036 ;; Check proper HISTFILE setting. We give up when not working.
4040 vec
4042 "(cd %s)"
4045 "`tramp-histfile-override' uses invalid file `%s'"
4046 tramp-histfile-override)))
4052 "Opens a shell on the remote host which groks tilde expansion."
4055 shell)
4058 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4059 ;; Which check could we apply instead?
4062 ;; The default shell (ksh93) of OpenSolaris and
4063 ;; Solaris is buggy. We've got reports for
4064 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4073 ;; Maybe it works at least for some other commands.
4075 default-shell
4077 vec 2
4079 "Couldn't find a remote shell which groks tilde "
4081 default-shell)))
4083 default-shell)))
4085 ;; Open a new shell if needed.
4091 ;; Utility functions.
4094 "Wait for shell prompt and barf if none appears.
4095 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4096 seconds. If not, it produces an error message with the given ERROR-ARGS."
4100 proc timeout
4109 "Set up an interactive shell.
4110 Mainly sets the prompt and the echo correctly. PROC is the shell
4111 process to set up. VEC specifies the connection."
4116 ;; Disable echo expansion.
4120 ;; Check whether the echo has really been disabled. Some
4121 ;; implementations, like busybox of embedded GNU/Linux, don't
4122 ;; support disabling.
4129 ;; Make sure backspaces and their echo are enabled and no line
4130 ;; width magic interferes with them.
4137 t)
4139 ;; Check whether the output of "uname -sr" has been changed. If
4140 ;; yes, this is a strong indication that we must expire all
4141 ;; connection properties. We start again with
4142 ;; `tramp-maybe-open-connection', it will be caught there.
4147 vec "uname"
4151 vec 3
4152 "Connection reset, because remote host changed from `%s' to `%s'"
4153 old-uname uname)
4154 ;; We want to keep the password.
4158 ;; Try to set up the coding system correctly.
4159 ;; CCC this can't be the right way to do it. Hm.
4162 ;; Use MULE to select the right EOL convention for communicating
4163 ;; with the process.
4169 cs-decode cs-encode)
4173 cs-encode
4180 ;; Special setting for macOS.
4191 ;; Check whether the remote host suffers from buggy
4192 ;; `send-process-string'. This is known for FreeBSD (see comment
4193 ;; in `send_process', file process.c). I've tested sending 624
4194 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4195 ;; hack when this host type is detected locally. It cannot handle
4196 ;; remote hosts, though.
4200 tramp-chunksize)
4206 ;; Set remote PATH variable.
4209 ;; Search for a good shell before searching for a command which
4210 ;; checks if a file exists. This is done because Tramp wants to
4211 ;; use "test foo; echo $?" to check if various conditions hold,
4212 ;; and there are buggy /bin/sh implementations which don't execute
4213 ;; the "echo $?" part if the "test" part has an error. In
4214 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4215 ;; also other problems with /bin/sh of OpenSolaris, like
4216 ;; redirection of stderr in function declarations, or changing
4217 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4218 ;; by bash, when detected.
4221 ;; Disable unexpected output.
4224 ;; IRIX64 bash expands "!" even when in single quotes. This
4225 ;; destroys our shell functions, we must disable it. See
4226 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4230 ;; Disable tab expansion.
4235 ;; Set utf8 encoding. Needed for macOS, for example. This is
4236 ;; non-POSIX, so we must expect errors on some systems.
4239 ;; Set `remote-tty' process property.
4245 ;; Dump stty settings in the traces.
4249 ;; Set the environment.
4263 vec
4266 tramp-end-of-heredoc
4268 tramp-end-of-heredoc)
4269 t))
4274 ;; Old text from documentation of tramp-methods:
4275 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4276 ;; of the base64 methods instead since base64 encoding is much more
4277 ;; reliable and the commands are more standardized between the different
4278 ;; Unix versions. But if you can't use base64 for some reason, please
4279 ;; note that the default uudecode command does not work well for some
4280 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4281 ;; the following command for uudecode:
4282 ;;
4283 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4284 ;;
4285 ;; For Irix, no solution is known yet.
4293 "List of local coding commands for inline transfer.
4294 Each item is a list that looks like this:
4296 \(FORMAT ENCODING DECODING)
4298 FORMAT is symbol describing the encoding/decoding format. It can be
4299 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4301 ENCODING and DECODING can be strings, giving commands, or symbols,
4302 giving functions. If they are strings, then they can contain
4304 file name will be put into the command line at that spot. If the
4305 specifier is not present, the input should be read from standard
4306 input.
4308 If they are functions, they will be called with two arguments, start
4309 and end of region, and are expected to replace the region contents
4314 ;; "-i" is more robust with older base64 from GNU coreutils.
4315 ;; However, I don't know whether all base64 versions do supports
4316 ;; this option.
4324 ;; This is painful slow, so we put it on the end.
4331 "List of remote coding commands for inline transfer.
4332 Each item is a list that looks like this:
4334 \(FORMAT ENCODING DECODING [TEST])
4336 FORMAT is a symbol describing the encoding/decoding format. It can be
4337 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4339 ENCODING and DECODING can be strings, giving commands, or symbols,
4340 giving variables. If they are strings, then they can contain
4342 file name will be put into the command line at that spot. If the
4343 specifier is not present, the input should be read from standard
4344 input.
4346 If they are variables, this variable is a string containing a
4347 Perl or Shell implementation for this functionality. This
4348 program will be transferred to the remote host, and it is
4350 specifier in the variable value denotes a temporary file.
4352 The optional TEST command can be used for further tests, whether
4356 "Find an inline transfer encoding that works.
4357 Goes through the list `tramp-local-coding-commands' and
4358 `tramp-remote-coding-commands'."
4363 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4371 ;; If the local encoder or decoder is a string, the
4372 ;; corresponding command has to work locally.
4379 loc-enc nil nil))
4387 loc-dec nil nil))
4389 ;; Search for remote coding commands with the same format
4397 ;; Check the remote test command if exists.
4403 ;; Check if remote perl exists when necessary.
4408 ;; Check if remote encoding and decoding commands can be
4409 ;; called remotely with null input and output. This makes
4410 ;; sure there are no syntax errors and the command is really
4411 ;; found. Note that we do not redirect stdout to /dev/null,
4412 ;; for two reasons: when checking the decoding command, we
4413 ;; actually check the output it gives. And also, when
4414 ;; redirecting "mimencode" output to /dev/null, then as root
4415 ;; it might change the permissions of /dev/null!
4423 vec 5
4432 tmpfile)
4439 tramp-temp-name-prefix
4441 value
4443 value
4445 ?t
4450 vec 5
4453 vec
4455 t)
4463 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4469 ;; Set connection properties. Since the commands are risky
4470 ;; (due to output direction), we cache them in the process cache.
4481 "Call the local encoding or decoding command.
4483 Otherwise, INPUT is passed via standard input.
4484 INPUT can also be nil which means `/dev/null'.
4485 OUTPUT can be a string (which specifies a file name), or t (which
4486 means standard output and thus the current buffer), or nil (which
4487 means discard it)."
4489 nil tramp-encoding-shell
4492 nil
4493 tramp-encoding-command-switch
4503 "List of compress and decompress commands for inline transfer.
4504 Each item is a list that looks like this:
4506 \(COMPRESS DECOMPRESS)
4511 "Find an inline transfer compress command that works.
4512 Goes through the list `tramp-inline-compress-commands'."
4517 item compress decompress found)
4524 vec 5
4525 "Checking local compress commands `%s', `%s' for sanity"
4526 compress decompress)
4531 "echo %s | %s | %s" magic
4532 ;; Windows shells need the program file name after
4533 ;; the pipe symbol be quoted if they use forward
4534 ;; slashes as directory separators.
4539 nil nil))
4542 vec 5
4543 "Checking remote compress commands `%s', `%s' for sanity"
4544 compress decompress)
4550 ;; Did we find something?
4553 ;; Set connection properties. Since the commands are
4554 ;; risky (due to output direction), we cache them in the
4555 ;; process cache.
4569 "Expands VEC according to `tramp-default-proxies-alist'."
4573 choices proxy)
4575 ;; Ad-hoc proxy definitions.
4580 tramp-prefix-format proxy tramp-postfix-host-format)))
4585 proxy)
4586 ;; Add the hop.
4588 'tramp-default-proxies-alist
4591 proxy))
4593 ;; Save the new value.
4598 ;; Look for proxy hosts to be passed.
4604 ;; Host.
4607 ;; User.
4611 ;; No more hops needed.
4613 ;; Replace placeholders.
4616 proxy
4621 ;; Add the hop.
4623 ;; Start next search.
4626 ;; Foreign and out-of-band methods are not supported for multi-hops.
4633 vec 'file-error
4634 "Method `%s' is not supported for multi-hops."
4637 ;; In case the host name is not used for the remote shell
4638 ;; command, the user could be misguided by applying a random
4639 ;; host name.
4645 ;; There are multi-hops.
4647 ;; The host name is used for the remote shell command.
4649 ;; The host is local. We cannot use `tramp-local-host-p'
4650 ;; here, because it opens a connection as well.
4653 v 'file-error
4654 "Host `%s' looks like a remote host, `%s' can only use the local host"
4655 host method)))
4657 ;; Result.
4658 target-alist))
4661 "Return the Control* arguments of the local ssh."
4663 ;; No options to be computed.
4668 ;; There is already a value to be used.
4671 ;; Determine the options.
4686 ;; We use a non-existing IP address, in order to
4687 ;; avoid useless connections, and DNS timeouts.
4688 ;; Setting ConnectTimeout is needed since OpenSSH 7.
4690 vec "ssh" nil t nil
4696 " -o ControlPath='tramp.%%r@%%h:%%p'"
4705 tramp-ssh-controlmaster-options)))
4708 "Maybe open a connection VEC.
4709 Does not do anything if a connection is already open, but re-opens the
4710 connection if a previous connection has died for some reason."
4716 ;; If Tramp opens the same connection within a short time frame,
4717 ;; there is a problem. We shall signal this.
4726 ;; If too much time has passed since last command was sent, look
4727 ;; whether process is still alive. If it isn't, kill it. When
4728 ;; using ssh, it can sometimes happen that the remote end has hung
4729 ;; up but the local ssh client doesn't recognize this until it
4730 ;; tries to send some data to the remote end. So that's why we
4731 ;; try to send a command from time to time, then look again
4732 ;; whether the process is really alive.
4743 ;; The error will be caught locally.
4749 ;; New connection must be opened.
4753 ;; During completion, don't reopen a new connection. We
4754 ;; check this for the process related to
4755 ;; `tramp-buffer-name'; otherwise `start-file-process'
4756 ;; wouldn't run ever when `non-essential' is non-nil.
4762 vec 3
4773 ;; Start new process.
4791 ;; We will apply `tramp-ssh-controlmaster-options'
4792 ;; only for the first hop.
4796 ;; There are unfortunate settings for "cmdproxy" on
4797 ;; W32 systems.
4800 ;; This must be done in order to avoid our file
4801 ;; name handler.
4805 'start-process
4810 tramp-encoding-command-interactive)
4813 ;; Set sentinel and query flag. Initialize variables.
4823 ;; Check whether process is alive.
4825 p 10
4828 ;; Now do all the connections as specified.
4848 ;; We don't create the temporary file. In
4849 ;; fact, it is just a prefix for the
4850 ;; ControlPath option of ssh; the real
4851 ;; temporary file has another name, and it is
4852 ;; created and protected by ssh. It is also
4853 ;; removed by ssh when the connection is
4854 ;; closed. The temporary file name is cached
4855 ;; in the main connection process, therefore
4856 ;; we cannot use `tramp-get-connection-process'.
4862 tramp-temp-name-prefix
4864 spec r-shell)
4866 ;; Add arguments for asynchronous processes.
4870 ;; Check, whether there is a restricted shell.
4876 ;; Set password prompt vector.
4878 p "password-vector"
4883 ;; Add login environment.
4886 login-env
4891 login-env))
4895 "%s=%s %s"
4898 command)))
4901 ;; Replace `login-args' place holders.
4909 ?h l-host ?u l-user ?p l-port ?c options)
4910 command
4912 ;; We do not want to see the trailing local
4913 ;; prompt in `start-file-process'.
4915 command " "
4921 ;; Local shell could be a Windows COMSPEC. It
4922 ;; doesn't know the ";" syntax, but we must exit
4923 ;; always for `start-file-process'. It could
4924 ;; also be a restricted shell, which does not
4925 ;; allow "exec".
4928 ;; Send the command.
4932 p vec
4935 tramp-actions-before-shell
4939 ;; Next hop.
4943 ;; Set connection-local variables.
4946 ;; Make initial shell settings.
4949 ;; Mark it as connected.
4952 ;; Cleanup, and propagate the signal.
4958 "Send the COMMAND to connection VEC.
4959 Erases temporary buffer before sending the command. If optional
4960 arg NEVEROPEN is non-nil, never try to open the connection. This
4961 is meant to be used from `tramp-maybe-open-connection' only. The
4962 function waits for output unless NOOUTPUT is set."
4966 ;; We mark the command string that it can be erased in the output buffer.
4968 ;; If we put `tramp-echo-mark' after a trailing newline (which
4969 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4970 ;; that newline and adds `tramp-rsh-end-of-line' right after
4971 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4972 ;; trailing line endings and sends two prompts after executing
4973 ;; the command, which confuses `tramp-wait-for-output'.
4977 ;; No need to restore a trailing newline here since `tramp-send-string'
4978 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4980 ;; Send the command.
4986 "Wait for output from remote command."
4992 ;; be leading escape sequences, which must be ignored.
4993 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4994 ;; option send also escape sequences, which must be
4995 ;; ignored.
4998 tramp-device-escape-sequence-regexp))
4999 ;; Sometimes, the commands do not return a newline but a
5000 ;; null byte before the shell prompt, for example "git
5001 ;; ls-files -c -z ...".
5006 ;; A simple-minded busybox has sent " ^H" sequences.
5007 ;; Delete them.
5012 ;; Delete the prompt.
5018 proc 'file-error
5019 "[[Remote prompt `%s' not found in %d secs]]"
5020 tramp-end-of-output timeout)
5022 proc 'file-error
5024 ;; Return value is whether end-of-output sentinel was found.
5025 found)))
5029 "Run COMMAND and check its exit status.
5030 Sends `echo $?' along with the COMMAND for checking the exit status.
5031 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5032 status is 0, and nil otherwise.
5034 If the optional argument SUBSHELL is non-nil, the command is
5035 executed in a subshell, ie surrounded by parentheses. If
5036 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5038 vec
5040 command
5042 "echo tramp_exit_status $?"
5056 "Run COMMAND, check exit status, throw error if exit status not okay.
5057 Similar to `tramp-send-command-and-check' but accepts two more arguments
5058 FMT and ARGS which are passed to `error'."
5063 "Run COMMAND and return the output, which must be a Lisp expression.
5064 If MARKER is a regexp, read the output after that string.
5065 In case there is no valid Lisp expression and NOERROR is nil, it
5066 raises an error."
5073 ;; Read the marker.
5079 vec 'file-error
5080 "`%s' does not return the marker `%s': `%s'"
5082 ;; Read the expression.
5085 ;; Error handling.
5090 vec 'file-error
5091 "`%s' does not return a valid Lisp expression: `%s'"
5095 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5096 Convert file mode bits to string and set virtual device number.
5097 Return ATTR."
5099 ;; Remove color escape sequences from symlink.
5103 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5104 ;; indication of unusable value.
5115 ;; Convert last access time.
5120 ;; Convert last modification time.
5125 ;; Convert last status change time.
5130 ;; Convert file size.
5136 ;; Convert file mode bits to string.
5141 ;; Convert directory indication bit.
5144 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5150 ;; Set file's gid change bit.
5158 ;; Convert inode.
5163 middle low)
5166 ;; The low 16 bits.
5171 ;; The middle 24 bits.
5175 ;; Inodes can be incredible huge. We must hide this.
5177 ;; Set virtual device number.
5180 attr))
5183 "Converts STRING to shell glob pattern which ignores case."
5189 string
5193 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5205 localname)
5211 "Return t if this is an out-of-band method, nil otherwise."
5213 ;; It shall be an out-of-band method.
5215 ;; There must be a size, otherwise the file doesn't exist.
5217 ;; Either the file size is large enough, or (in rare cases) there
5218 ;; does not exist a remote encoding.
5223 ;; Variables local to connection.
5226 "Compile list of remote directories for $PATH.
5227 Nonexistent directories are removed from spec."
5229 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5230 ;; cache the result for the session only. Otherwise, the result
5231 ;; is cached persistently.
5234 vec)
5235 "remote-path"
5244 ;; Default if "getconf" is not available.
5247 vec 3
5252 ;; The login shell could return more than just the $PATH
5253 ;; string. So we use `tramp-end-of-heredoc' as marker.
5257 vec
5262 'identity
5266 'identity
5274 nil)))))
5276 ;; Replace place holder `tramp-default-remote-path'.
5284 ;; Replace place holder `tramp-own-remote-path'.
5292 ;; Remove double entries.
5299 ;; Remove non-existing directories.
5301 nil
5307 x))
5308 remote-path)))))
5311 "Determine remote locale, supporting UTF8 if possible."
5315 locale)
5322 candidates nil)
5324 ;; Return value.
5328 "Determine remote `ls' command."
5335 result)
5337 ;; Check parameters. On busybox, "ls" output coloring is
5338 ;; enabled by default sometimes. So we try to disable it
5339 ;; when possible. $LS_COLORING is not supported there.
5340 ;; Some "ls" versions are sensible wrt the order of
5341 ;; arguments, they fail when "-al" is after the
5342 ;; "--color=never" argument (for example on FreeBSD).
5354 "Check, whether the remote `ls' command supports the --dired option."
5358 ;; Some "ls" versions are sensible wrt the order of arguments,
5359 ;; they fail when "-al" is after the "--dired" argument (for
5360 ;; example on FreeBSD).
5365 "Check, whether the remote `ls' command supports the --quoting-style option."
5374 "Check, whether the remote `ls' command supports the -w option."
5378 ;; Option "-w" is available on BSD systems. No argument is
5379 ;; given, because this could return wrong results in case "ls"
5380 ;; supports the "-w NUM" argument, as for busyboxes.
5385 "Determine remote `test' command."
5389 "test"
5393 "Check, whether the remote `test' command supports the -nt option."
5394 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5395 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5396 ;; for otherwise the shell crashes.
5408 vec
5415 "Determine remote command for file existing check."
5421 "Determine remote `ln' command."
5427 "Determine remote `perl' command."
5433 ;; Perform a basic check.
5438 ;; We must check also for some Perl modules.
5446 result)))
5449 "Determine remote `stat' command."
5454 tmp)
5455 ;; Check whether stat(1) returns usable syntax. "%s" does not
5456 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5457 ;; use shell quoted format for "%N", we check the boundaries "`"
5458 ;; and "'", therefore. See Bug#23422 in coreutils.
5459 ;; Since GNU stat 8.26, environment variable QUOTING_STYLE is
5460 ;; supported.
5469 result)))
5472 "Determine remote `readlink' command."
5480 result))))
5483 "Determine remote `trash' command.
5484 This command is returned only if `delete-by-moving-to-trash' is non-nil."
5491 "Determine remote `touch' command."
5500 ;; Busyboxes do support the "-t" option only when they have been
5501 ;; built with the DESKTOP config option. Let's check it.
5504 vec "touch-t"
5506 vec
5508 "%s -t %s %s"
5509 result
5513 result)))
5516 "Determine remote `df' command."
5521 result
5524 result))))
5527 "Determine remote `gio-monitor' command."
5533 "Determine remote `gvfs-monitor-dir' command."
5536 ;; We distinguish "gvfs-monitor-dir.exe" from cygwin in order to
5537 ;; establish better timeouts in filenotify-tests.el. Any better
5538 ;; distinction approach would be welcome!
5545 "Determine remote `inotifywait' command."
5551 "Determine remote `id' command."
5557 result)
5559 ;; Check POSIX parameter.
5565 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5567 vec
5575 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5577 vec
5581 "print $>"
5585 "Determine remote `python' command."
5593 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5595 vec
5599 "import os; print (os.getuid())"
5603 "The uid of the remote connection VEC, in ID-FORMAT.
5604 ID-FORMAT valid values are `string' and `integer'."
5615 ;; Ensure there is a valid result.
5618 tramp-unknown-id-integer)
5620 tramp-unknown-id-string)
5624 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5626 vec
5634 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5636 vec
5644 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5646 vec
5650 "import os; print (os.getgid())"
5654 "The gid of the remote connection VEC, in ID-FORMAT.
5655 ID-FORMAT valid values are `string' and `integer'."
5666 ;; Ensure there is a valid result.
5669 tramp-unknown-id-integer)
5671 tramp-unknown-id-string)
5675 "Check, whether the remote `env' command supports the -u option."
5678 ;; Option "-u" is a GNU extension.
5682 ;; Some predefined connection properties.
5684 "Return the compress command related to PROP.
5685 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5686 the length of the file to be compressed.
5688 If no corresponding command is found, nil is returned."
5697 "Return the coding command related to PROP.
5698 PROP is either `remote-encoding', `remote-decoding',
5699 `local-encoding' or `local-decoding'.
5701 SIZE is the length of the file to be coded. Depending on SIZE,
5702 compression might be applied.
5704 If no corresponding command is found, nil is returned.
5705 Otherwise, either a string is returned which contains a `%s' mark
5706 to be used for the respective input or output file; or a Lisp
5707 function cell is returned to be applied on a buffer."
5708 ;; We must catch the errors, because we want to return nil, when
5709 ;; no inline coding is found.
5719 compress)
5720 ;; The connection property might have been cached. So we must
5721 ;; send the script to the remote side - maybe.
5729 ;; Check for the `compress' command.
5731 ;; Return the value.
5752 coding)
5755 ;; Windows shells need the program file name after
5756 ;; the pipe symbol be quoted if they use forward
5757 ;; slashes as directory separators.
5764 coding compress))
5767 ;; Windows shells need the program file name after
5768 ;; the pipe symbol be quoted if they use forward
5769 ;; slashes as directory separators.
5774 compress coding))
5788 ;;; TODO:
5790 ;; * Don't use globbing for directories with many files, as this is
5791 ;; likely to produce long command lines, and some shells choke on
5792 ;; long command lines.
5793 ;;
5794 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5795 ;; then look if it's the right version (with `perl -v').
5796 ;;
5797 ;; * When editing a remote CVS controlled file as a different user, VC
5798 ;; gets confused about the file locking status. Try to find out why
5799 ;; the workaround doesn't work.
5800 ;;
5801 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5802 ;; until the last but one hop via `start-file-process'. Apply it
5803 ;; also for ftp and smb.
5804 ;;
5805 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5806 ;; some shell with root privileges, it would be nice if I could
5807 ;; just call
5808 ;; trampclient filename.c
5809 ;; as an editor, and the _current_ shell would connect to an Emacs
5810 ;; server and would be used in an existing non-privileged Emacs
5811 ;; session for doing the editing in question.
5812 ;; That way, I need not tell Emacs my password again and be afraid
5813 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5814 ;; once display a just typed password in the context of a keyboard
5815 ;; sequence prompt for a question immediately following in a shell
5816 ;; script run within Emacs -- nasty).
5817 ;; And if I have some ssh session running to a different computer,
5818 ;; having the possibility of passing a local file there to a local
5819 ;; Emacs session (in case I can arrange for a connection back) would
5820 ;; be nice.
5821 ;; Likely the corresponding Tramp server should not allow the
5822 ;; equivalent of the emacsclient -eval option in order to make this
5823 ;; reasonably unproblematic. And maybe trampclient should have some
5824 ;; way of passing credentials, like by using an SSL socket or
5825 ;; something. (David Kastrup)
5826 ;;
5827 ;; * Reconnect directly to a compliant shell without first going
5828 ;; through the user's default shell. (Pete Forman)
5829 ;;
5830 ;; * Avoid the local shell entirely for starting remote processes. If
5831 ;; so, I think even a signal, when delivered directly to the local
5832 ;; SSH instance, would correctly be propagated to the remote process
5833 ;; automatically; possibly SSH would have to be started with
5834 ;; "-t". (Markus Triska)
5835 ;;
5836 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5837 ;; isn't on the remote host. (Mark A. Hershberger)
5838 ;;
5839 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5840 ;;
5841 ;; * Optimize out-of-band copying when both methods are scp-like (not
5842 ;; rsync).
5843 ;;
5844 ;; * Keep a second connection open for out-of-band methods like scp or
5845 ;; rsync.
5846 ;;
5847 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5848 ;;
5849 ;; * I think you could get the best of both worlds by using an
5850 ;; approach similar to Tramp but running a little tramp-daemon on
5851 ;; the other end, such that we can use a more efficient
5852 ;; communication protocol (e.g. when saving a file we could locally
5853 ;; diff it against the last version (of which the remote daemon
5854 ;; would also keep a copy), and then only send the diff).
5855 ;;
5856 ;; This said, even using such a daemon it might be difficult to get
5857 ;; good performance: part of the problem is the number of
5858 ;; round-trips. E.g. when saving a file we have to check if the
5859 ;; file was modified in the mean time and whether saving into a new
5860 ;; inode would change the owner (etc...), which each require a
5861 ;; round-trip. To get rid of these round-trips, we'd have to
5862 ;; shortcut this code and delegate the higher-level "save file"
5863 ;; operation to the remote server, which then has to perform those
5864 ;; tasks but still obeying the locally set customizations about how
5865 ;; to do each one of those tasks.
5866 ;;
5867 ;; We could either put higher-level ops in there (like
5868 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5869 ;; behavior, which is a lot of work and likely to be not 100%
5870 ;; faithful.
5871 ;;
5872 ;; Or we could introduce new low-level ops that are asynchronous,
5873 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5874 ;; start with a bunch of calls like `start-getting-file-attributes'
5875 ;; which could immediately be passed on to the remote side, and
5876 ;; later on checks the return value of those calls as and when
5877 ;; needed. (Stefan Monnier)
5879 ;;; tramp-sh.el ends here