| blob | a2949f1f204d7f8549e83cdff6bbab2899b29f62 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2016 Free Software Foundation, Inc.
5 ;; (copyright statements below in code to be updated with the above notice)
7 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Keywords: comm, processes
10 ;; Package: tramp
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Code:
31 ;; Pacify byte-compiler.
42 ;;;###tramp-autoload
44 "The minimum size of compressing where inline transfer.
45 When inline transfer, compress transferred data of file
46 whose size is this value or above (up to `tramp-copy-size-limit').
47 If it is nil, no compression at all will be applied."
52 ;;;###tramp-autoload
54 "The maximum file size where inline copying is preferred over an \
55 out-of-the-band copy.
56 If it is nil, out-of-the-band copy will be used without a check."
61 ;;;###tramp-autoload
63 "Value of TERM environment variable for logging in to remote host.
64 Because Tramp wants to parse the output of the remote shell, it is easily
65 confused by ANSI color escape sequences and suchlike. Often, shell init
66 files conditionalize this setup based on the TERM environment variable."
71 ;;;###tramp-autoload
73 "When invoking a shell, override the HISTFILE with this value.
74 When setting to a string, it redirects the shell history to that
78 The value t unsets any setting of HISTFILE, and sets both
79 HISTFILESIZE and HISTSIZE to 0. If you set this variable to nil,
80 however, the *override* is disabled, so the history will go to
89 ;;;###tramp-autoload
93 ;;;###tramp-autoload
97 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
98 ;; root users. It uses the `$' character for other users. In order
99 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
103 "///%s#$"
105 "String used to recognize end of output.
106 The `$' character at the end is quoted; the string cannot be
109 ;;;###tramp-autoload
116 ;;;###tramp-autoload
118 "Whether to use `tramp-ssh-controlmaster-options'."
125 "Which ssh Control* arguments to use.
127 If it is a string, it should have the form
130 spec must be doubled, because the string is used as format string.
132 Otherwise, it will be auto-detected by Tramp, if
133 `tramp-use-ssh-controlmaster-options' is non-nil. The value
134 depends on the installed local ssh version.
138 ;; Initialize `tramp-methods' with the supported methods.
139 ;;;###tramp-autoload
151 ;;;###tramp-autoload
162 ;;;###tramp-autoload
180 ;;;###tramp-autoload
199 ;;;###tramp-autoload
215 ;;;###tramp-autoload
223 ;;;###tramp-autoload
231 ;;;###tramp-autoload
245 ;;;###tramp-autoload
259 ;;;###tramp-autoload
268 ;;;###tramp-autoload
277 ;; We use "-v" for better error tracking.
280 ;; We use "-p" as required for newer busyboxes. For older
281 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
282 ;; can be achieved by tweaking `tramp-connection-properties'.
285 ;;;###tramp-autoload
294 ;;;###tramp-autoload
296 'tramp-methods
303 ;;;###tramp-autoload
307 ;; The password template must be masked. Otherwise, it could be
308 ;; interpreted as password prompt if the remote host echoes the command.
311 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
317 ;;;###tramp-autoload
325 ;;;###tramp-autoload
334 ;;;###tramp-autoload
342 ;;;###tramp-autoload
346 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
350 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
351 tramp-terminal-type
352 tramp-initial-end-of-output))
358 ;;;###tramp-autoload
364 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
365 tramp-terminal-type
366 tramp-initial-end-of-output))
371 ;;;###tramp-autoload
378 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
379 tramp-terminal-type
380 tramp-initial-end-of-output))
391 ;;;###tramp-autoload
398 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
399 tramp-terminal-type
400 tramp-initial-end-of-output))
409 ;;;###tramp-autoload
421 ;;;###tramp-autoload
425 ;;;###tramp-autoload
429 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
430 ;; Do not add "plink" based methods, they ask interactively for the user.
431 ;;;###tramp-autoload
440 ;;;###tramp-autoload
446 ;;;###tramp-autoload
462 ;;;###tramp-autoload
467 ;;;###tramp-autoload
472 ;;;###tramp-autoload
477 ;;;###tramp-autoload
485 ;;;###tramp-autoload
514 ;; "getconf PATH" yields:
515 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
516 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
517 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
518 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
519 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
520 ;; IRIX64: /usr/bin
521 ;; QNAP QTS: ---
522 ;;;###tramp-autoload
528 "List of directories to search for executables on remote host.
529 For every remote host, this variable will be set buffer local,
530 keeping the list of existing directories on that host.
532 You can use `~' in this list, but when searching for a shell which groks
533 tilde expansion, all directory names starting with `~' will be ignored.
535 `Default Directories' represent the list of directories given by
537 entry on head of this list, because these are the default
538 directories for POSIX compatible commands. On remote hosts which
539 do not offer the getconf command (like cygwin), the value
541 the list by the special value `tramp-default-remote-path'.
543 `Private Directories' are the settings of the $PATH environment,
544 as given in your `~/.profile'. This entry is represented in
545 the list by the special value `tramp-own-remote-path'."
553 ;;;###tramp-autoload
560 "List of environment variables to be set on the remote host.
562 Each element should be a string of the form ENVVARNAME=VALUE. An
563 entry ENVVARNAME= disables the corresponding environment variable,
564 which might have been set in the init files like ~/.profile.
566 Special handling is applied to the PATH environment, which should
567 not be set here. Instead, it should be set via `tramp-remote-path'."
573 ;;;###tramp-autoload
575 "Alist specifying extra arguments to pass to the remote shell.
576 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
577 matching the shell file name and ARGS is a string specifying the
578 arguments.
580 This variable is only used when Tramp needs to start up another shell
581 for tilde expansion. The extra arguments should typically prevent the
582 shell from reading its init file."
584 ;; This might be the wrong way to test whether the widget type
585 ;; `alist' is available. Who knows the right way to test it?
601 "List of pattern/action pairs.
602 Whenever a pattern matches, the corresponding action is performed.
603 Each item looks like (PATTERN ACTION).
605 The PATTERN should be a symbol, a variable. The value of this
606 variable gives the regular expression to search for. Note that the
608 appended to it.
610 The ACTION should also be a symbol, but a function. When the
618 "List of pattern/action pairs.
619 This list is used for copying/renaming with out-of-band methods.
624 "(echo begin 600 %t; tail -n +2) | uudecode
625 cat %t
626 rm -f %t"
627 "Shell function to implement `uudecode' to standard output.
628 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
629 for this or `uudecode -p', but some systems don't, and for them
633 "%s -e '
634 use File::Spec;
637 sub myrealpath {
638 my ($file) = @_;
639 return realpath($file) if -e $file;
640 }
642 sub recursive {
643 my ($volume, @dirs) = @_;
644 my $real = myrealpath(File::Spec->catpath(
646 if ($real) {
647 my ($vol, $dir) = File::Spec->splitpath($real, 1);
648 return ($vol, File::Spec->splitdir($dir));
649 }
650 else {
651 my $last = pop(@dirs);
652 ($volume, @dirs) = recursive($volume, @dirs);
653 push(@dirs, $last);
654 return ($volume, @dirs);
655 }
656 }
658 $result = myrealpath($ARGV[0]);
659 if (!$result) {
660 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
661 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
664 }
669 "Perl script to produce output suitable for use with `file-truename'
670 on the remote file system.
671 Escape sequence %s is replaced with name of Perl binary.
675 "%s -e '
677 @files = readdir(d); closedir(d);
678 foreach $f (@files) {
681 }
682 else {
684 }
685 }
688 "Perl script to produce output suitable for use with
689 `file-name-all-completions' on the remote file system. Escape
690 sequence %s is replaced with name of Perl binary. This string is
693 ;; Perl script to implement `file-attributes' in a Lisp `read'able
694 ;; output. If you are hacking on this, note that you get *no* output
695 ;; unless this spits out a complete line, including the '\n' at the
696 ;; end.
697 ;; The device number is returned as "-1", because there will be a virtual
698 ;; device number set in `tramp-sh-handle-file-attributes'.
700 "%s -e '
701 @stat = lstat($ARGV[0]);
702 if (!@stat) {
704 exit 0;
705 }
706 if (($stat[2] & 0170000) == 0120000)
707 {
708 $type = readlink($ARGV[0]);
711 }
712 elsif (($stat[2] & 0170000) == 040000)
713 {
715 }
716 else
717 {
719 };
722 printf(
724 $type,
725 $stat[3],
726 $uid,
727 $gid,
728 $stat[8] >> 16 & 0xffff,
729 $stat[8] & 0xffff,
730 $stat[9] >> 16 & 0xffff,
731 $stat[9] & 0xffff,
732 $stat[10] >> 16 & 0xffff,
733 $stat[10] & 0xffff,
734 $stat[7],
735 $stat[2],
736 $stat[1] >> 16 & 0xffff,
737 $stat[1] & 0xffff
739 "Perl script to produce output suitable for use with `file-attributes'
740 on the remote file system.
741 Escape sequence %s is replaced with name of Perl binary.
745 "%s -e '
748 @list = readdir(DIR);
749 closedir(DIR);
750 $n = scalar(@list);
752 for($i = 0; $i < $n; $i++)
753 {
754 $filename = $list[$i];
755 @stat = lstat($filename);
756 if (($stat[2] & 0170000) == 0120000)
757 {
758 $type = readlink($filename);
761 }
762 elsif (($stat[2] & 0170000) == 040000)
763 {
765 }
766 else
767 {
769 };
773 printf(
774 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
775 $filename,
776 $type,
777 $stat[3],
778 $uid,
779 $gid,
780 $stat[8] >> 16 & 0xffff,
781 $stat[8] & 0xffff,
782 $stat[9] >> 16 & 0xffff,
783 $stat[9] & 0xffff,
784 $stat[10] >> 16 & 0xffff,
785 $stat[10] & 0xffff,
786 $stat[7],
787 $stat[2],
788 $stat[1] >> 16 & 0xffff,
789 $stat[1] & 0xffff,
790 $stat[0] >> 16 & 0xffff,
791 $stat[0] & 0xffff);
792 }
794 "Perl script implementing `directory-files-attributes' as Lisp `read'able
795 output.
796 Escape sequence %s is replaced with name of Perl binary.
799 ;; These two use base64 encoding.
801 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
802 "Perl program to use for encoding a file.
803 Escape sequence %s is replaced with name of Perl binary.
804 This string is passed to `format', so percent characters need to be doubled.
805 This implementation requires the MIME::Base64 Perl module to be installed
809 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
810 "Perl program to use for decoding a file.
811 Escape sequence %s is replaced with name of Perl binary.
812 This string is passed to `format', so percent characters need to be doubled.
813 This implementation requires the MIME::Base64 Perl module to be installed
817 "%s -e '
818 # This script contributed by Juanma Barranquero <lektu@terra.es>.
819 # Copyright (C) 2002-2016 Free Software Foundation, Inc.
820 use strict;
822 my %%trans = do {
823 my $i = 0;
824 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
825 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
826 };
827 my $data;
829 # We read in chunks of 54 bytes, to generate output lines
830 # of 72 chars (plus end of line)
831 while (read STDIN, $data, 54) {
832 my $pad = q();
834 # Only for the last chunk, and only if did not fill the last three-byte packet
835 if (eof) {
836 my $mod = length($data) %% 3;
837 $pad = q(=) x (3 - $mod) if $mod;
838 }
840 # Not the fastest method, but it is simple: unpack to binary string, split
841 # by groups of 6 bits and convert back from binary to byte; then map into
842 # the translation table
843 print
844 join q(),
845 map($trans{$_},
846 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
847 $pad,
849 }' 2>/dev/null"
850 "Perl program to use for encoding a file.
851 Escape sequence %s is replaced with name of Perl binary.
855 "%s -e '
856 # This script contributed by Juanma Barranquero <lektu@terra.es>.
857 # Copyright (C) 2002-2016 Free Software Foundation, Inc.
858 use strict;
860 my %%trans = do {
861 my $i = 0;
862 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
863 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
864 };
866 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
870 # We are going to accumulate into $pending to accept any line length
871 # (we do not check they are <= 76 chars as the RFC says)
872 my $pending = q();
874 while (my $data = <STDIN>) {
875 chomp $data;
877 # If we find one or two =, we have reached the end and
878 # any following data is to be discarded
879 my $finished = $data =~ s/(==?).*/$1/;
880 $pending .= $data;
882 my $len = length($pending);
883 my $chunk = substr($pending, 0, $len & ~3);
884 $pending = substr($pending, $len & ~3 + 1);
886 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
887 # split in 8-bit chunks and convert back to char.
888 print join q(),
889 map $bytes{$_},
890 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
892 last if $finished;
893 }' 2>/dev/null"
894 "Perl program to use for decoding a file.
895 Escape sequence %s is replaced with name of Perl binary.
899 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
900 "Perl program to use for encoding a file.
904 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
905 "Perl program to use for decoding a file.
910 BEGIN {
913 }
914 {
915 for (c=1; c<=length($0); c++) {
916 d=index(b16, substr($0,c,1))
917 if (d--) {
918 for (b=1; b<=4; b++) {
919 o=o*2+int(d/8); d=(d*2)%%16
920 if (++obc==6) {
921 printf substr(b64,o+1,1)
923 obc=0; o=0
924 }
925 }
926 }
927 }
928 }
929 END {
930 if (obc) {
932 while (obc++<6) { o=o*2 }
934 } else {
936 }
937 printf tail
938 }'"
939 "Awk program to use for encoding a file.
944 BEGIN {
946 }
947 {
948 for (i=1; i<=length($0); i++) {
949 c=index(b64, substr($0,i,1))
950 if(c--) {
951 for(b=0; b<6; b++) {
952 o=o*2+int(c/32); c=(c*2)%%64
953 if(++obc==8) {
954 if (o) {
956 } else {
958 }
959 obc=0; o=0
960 }
961 }
962 }
963 }
964 }'"
965 "Awk program to use for decoding a file.
969 "test -c /dev/zero && \
970 od -v -t x1 -A n </dev/null && \
971 busybox awk '{}' </dev/null"
982 while read file; do
985 else
987 fi
990 else
992 fi
993 done
995 "Script to check existence of VC related files.
996 It must be send formatted with two strings; the tests for file
997 existence, and file readability. Input shall be read via
998 here-document, otherwise the command could exceed maximum length
1001 ;; New handlers should be added here.
1005 ;; `byte-compiler-base-file-name' performed by default handler.
1010 ;; `diff-latest-backup-file' performed by default handler.
1014 . tramp-sh-handle-directory-files-and-attributes)
1034 ;; `file-name-sans-versions' performed by default handler.
1048 ;; `find-file-noselect' performed by default handler.
1049 ;; `get-file-buffer' performed by default handler.
1072 "Alist of handler functions.
1075 ;; This must be the last entry, because `identity' always matches.
1076 ;;;###tramp-autoload
1080 ;;; File Name Handler Functions:
1084 "Like `make-symbolic-link' for Tramp files.
1085 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1086 the symlink. If LINKNAME is a Tramp file, only the localname component is
1087 used as the target of the symlink.
1089 If LINKNAME is a Tramp file and the localname component is relative, then
1090 it is expanded first, before the localname component is taken. Note that
1091 this can give surprising results if the user/host for the source and
1092 target of the symlink differ."
1099 l 'file-error
1102 ;; Do the 'confirm if exists' thing.
1104 ;; What to do?
1109 "File %s already exists; make it a link anyway? "
1110 l-localname)))))
1115 ;; If FILENAME is a Tramp name, use just the localname component.
1124 ;; Right, they are on the same host, regardless of user, method,
1125 ;; etc. We now make the link on the remote machine. This will
1126 ;; occur as the user that FILENAME belongs to.
1131 "%s -sf %s %s"
1132 ln
1134 ;; The command could exceed PATH_MAX, so we use
1135 ;; relative file names. However, relative file names
1136 ;; could start with "-". `tramp-shell-quote-argument'
1137 ;; does not handle this, we must do it ourselves.
1142 "Like `file-truename' for Tramp files."
1144 "%s%s"
1147 method user host
1154 ;; Use GNU readlink --canonicalize-missing where available.
1157 v
1165 ;; Use Perl implementation.
1173 v
1177 ;; Do it yourself.
1181 ;; Don't make the following value larger than
1182 ;; necessary. People expect an error message in a
1183 ;; timely fashion when something is wrong;
1184 ;; otherwise they might think that Emacs is hung.
1185 ;; Of course, correctness has to come first.
1187 symlink-target)
1199 method user host
1211 ;; It's a symlink, follow it.
1217 ;; If the symlink was absolute, we'll get a
1218 ;; string like "/user@host:/some/target";
1219 ;; extract the "/some/target" part from it.
1223 v 'file-error
1224 "Symlink target `%s' on wrong host"
1225 symlink-target))
1231 ;; It's a file.
1235 v 'file-error
1238 ;; Combine list to form string.
1248 result))))
1250 ;; Preserve trailing "/".
1253 ;; Basic functions.
1256 "Like `file-exists-p' for Tramp files."
1264 v
1266 "%s %s"
1271 "Like `file-attributes' for Tramp files."
1274 ;; Don't modify `last-coding-system-used' by accident.
1281 v
1289 ;; The scripts could fail, for example with huge file size.
1293 "Implement `file-attributes' for Tramp files using the ls(1) command."
1295 res-inode res-filemodes res-numlinks
1296 res-uid res-gid res-size res-symlink-target)
1298 ;; We cannot send all three commands combined, it could exceed
1299 ;; NAME_MAX or PATH_MAX. Happened on macOS, for example.
1301 vec
1306 vec
1311 vec
1315 ;; On systems which have no quoting style, file names
1316 ;; with special characters could fail.
1324 ;; Parse `ls -l' output ...
1328 ;; ... inode
1344 ;; ... file mode flags
1346 ;; ... number links
1348 ;; ... uid and gid
1360 ;; ... size
1362 ;; From the file modes, figure out other stuff.
1365 ;; If symlink, find out file name pointed to.
1372 ;; Return data gathered.
1374 ;; 0. t for directory, string (name linked to) for symbolic
1375 ;; link, or nil.
1377 ;; 1. Number of links to file.
1378 res-numlinks
1379 ;; 2. File uid.
1380 res-uid
1381 ;; 3. File gid.
1382 res-gid
1383 ;; 4. Last access time, as a list of integers. Normally
1384 ;; this would be in the same format as `current-time', but
1385 ;; the subseconds part is not currently implemented, and
1386 ;; (0 0) denotes an unknown time.
1387 ;; 5. Last modification time, likewise.
1388 ;; 6. Last status change time, likewise.
1390 ;; 7. Size in bytes (-1, if number is out of range).
1391 res-size
1392 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1393 res-filemodes
1394 ;; 9. t if file's gid would change if file were deleted and
1395 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1396 t
1397 ;; 10. Inode number.
1398 res-inode
1399 ;; 11. Device number. Will be replaced by a virtual device number.
1404 "Implement `file-attributes' for Tramp files using a Perl script."
1409 vec
1415 "Implement `file-attributes' for Tramp files using stat(1) command."
1418 vec
1421 ;; On Opsware, pdksh (which is the true name of ksh there)
1422 ;; doesn't parse correctly the sequence "((". Therefore, we add
1423 ;; a space. Apostrophes in the stat output are masked as
1424 ;; `tramp-stat-marker', in order to make a proper shell escape of
1425 ;; them in file names.
1426 "( (%s %s || %s -h %s) && (%s -c "
1427 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1434 tramp-stat-marker tramp-stat-marker
1439 tramp-stat-marker tramp-stat-marker
1441 tramp-stat-quoted-marker)))
1444 "Like `set-visited-file-modtime' for Tramp files."
1451 coding-system-used)
1455 ;; '(-1 65535) means file doesn't exists yet.
1459 ;; We use '(0 0) as a don't-know value. See also
1460 ;; `tramp-do-file-attributes-with-ls'.
1465 v
1473 nil)))))
1475 ;; This function makes the same assumption as
1476 ;; `tramp-sh-handle-set-visited-file-modtime'.
1478 "Like `verify-visited-file-modtime' for Tramp files.
1479 At the time `verify-visited-file-modtime' calls this function, we
1480 already know that the buffer is visiting a file and that
1481 `visited-file-modtime' does not return 0. Do not call this
1482 function directly, unless those two cases are already taken care
1483 of."
1486 ;; There is no file visiting the buffer, or the buffer has no
1487 ;; recorded last modification time, or there is no established
1488 ;; connection.
1492 t
1500 ;; File exists, and has a known modtime.
1503 modtime
1504 ;; For compatibility, deal with both the old
1505 ;; (HIGH . LOW) and the new (HIGH LOW) return
1506 ;; values of `visited-file-modtime'.
1509 mt)))
1511 ;; Modtime has the don't know value.
1514 v
1521 attr
1524 ;; If file does not exist, say it is not modified if and
1525 ;; only if that agrees with the buffer's record.
1529 "Like `set-file-modes' for Tramp files."
1533 ;; FIXME: extract the proper text from chmod's stderr.
1535 v
1540 "Like `set-file-times' for Tramp files."
1547 time)))
1550 "env TZ=UTC %s %s %s"
1558 "Set the ownership for FILENAME.
1559 If UID and GID are provided, these values are used; otherwise uid
1560 and gid of the corresponding user is taken. Both parameters must
1561 be non-negative integers."
1562 ;; Modern Unices allow chown only for root. So we might need
1563 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1564 ;; working with su(do)? when it is needed, so it shall succeed in
1565 ;; the majority of cases.
1566 ;; Don't modify `last-coding-system-used' by accident.
1571 ;; If we are root on the local host, we can do it directly.
1579 "chown %d:%d %s" uid gid
1582 ;; We handle also the local part, because there doesn't exist
1583 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1584 ;; timeout for this.
1589 nil "chown" nil nil nil
1593 "Check, whether SELINUX is enabled on the remote host."
1598 "Like `file-selinux-context' for Tramp files."
1607 "%s -d -Z %s"
1615 ;; Return the context.
1616 context))))
1619 "Like `set-file-selinux-context' for Tramp files."
1639 t)))))
1642 "Check, whether ACL is enabled on the remote host."
1647 "Like `file-acl' for Tramp files."
1653 "getfacl -ac %s"
1662 "Like `set-file-acl' for Tramp files."
1669 tramp-end-of-heredoc
1670 acl-string
1671 tramp-end-of-heredoc))
1673 ;; Success.
1676 t)
1677 ;; In case of errors, we return nil.
1679 nil)))
1681 ;; Simple functions using the `test' command.
1684 "Like `file-executable-p' for Tramp files."
1687 ;; Examine `file-attributes' cache to see if request can be
1688 ;; satisfied without remote operation.
1693 "Like `file-readable-p' for Tramp files."
1696 ;; Examine `file-attributes' cache to see if request can be
1697 ;; satisfied without remote operation.
1701 ;; When the remote shell is started, it looks for a shell which groks
1702 ;; tilde expansion. Here, we assume that all shells which grok tilde
1703 ;; expansion will also provide a `test' command which groks `-nt' (for
1704 ;; newer than). If this breaks, tell me about it and I'll try to do
1705 ;; something smarter about it.
1707 "Like `file-newer-than-file-p' for Tramp files."
1709 nil)
1711 t)
1712 ;; We are sure both files exist at this point.
1715 ;; We try to get the mtime of both files. If they are not
1716 ;; equal to the "dont-know" value, then we subtract the times
1717 ;; and obtain the result.
1730 ;; If one of them is the dont-know value, then we can
1731 ;; still try to run a shell command on the remote host.
1732 ;; However, this only works if both files are Tramp
1733 ;; files and both have the same method, same user, same
1734 ;; host.
1739 v 'file-error
1740 "Files %s and %s must have same method, user, host"
1741 file1 file2)))
1746 ;; Functions implemented using the basic functions above.
1749 "Like `file-directory-p' for Tramp files."
1751 ;; `file-directory-p' is used as predicate for file name completion.
1752 ;; Sometimes, when a connection is not established yet, it is
1753 ;; desirable to return t immediately for "/method:foo:". It can
1754 ;; be expected that this is always a directory.
1760 "Like `file-writable-p' for Tramp files."
1764 ;; Examine `file-attributes' cache to see if request can be
1765 ;; satisfied without remote operation.
1768 ;; If file doesn't exist, check if directory is writable.
1773 "Like `file-ownership-preserved-p' for Tramp files."
1777 ;; Return t if the file doesn't exist, since it's true that no
1778 ;; information would be lost by an (attempted) delete and create.
1787 ;; Directory listings.
1791 "Like `directory-files-and-attributes' for Tramp files."
1799 v localname
1810 v localname id-format))
1813 v localname id-format))
1815 result item)
1825 result
1827 ;; The scripts could fail, for example with huge file size.
1829 directory full match nosort id-format)))))
1833 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1836 vec tramp-perl-directory-files-and-attributes
1840 vec
1844 object))
1848 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1851 vec
1854 ;; We must care about file names with spaces, or starting with
1855 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1856 ;; but it does not work on all remote systems. Apostrophes in
1857 ;; the stat output are masked as `tramp-stat-marker', in order to
1858 ;; make a proper shell escape of them in file names.
1860 "xargs %s -c "
1861 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1865 ;; On systems which have no quoting style, file names with special
1866 ;; characters could fail.
1874 tramp-stat-marker tramp-stat-marker
1875 tramp-stat-marker tramp-stat-marker
1880 tramp-stat-marker tramp-stat-marker
1881 tramp-stat-quoted-marker)))
1883 ;; This function should return "foo/" for directories and "bar" for
1884 ;; files.
1886 "Like `file-name-all-completions' for Tramp files."
1889 filename
1893 ;; Get a list of directories and files, including reliably
1894 ;; tagging the directories with a trailing "/". Because I
1895 ;; rock. --daniel@danann.net
1897 v
1901 v tramp-perl-file-name-all-completions
1907 "(cd %s 2>&1 && %s -a 2>/dev/null"
1908 " | while IFS= read f; do"
1916 ;; Now grab the output.
1920 ;; Check result code, found in last line of output.
1924 ;; Grab error message from line before last line
1925 ;; (it was put there by `cd 2>&1').
1928 v 'file-error
1929 "tramp-sh-handle-file-name-all-completions: %s"
1931 ;; For peace of mind, if buffer doesn't end in `fail'
1932 ;; then it should end in `ok'. If neither are in the
1933 ;; buffer something went seriously wrong on the remote
1934 ;; side.
1938 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1943 result))))))
1945 ;; cp, mv and ln
1949 "Like `add-name-to-file' for Tramp files."
1954 v 'file-error
1955 "add-name-to-file: %s"
1964 "File %s already exists; make it a new name anyway? "
1965 newname)))
1967 v2 'file-already-exists
1973 v1
1977 "error with add-name-to-file, see buffer `%s' for details"
1982 preserve-uid-gid preserve-extended-attributes)
1983 "Like `copy-file' for Tramp files."
1987 ;; At least one file a Tramp file?
1991 'copy filename newname ok-if-already-exists keep-date
1992 preserve-uid-gid preserve-extended-attributes))
1993 ;; Compat section. PRESERVE-EXTENDED-ATTRIBUTES has been
1994 ;; introduced with Emacs 24.1 (as PRESERVE-SELINUX-CONTEXT), and
1995 ;; renamed in Emacs 24.3.
1998 'copy-file
2000 preserve-uid-gid preserve-extended-attributes)))
2003 'copy-file
2008 "Like `copy-directory' for Tramp files."
2014 ;; When DIRNAME and NEWNAME are remote, they must have
2015 ;; the same method.
2021 ;; scp or rsync DTRT.
2035 ;; We must do it file-wise.
2037 'copy-directory
2042 ;; When newname did exist, we have wrong cached values.
2050 "Like `rename-file' for Tramp files."
2051 ;; Check if both files are local -- invoke normal rename-file.
2052 ;; Otherwise, use Tramp from local system.
2055 ;; At least one file a Tramp file?
2059 'rename filename newname ok-if-already-exists
2066 preserve-uid-gid preserve-extended-attributes)
2067 "Copy or rename a remote file.
2068 OP must be `copy' or `rename' and indicates the operation to perform.
2069 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2070 the new file (for copy) or the new name of the file (for rename).
2071 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2072 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2073 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2074 the uid and gid if both files are on the same host.
2075 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2077 This function is invoked by `tramp-sh-handle-copy-file' and
2078 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2079 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2080 file names."
2098 filename newname)
2101 ;; Both are Tramp files.
2106 ;; Shortcut: if method, host, user are the same for
2107 ;; both files, we invoke `cp' or `mv' on the remote
2108 ;; host directly.
2111 op filename newname
2112 ok-if-already-exists keep-date preserve-uid-gid))
2114 ;; Try out-of-band operation.
2119 op filename newname keep-date))
2121 ;; No shortcut was possible. So we copy the file
2122 ;; first. If the operation was `rename', we go back
2123 ;; and delete the original file (if the copy was
2124 ;; successful). The approach is simple-minded: we
2125 ;; create a new buffer, insert the contents of the
2126 ;; source file into it, then write out the buffer to
2127 ;; the target file. The advantage is that it doesn't
2128 ;; matter which file name handlers are used for the
2129 ;; source and target file.
2132 op filename newname keep-date))))))
2134 ;; One file is a Tramp file, the other one is local.
2137 ;; Fast track on local machine.
2140 op filename newname
2141 ok-if-already-exists keep-date preserve-uid-gid))
2143 ;; If the Tramp file has an out-of-band method, the
2144 ;; corresponding copy-program can be invoked.
2147 op filename newname keep-date))
2149 ;; Use the inline method via a Tramp buffer.
2151 op filename newname keep-date))))
2154 ;; One of them must be a Tramp file.
2157 ;; Handle `preserve-extended-attributes'. We ignore possible
2158 ;; errors, because ACL strings could be incompatible.
2163 ;; In case of `rename', we must flush the cache of the source file.
2169 ;; When newname did exist, we have wrong cached values.
2176 "Use an Emacs buffer to copy or rename a file.
2177 First arg OP is either `copy' or `rename' and indicates the operation.
2178 FILENAME is the source file, NEWNAME the target file.
2179 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2180 ;; We must disable multibyte, because binary data shall not be
2181 ;; converted. We don't want the target file to be compressed, so we
2182 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2183 ;; be called either. We remove `tramp-file-name-handler' from
2184 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2185 ;; `insert-file-contents' might be deactivated in some corner cases.
2196 ;; KEEP-DATE handling.
2199 newname
2202 ;; Set the mode.
2204 ;; If the operation was `rename', delete the original file.
2209 "Invokes `cp' or `mv' on the remote system.
2210 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2211 respectively. FILENAME specifies the file to copy or rename,
2212 NEWNAME is the name of the new file (for copy) or the new name of
2213 the file (for rename). Both files must reside on the same host.
2214 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2215 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2216 the uid and gid from FILENAME."
2227 v 'file-error
2228 "Unknown operation `%s', must be `copy' or `rename'"
2229 op))))
2233 filename))
2237 newname))
2239 cmd-result)
2242 ;; Both files are on a remote host, with same user.
2254 ;; Mask cp -f error.
2256 tramp-operation-not-permitted-regexp nil t))
2257 cmd-result)
2259 nil v 'file-error
2260 "Copying directly failed, see buffer `%s' for details."
2263 ;; We are on the local host.
2266 ;; We can do it directly.
2269 ;; No sticky bit when renaming.
2280 localname1 localname2 ok-if-already-exists
2281 keep-date preserve-uid-gid)
2285 ;; We can do it directly with `tramp-send-command'
2293 ok-if-already-exists keep-date t)
2294 ;; We must change the ownership to the local user.
2300 ;; We need a temporary file in between.
2302 ;; Create the temporary file.
2310 "%s %s %s" cmd
2313 "Copying directly failed, see buffer `%s' for details."
2315 ;; We must change the ownership as remote user.
2316 ;; Since this does not work reliable, we also
2317 ;; give read permissions.
2327 localname1 tmpfile t
2328 keep-date preserve-uid-gid)
2330 'rename-file
2332 ;; We must change the ownership as local user.
2333 ;; Since this does not work reliable, we also
2334 ;; give read permissions.
2337 tmpfile
2341 ;; Move the temporary file to its destination.
2346 "cp -f -p %s %s"
2349 "Copying directly failed, see buffer `%s' for details."
2353 'rename-file
2356 ;; Save exit.
2359 ;; Set the time and mode. Mask possible errors.
2366 "Invoke `scp' program to copy.
2367 The method used must be an out-of-band method."
2371 copy-program copy-args copy-env copy-keep-date port listener spec
2372 options source target remote-copy-program remote-copy-args)
2377 ;; Both are Tramp files. We shall optimize it when the
2378 ;; methods for FILENAME and NEWNAME are the same.
2388 op filename tmpfile keep-date)
2391 ;; Save exit.
2398 ;; Set variables for computing the prompt for reading
2399 ;; password.
2406 ;; Expand hops. Might be necessary for gateway methods.
2410 ;; Check which ones of source and target are Tramp files.
2414 'file-name-as-directory
2423 ;; Check for host and port number. We cannot use
2424 ;; `tramp-file-name-port', because this returns also
2425 ;; `tramp-default-port', which might clash with settings in
2426 ;; "~/.ssh/config".
2433 ;; Check for user. There might be an interactive setting.
2437 ;; Check for listener port.
2444 ;; Compose copy command.
2453 ?h host ?u user ?p port ?r listener ?c options
2459 copy-args
2461 ;; " " has either been a replacement of "%k" (when
2462 ;; keep-date argument is non-nil), or a replacement
2463 ;; for the whole keep-date sublist.
2464 " "
2469 copy-args
2473 copy-env
2475 nil
2482 remote-copy-program
2488 remote-copy-args
2492 ;; Check for local copy program.
2497 ;; Install listener on the remote side. The prompt must be
2498 ;; consumed later on, when the process does not listen anymore.
2505 v 'file-error
2509 'identity
2517 v 'file-error
2518 "Listener process not running on remote host: `%s'"
2519 remote-copy-program))
2527 ;; The default directory must be remote.
2531 ;; Set the transfer process properties.
2541 copy-args
2543 copy-args
2548 ;; Use an asynchronous process. By this, password can
2549 ;; be handled. We don't set a timeout, because the
2550 ;; copying of large files can last longer than 60 secs.
2560 command))))
2565 ;; We must adapt `tramp-local-end-of-line' for
2566 ;; sending the password.
2569 p v nil tramp-actions-copy-out-of-band))))
2571 ;; Reset the transfer process properties.
2574 ;; Clear the remote prompt.
2577 ;; Houston, we have a problem! Likely, the listener is
2578 ;; still running, so let's clear everything (but the
2579 ;; cached password).
2582 ;; Handle KEEP-DATE argument.
2585 newname
2589 ;; Set the mode.
2594 ;; If the operation was `rename', delete the original file.
2601 "Like `make-directory' for Tramp files."
2613 "Like `delete-directory' for Tramp files."
2625 "Like `delete-file' for Tramp files."
2636 ;; Dired.
2642 "Like `dired-compress-file' for Tramp files."
2643 ;; Code stolen mainly from dired-aux.el.
2648 suffix)
2649 ;; See if any suffix rule matches this file name.
2657 nil)
2659 ;; We found an uncompression rule.
2669 ;; We don't recognize the file as compressed, so compress it.
2670 ;; Try gzip.
2684 "Like `insert-directory' for Tramp files."
2691 filename switches wildcard full-directory-p)
2713 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2714 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2717 v
2720 switches
2722 localname
2725 v
2729 "Couldn't `cd %s'"
2733 v
2736 switches
2741 ""
2749 ;; We cannot use `insert-buffer-substring' because the Tramp
2750 ;; buffer changes its contents before insertion due to calling
2751 ;; `expand-file-name' and alike.
2756 ;; Check for "--dired" output.
2763 ;; Now read the numeric positions of file names.
2769 ;; End is followed by \n or by " -> ".
2771 ;; Remove trailing lines.
2777 ;; Some busyboxes are reluctant to discard colors.
2785 ;; Decode the output, it could be multibyte.
2790 ;; The inserted file could be from somewhere else.
2797 "."
2804 ;; Canonicalization of file names.
2807 "Like `expand-file-name' for Tramp files.
2809 the result will be a local, non-Tramp, file name."
2810 ;; If DIR is not given, use `default-directory' or "/".
2812 ;; Unless NAME is absolute, concat DIR and NAME.
2815 ;; If connection is not established yet, run the real handler.
2818 ;; Dissect NAME.
2822 ;; Tilde expansion if necessary. This needs a shell which
2823 ;; groks tilde expansion! The function `tramp-find-shell' is
2824 ;; supposed to find such a shell on the remote host. Please
2825 ;; tell me about it when this doesn't work on your system.
2829 ;; We cannot simply apply "~/", because under sudo "~/" is
2830 ;; expanded to the local user home directory but to the
2831 ;; root home directory. On the other hand, using always
2832 ;; the default user name for tilde expansion is not
2833 ;; appropriate either, because ssh and companions might
2834 ;; use a user name from the config file.
2846 ;; There might be a double slash, for example when "~/"
2847 ;; expands to "/". Remove this.
2850 ;; No tilde characters in file name, do normal
2851 ;; `expand-file-name' (this does "/./" and "/../").
2852 ;; `default-directory' is bound, because on Windows there would
2853 ;; be problems with UNC shares or Cygwin mounts.
2856 method user host
2860 hop)))))
2862 ;;; Remote commands:
2865 "Flush file caches."
2873 ;; We use BUFFER also as connection buffer during setup. Because of
2874 ;; this, its original contents must be saved, and restored once
2875 ;; connection has been setup.
2877 "Like `start-file-process' for Tramp files."
2882 ;; BUFFER can be nil. We use a temporary buffer.
2884 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2885 ;; it might be that the arguments exceed the command line
2886 ;; length. Therefore, we modify the command.
2891 ;; When PROGRAM is nil, we just provide a tty.
2897 args
2901 ;; Use a human-friendly prompt, for example for `shell'.
2902 ;; We discard hops, if existing, that's why we cannot use
2903 ;; `file-remote-p'.
2910 tramp-initial-end-of-output))
2911 ;; We use as environment the difference to toplevel
2912 ;; `process-environment'.
2913 env uenv
2927 "unset %s &&"
2942 ;; We do not want to raise an error when
2943 ;; `start-file-process' has been started several times in
2944 ;; `eshell' and friends.
2948 ;; NAME must be unique as process name.
2952 ;; Set the new process properties.
2958 ;; We catch this event. Otherwise, `start-process' could
2959 ;; be called on the local host.
2962 ;; Activate narrowing in order to save BUFFER
2963 ;; contents. Clear also the modification time;
2964 ;; otherwise we might be interrupted by
2965 ;; `verify-visited-file-modtime'.
2971 ;; We call `tramp-maybe-open-connection', in order
2972 ;; to cleanup the prompt afterwards.
2978 ;; Now do it.
2980 ;; Send the command.
2982 ;; Check, whether a pty is associated.
2986 v 'file-error
2989 ;; Set query flag and process marker for this
2990 ;; process. We ignore errors, because the process
2991 ;; could have finished already.
2995 ;; Return process.
2996 p))))
2998 ;; Save exit.
3009 "Like `process-file' for Tramp files."
3010 ;; The implementation is not complete yet.
3016 ;; Compute command.
3019 ;; We use as environment the difference to toplevel `process-environment'.
3030 "env %s %s"
3035 "unset %s && %s"
3037 ;; Determine input.
3042 ;; INFILE is on the same remote host.
3044 ;; INFILE must be copied to remote host.
3050 ;; Determine output.
3052 ;; Just a buffer.
3055 ;; A buffer name.
3058 ;; (REAL-DESTINATION ERROR-DESTINATION)
3060 ;; output.
3068 ;; stderr.
3073 ;; stderr is on the same remote host.
3076 ;; stderr must be copied to remote host. The temporary
3077 ;; file must be deleted after execution.
3080 method user host stderr))))
3081 ;; stderr to be discarded.
3084 ;; 't
3089 ;; Send the command. It might not return in time, so we protect
3090 ;; it. Call it in a subshell, in order to preserve working
3091 ;; directory.
3098 command)
3099 t t)
3101 ;; We should add the output anyway.
3108 ;; When the user did interrupt, we should do it also. We use
3109 ;; return code -1 as marker.
3113 ;; Handle errors.
3118 ;; Provide error file.
3121 ;; Cleanup. We remove all file cache values for the connection,
3122 ;; because the remote process could have changed them.
3128 ;; Return exit status.
3131 ret))))
3134 "Like `file-local-copy' for Tramp files."
3138 v tramp-file-missing
3149 ;; `copy-file' handles direct copy and out-of-band methods.
3154 ;; Use inline encoding for file transfer.
3158 v 3
3160 filename rem-enc)
3167 tmpfile loc-dec)
3169 ;; If local decoding is a function, we call it.
3170 ;; We must disable multibyte, because
3171 ;; `uudecode-decode-region' doesn't handle it
3172 ;; correctly. Unset `file-name-handler-alist'.
3173 ;; Otherwise, epa-file gets confused.
3181 ;; If tramp-decoding-function is not defined for this
3182 ;; method, we invoke tramp-decoding-command instead.
3184 ;; Unset `file-name-handler-alist'. Otherwise,
3185 ;; epa-file gets confused.
3193 loc-dec tmpfile2 tmpfile)
3196 ;; Set proper permissions.
3198 ;; Set local user ownership.
3201 ;; Oops, I don't know what to do.
3205 ;; Error handling.
3211 tmpfile)))
3213 ;; CCC grok LOCKNAME
3216 "Like `write-region' for Tramp files."
3219 ;; Following part commented out because we don't know what to do about
3220 ;; file locking, and it does not appear to be a problem to ignore it.
3221 ;; Ange-ftp ignores it, too.
3222 ;; (when (and lockname (stringp lockname))
3223 ;; (setq lockname (expand-file-name lockname)))
3224 ;; (unless (or (eq lockname nil)
3225 ;; (string= lockname filename))
3226 ;; (error
3227 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3241 ;; `file-writable-p' calls `file-expand-file-name'. We
3242 ;; cannot use `tramp-run-real-handler' therefore.
3248 ;; Short track: if we are on the local host, we can run directly.
3250 'write-region
3254 ;; We use this to save the value of
3255 ;; `last-coding-system-used' after writing the tmp
3256 ;; file. At the end of the function, we set
3257 ;; `last-coding-system-used' to this saved value. This
3258 ;; way, any intermediary coding systems used while
3259 ;; talking to the remote shell or suchlike won't hose
3260 ;; this variable. This approach was snarfed from
3261 ;; ange-ftp.el.
3262 coding-system-used
3263 ;; Write region into a tmp file. This isn't really
3264 ;; needed if we use an encoding function, but currently
3265 ;; we use it always because this makes the logic
3266 ;; simpler. We must also set `temporary-file-directory',
3267 ;; because it could point to a remote directory.
3273 ;; If `append' is non-nil, we copy the file locally, and let
3274 ;; the native `write-region' implementation do the job.
3277 ;; We say `no-message' here because we don't want the
3278 ;; visited file modtime data to be clobbered from the temp
3279 ;; file. We call `set-visited-file-modtime' ourselves later
3280 ;; on. We must ensure that `file-coding-system-alist'
3281 ;; matches `tmpfile'.
3287 'write-region
3294 ;; Now, `last-coding-system-used' has the right value. Remember it.
3297 ;; The permissions of the temporary file should be set. If
3298 ;; FILENAME does not exist (eq modes nil) it has been
3299 ;; renamed to the backup file. This case `save-buffer'
3300 ;; handles permissions.
3301 ;; Ensure that it is still readable.
3304 tmpfile
3307 ;; This is a bit lengthy due to the different methods
3308 ;; possible for file transfer. First, we check whether the
3309 ;; method uses an scp program. If so, we call it.
3310 ;; Otherwise, both encoding and decoding command must be
3311 ;; specified. However, if the method _also_ specifies an
3312 ;; encoding function, then that is used for encoding the
3313 ;; contents of the tmp file.
3319 ;; `copy-file' handles direct copy and out-of-band methods.
3329 ;; We keep the local file for performance
3330 ;; reasons, useful for "rsync".
3337 ;; Don't rename, in order to keep context in SELinux.
3342 ;; Use inline file transfer.
3344 ;; Encode tmpfile.
3348 ;; Use encoding function or command.
3351 "Encoding local file `%s' using `%s'"
3352 tmpfile loc-enc)
3354 ;; The following `let' is a workaround for
3355 ;; the base64.el that comes with pgnus-0.84.
3356 ;; If both of the following conditions are
3357 ;; satisfied, it tries to write to a local
3358 ;; file in default-directory, but at this
3359 ;; point, default-directory is remote.
3360 ;; (`call-process-region' can't write to
3361 ;; remote files, it seems.) The file in
3362 ;; question is a tmp file anyway.
3370 loc-enc tmpfile t))
3372 v 'file-error
3375 filename loc-enc))))
3377 ;; Send buffer into remote decoding command which
3378 ;; writes to remote file. Because this happens on
3379 ;; the remote host, we cannot use the function.
3382 "Decoding remote file `%s' using `%s'"
3383 filename rem-dec)
3387 v
3391 tramp-end-of-heredoc
3393 tramp-end-of-heredoc))
3395 v nil
3396 "Couldn't write region to `%s', decode using `%s' failed"
3397 filename rem-dec)
3398 ;; When `file-precious-flag' is set, the region is
3399 ;; written to a temporary file. Check that the
3400 ;; checksum is equal to that from the local tmpfile.
3404 ;; cksum runs locally, if possible.
3406 ;; cksum runs remotely.
3408 v
3411 ;; ... they are different.
3418 v 'file-error
3421 filename rem-dec)))))
3423 ;; Save exit.
3426 ;; That's not expected.
3429 v 'file-error
3432 method))))
3434 ;; Make `last-coding-system-used' have the right value.
3441 ;; We must protect `last-coding-system-used', now we have set it
3442 ;; to its correct value.
3444 ;; Set file modification time.
3448 ;; We must pass modtime explicitly, because FILENAME can
3449 ;; be different from (buffer-file-name), f.e. if
3450 ;; `file-precious-flag' is set.
3456 ;; Set the ownership.
3466 ;; VC backends check for the existence of various different special
3467 ;; files. This is very time consuming, because every single check
3468 ;; requires a remote command (the file cache must be invalidated).
3469 ;; Therefore, we apply a kind of optimization. We install the file
3470 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3471 ;; remembers all file names for which `file-exists-p' or
3472 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3473 ;; is performed. Afterwards, a script is applied for all collected
3474 ;; file names, using just one remote command. The result of this
3475 ;; script is used to fill the file cache with actual values. Now we
3476 ;; can reset the file name handlers, and we make a second run of
3477 ;; `vc-registered', which returns the expected result without sending
3478 ;; any other remote command.
3480 "Like `vc-registered' for Tramp files."
3486 ;; There could be new files, created by the vc backend. We
3487 ;; cannot reuse the old cache entries, therefore. In
3488 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3489 ;; could also be a timestamp as `current-time' returns. This
3490 ;; means invalidate all cache entries with an older timestamp.
3496 ;; Here we collect only file names, which need an operation.
3500 ;; Send just one command, in order to fill the cache.
3503 v
3512 ;; We cannot use `tramp-send-command-and-read',
3513 ;; because this does not cooperate well with
3514 ;; heredoc documents.
3516 v
3519 tramp-end-of-heredoc
3521 tramp-vc-registered-file-names
3523 tramp-end-of-heredoc))
3525 ;; Read the expression.
3532 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3533 ;; calls shall be answered from the file cache. We unset
3534 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3535 ;; in order to keep the cache.
3537 remote-file-name-inhibit-cache process-file-side-effects)
3538 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3557 ;; Run.
3561 ;;;###tramp-autoload
3563 "Invoke remote-shell Tramp file name handler.
3564 Fall back to normal file name handler if no Tramp handler exists."
3582 "Invoke special file name handler, which collects files to be handled."
3590 ;; That's what we want: file names, for which checks are
3591 ;; applied. We assume that VC uses only `file-exists-p' and
3592 ;; `file-readable-p' checks; otherwise we must extend the
3593 ;; list. We do not perform any action, but return nil, in
3594 ;; order to keep `vc-registered' running.
3597 nil)
3598 ;; `process-file' and `start-file-process' shall be ignored.
3601 ;; Tramp file name handlers like `expand-file-name'. They
3602 ;; must still work.
3604 ;; Default file name handlers, we don't care.
3608 "Like `file-notify-add-watch' for Tramp files."
3612 command events filter p sequence)
3614 ;; gvfs-monitor-dir.
3617 events
3621 attribute-changed))
3626 ;; inotifywait.
3629 events
3639 ;; Make events a list of symbols.
3640 events
3644 ;; None.
3646 v 'file-notify-error
3647 "No file notification program found on %s"
3649 ;; Start process.
3651 'start-file-process
3655 sequence))
3656 ;; Return the process object as watch-descriptor.
3659 v 'file-notify-error
3660 "`%s' failed to start on remote host"
3664 ;; Needed for process filter.
3669 ;; There might be an error if the monitor is not supported.
3670 ;; Give the filter a chance to read the output.
3675 p))))
3679 file-notify events."
3689 ;; Attribute change is returned in unused wording.
3701 string)
3706 proc
3711 ;; File names are returned as absolute paths. We must
3712 ;; add the remote prefix.
3716 ;; Remove watch when file or directory to be watched is deleted.
3720 ;; Usually, we would add an Emacs event now. Unfortunately,
3721 ;; `unread-command-events' does not accept several events at
3722 ;; once. Therefore, we apply the handler directly.
3725 'file-notify-handle-event
3728 ;; Save rest of the string.
3738 ;; Check, whether there is a problem.
3744 line)
3749 proc
3756 ;; Remove watch when file or directory to be watched is deleted.
3759 ;; Usually, we would add an Emacs event now. Unfortunately,
3760 ;; `unread-command-events' does not accept several events at
3761 ;; once. Therefore, we apply the handler directly.
3764 'file-notify-handle-event
3767 ;;; Internal Functions:
3770 "Define in remote shell function NAME implemented as SCRIPT.
3771 Only send the definition if it has not already been done."
3772 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3773 ;; might be nil.
3779 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3780 ;; could result in unwanted command expansion. Avoid this.
3783 ;; The script could contain a call of Perl. This is masked with `%s'.
3788 vec
3796 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3797 Returns the exit code of the `test' program."
3800 v
3802 "%s %s %s"
3804 switch
3808 "Run `test'-like program on the remote system, given FILE1, FILE2.
3809 FORMAT-STRING contains the program name, switches, and place holders.
3810 Returns the exit code of the `test' program. Barfs if the methods,
3811 hosts, or files, disagree."
3815 v 'file-error
3820 v1
3827 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3828 First arg VEC specifies the connection, PROGNAME is the program
3829 to search for, and DIRLIST gives the list of directories to
3830 search. If IGNORE-TILDE is non-nil, directory names starting
3831 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3832 only in DIRLIST.
3834 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3836 This function expects to be in the right *tramp* buffer."
3839 ;; Check whether the executable is in $PATH. "which(1)" does not
3840 ;; report always a correct error code; therefore we check the
3841 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3842 ;; 5.11") have problems with this command, we disable the call
3843 ;; therefore.
3854 ;; Remove all ~/foo directories from dirlist.
3863 vec
3865 "do if test -x $d/%s && test -f $d/%s; "
3866 "then echo tramp_executable $d/%s; "
3869 progname progname progname
3870 tramp-end-of-heredoc
3872 tramp-end-of-heredoc))
3878 result)))
3881 "Sets the remote environment PATH to existing directories.
3882 I.e., for each directory in `tramp-remote-path', it is tested
3883 whether it exists and if so, it is added to the environment
3884 variable PATH."
3890 ;; ------------------------------------------------------------
3891 ;; -- Communication with external shell --
3892 ;; ------------------------------------------------------------
3895 "Find a command on the remote host for checking if a file exists.
3896 Here, we are looking for a command which has zero exit status if the
3897 file exists and nonzero exit status otherwise."
3901 result)
3902 ;; The algorithm is as follows: we try a list of several commands.
3903 ;; For each command, we first run `$cmd /' -- this should return
3904 ;; true, as the root directory always exists. And then we run
3905 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3906 ;; does not exist. This should return false. We use the first
3907 ;; command we find that seems to work.
3908 ;; The list of commands to try is as follows:
3909 ;; `ls -d' This works on most systems, but NetBSD 1.4
3910 ;; has a bug: `ls' always returns zero exit
3911 ;; status, even for files which don't exist.
3912 ;; `test -e' Some Bourne shells have a `test' builtin
3913 ;; which does not know the `-e' option.
3914 ;; `/bin/test -e' For those, the `test' binary on disk normally
3915 ;; provides the option. Alas, the binary
3916 ;; is sometimes `/bin/test' and sometimes it's
3917 ;; `/usr/bin/test'.
3918 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3946 result))
3949 "Opens shell SHELL."
3952 ;; Find arguments for this shell.
3954 item extra-args)
3959 ;; It is useful to set the prompt in the following command
3960 ;; because some people have a setting for $PS1 which /bin/sh
3961 ;; doesn't know about and thus /bin/sh will display a strange
3962 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3963 ;; ksh will display the current working directory but /bin/sh
3964 ;; will display a dollar sign. The following command line sets
3965 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3966 ;; well as csh-like shells. We also unset the variable $ENV
3967 ;; because that is read by some sh implementations (eg, bash
3968 ;; when called as sh) on startup; this way, we avoid the startup
3969 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3970 ;; the prompt in /bin/bash, it must be discarded as well.
3971 ;; $HISTFILE is set according to `tramp-histfile-override'.
3974 "exec env ENV=%s %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3980 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3984 t)
3985 ;; Check proper HISTFILE setting. We give up when not working.
3989 vec
3991 "(cd %s)"
3994 "`tramp-histfile-override' uses invalid file `%s'"
3995 tramp-histfile-override)))
4001 "Opens a shell on the remote host which groks tilde expansion."
4004 shell)
4007 ;; CCC: "root" does not exist always, see my QNAP TS-459.
4008 ;; Which check could we apply instead?
4011 ;; The default shell (ksh93) of OpenSolaris and
4012 ;; Solaris is buggy. We've got reports for
4013 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4022 ;; Maybe it works at least for some other commands.
4024 default-shell
4026 vec 2
4028 "Couldn't find a remote shell which groks tilde "
4030 default-shell)))
4032 default-shell)))
4034 ;; Open a new shell if needed.
4040 ;; Utility functions.
4043 "Wait for shell prompt and barf if none appears.
4044 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4045 seconds. If not, it produces an error message with the given ERROR-ARGS."
4049 proc timeout
4058 "Set up an interactive shell.
4059 Mainly sets the prompt and the echo correctly. PROC is the shell
4060 process to set up. VEC specifies the connection."
4065 ;; Disable echo expansion.
4069 ;; Check whether the echo has really been disabled. Some
4070 ;; implementations, like busybox of embedded GNU/Linux, don't
4071 ;; support disabling.
4078 ;; Make sure backspaces and their echo are enabled and no line
4079 ;; width magic interferes with them.
4086 t)
4088 ;; Check whether the output of "uname -sr" has been changed. If
4089 ;; yes, this is a strong indication that we must expire all
4090 ;; connection properties. We start again with
4091 ;; `tramp-maybe-open-connection', it will be caught there.
4096 vec "uname"
4100 vec 3
4101 "Connection reset, because remote host changed from `%s' to `%s'"
4102 old-uname uname)
4103 ;; We want to keep the password.
4107 ;; Try to set up the coding system correctly.
4108 ;; CCC this can't be the right way to do it. Hm.
4111 ;; Use MULE to select the right EOL convention for communicating
4112 ;; with the process.
4118 cs-decode cs-encode)
4122 cs-encode
4129 ;; Special setting for macOS.
4140 ;; Check whether the remote host suffers from buggy
4141 ;; `send-process-string'. This is known for FreeBSD (see comment
4142 ;; in `send_process', file process.c). I've tested sending 624
4143 ;; bytes successfully, sending 625 bytes failed. Emacs makes a
4144 ;; hack when this host type is detected locally. It cannot handle
4145 ;; remote hosts, though.
4149 tramp-chunksize)
4155 ;; Set remote PATH variable.
4158 ;; Search for a good shell before searching for a command which
4159 ;; checks if a file exists. This is done because Tramp wants to
4160 ;; use "test foo; echo $?" to check if various conditions hold,
4161 ;; and there are buggy /bin/sh implementations which don't execute
4162 ;; the "echo $?" part if the "test" part has an error. In
4163 ;; particular, the OpenSolaris /bin/sh is a problem. There are
4164 ;; also other problems with /bin/sh of OpenSolaris, like
4165 ;; redirection of stderr in function declarations, or changing
4166 ;; HISTFILE in place. Therefore, OpenSolaris' /bin/sh is replaced
4167 ;; by bash, when detected.
4170 ;; Disable unexpected output.
4173 ;; IRIX64 bash expands "!" even when in single quotes. This
4174 ;; destroys our shell functions, we must disable it. See
4175 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4179 ;; Disable tab expansion.
4184 ;; Set utf8 encoding. Needed for macOS, for example. This is
4185 ;; non-POSIX, so we must expect errors on some systems.
4188 ;; Set `remote-tty' process property.
4193 ;; Dump stty settings in the traces.
4197 ;; Set the environment.
4211 vec
4213 tramp-end-of-heredoc
4215 tramp-end-of-heredoc)
4216 t))
4221 ;; Old text from documentation of tramp-methods:
4222 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4223 ;; of the base64 methods instead since base64 encoding is much more
4224 ;; reliable and the commands are more standardized between the different
4225 ;; Unix versions. But if you can't use base64 for some reason, please
4226 ;; note that the default uudecode command does not work well for some
4227 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4228 ;; the following command for uudecode:
4229 ;;
4230 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4231 ;;
4232 ;; For Irix, no solution is known yet.
4240 "List of local coding commands for inline transfer.
4241 Each item is a list that looks like this:
4243 \(FORMAT ENCODING DECODING)
4245 FORMAT is symbol describing the encoding/decoding format. It can be
4246 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4248 ENCODING and DECODING can be strings, giving commands, or symbols,
4249 giving functions. If they are strings, then they can contain
4251 file name will be put into the command line at that spot. If the
4252 specifier is not present, the input should be read from standard
4253 input.
4255 If they are functions, they will be called with two arguments, start
4256 and end of region, and are expected to replace the region contents
4261 ;; "-i" is more robust with older base64 from GNU coreutils.
4262 ;; However, I don't know whether all base64 versions do supports
4263 ;; this option.
4271 ;; This is painful slow, so we put it on the end.
4278 "List of remote coding commands for inline transfer.
4279 Each item is a list that looks like this:
4281 \(FORMAT ENCODING DECODING [TEST])
4283 FORMAT is a symbol describing the encoding/decoding format. It can be
4284 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4286 ENCODING and DECODING can be strings, giving commands, or symbols,
4287 giving variables. If they are strings, then they can contain
4289 file name will be put into the command line at that spot. If the
4290 specifier is not present, the input should be read from standard
4291 input.
4293 If they are variables, this variable is a string containing a
4294 Perl or Shell implementation for this functionality. This
4295 program will be transferred to the remote host, and it is
4297 specifier in the variable value denotes a temporary file.
4299 The optional TEST command can be used for further tests, whether
4303 "Find an inline transfer encoding that works.
4304 Goes through the list `tramp-local-coding-commands' and
4305 `tramp-remote-coding-commands'."
4310 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4318 ;; If the local encoder or decoder is a string, the
4319 ;; corresponding command has to work locally.
4326 loc-enc nil nil))
4334 loc-dec nil nil))
4336 ;; Search for remote coding commands with the same format
4344 ;; Check the remote test command if exists.
4350 ;; Check if remote perl exists when necessary.
4355 ;; Check if remote encoding and decoding commands can be
4356 ;; called remotely with null input and output. This makes
4357 ;; sure there are no syntax errors and the command is really
4358 ;; found. Note that we do not redirect stdout to /dev/null,
4359 ;; for two reasons: when checking the decoding command, we
4360 ;; actually check the output it gives. And also, when
4361 ;; redirecting "mimencode" output to /dev/null, then as root
4362 ;; it might change the permissions of /dev/null!
4370 vec 5
4379 tmpfile)
4386 tramp-temp-name-prefix
4388 value
4390 value
4392 ?t
4397 vec 5
4400 vec
4402 t)
4410 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4416 ;; Set connection properties. Since the commands are risky
4417 ;; (due to output direction), we cache them in the process cache.
4428 "Call the local encoding or decoding command.
4430 Otherwise, INPUT is passed via standard input.
4431 INPUT can also be nil which means `/dev/null'.
4432 OUTPUT can be a string (which specifies a file name), or t (which
4433 means standard output and thus the current buffer), or nil (which
4434 means discard it)."
4436 nil tramp-encoding-shell
4439 nil
4440 tramp-encoding-command-switch
4450 "List of compress and decompress commands for inline transfer.
4451 Each item is a list that looks like this:
4453 \(COMPRESS DECOMPRESS)
4458 "Find an inline transfer compress command that works.
4459 Goes through the list `tramp-inline-compress-commands'."
4464 item compress decompress found)
4471 vec 5
4472 "Checking local compress commands `%s', `%s' for sanity"
4473 compress decompress)
4478 ;; Windows shells need the program file name after
4479 ;; the pipe symbol be quoted if they use forward
4480 ;; slashes as directory separators.
4487 vec 5
4488 "Checking remote compress commands `%s', `%s' for sanity"
4489 compress decompress)
4495 ;; Did we find something?
4498 ;; Set connection properties. Since the commands are
4499 ;; risky (due to output direction), we cache them in the
4500 ;; process cache.
4514 "Expands VEC according to `tramp-default-proxies-alist'.
4515 Gateway hops are already opened."
4519 choices proxy)
4521 ;; Ad-hoc proxy definitions.
4526 tramp-prefix-format proxy tramp-postfix-host-format)))
4531 proxy)
4532 ;; Add the hop.
4534 'tramp-default-proxies-alist
4537 proxy))
4539 ;; Save the new value.
4544 ;; Look for proxy hosts to be passed.
4550 ;; Host.
4553 ;; User.
4557 ;; No more hops needed.
4559 ;; Replace placeholders.
4562 proxy
4567 ;; Add the hop.
4569 ;; Start next search.
4572 ;; Handle gateways.
4580 ;; Is the method prepared for gateways?
4583 vec 'file-error
4585 ;; Open the gateway connection.
4590 target-alist)
4591 ;; For the password prompt, we need the correct values.
4592 ;; Therefore, we must remember the gateway vector. But we
4593 ;; cannot do it as connection property, because it shouldn't
4594 ;; be persistent. And we have no started process yet either.
4598 ;; Foreign and out-of-band methods are not supported for multi-hops.
4605 vec 'file-error
4606 "Method `%s' is not supported for multi-hops."
4609 ;; In case the host name is not used for the remote shell
4610 ;; command, the user could be misguided by applying a random
4611 ;; host name.
4617 ;; There are multi-hops.
4619 ;; The host name is used for the remote shell command.
4621 ;; The host is local. We cannot use `tramp-local-host-p'
4622 ;; here, because it opens a connection as well.
4625 v 'file-error
4626 "Host `%s' looks like a remote host, `%s' can only use the local host"
4627 host method)))
4629 ;; Result.
4630 target-alist))
4633 "Return the Control* arguments of the local ssh."
4635 ;; No options to be computed.
4640 ;; There is already a value to be used.
4643 ;; Determine the options.
4655 ;; We use a non-existing IP address, in order to avoid
4656 ;; useless connections, and DNS timeouts.
4663 " -o ControlPath='tramp.%%r@%%h:%%p'"
4672 tramp-ssh-controlmaster-options)))
4675 "Maybe open a connection VEC.
4676 Does not do anything if a connection is already open, but re-opens the
4677 connection if a previous connection has died for some reason."
4685 ;; If Tramp opens the same connection within a short time frame,
4686 ;; there is a problem. We shall signal this.
4695 ;; If too much time has passed since last command was sent, look
4696 ;; whether process is still alive. If it isn't, kill it. When
4697 ;; using ssh, it can sometimes happen that the remote end has hung
4698 ;; up but the local ssh client doesn't recognize this until it
4699 ;; tries to send some data to the remote end. So that's why we
4700 ;; try to send a command from time to time, then look again
4701 ;; whether the process is really alive.
4712 ;; The error will be caught locally.
4718 ;; New connection must be opened.
4722 ;; If `non-essential' is non-nil, don't reopen a new connection.
4723 ;; This variable has been introduced with Emacs 24.1.
4728 vec 3
4739 ;; Start new process.
4756 ;; We will apply `tramp-ssh-controlmaster-options'
4757 ;; only for the first hop.
4761 ;; There are unfortunate settings for "cmdproxy" on
4762 ;; W32 systems.
4765 ;; This must be done in order to avoid our file
4766 ;; name handler.
4770 'start-process
4775 tramp-encoding-command-interactive)
4778 ;; Set sentinel and query flag.
4789 ;; Check whether process is alive.
4791 p 10
4794 ;; Now do all the connections as specified.
4820 ;; We don't create the temporary file. In
4821 ;; fact, it is just a prefix for the
4822 ;; ControlPath option of ssh; the real
4823 ;; temporary file has another name, and it is
4824 ;; created and protected by ssh. It is also
4825 ;; removed by ssh when the connection is
4826 ;; closed. The temporary file name is cached
4827 ;; in the main connection process, therefore
4828 ;; we cannot use `tramp-get-connection-process'.
4834 tramp-temp-name-prefix
4836 spec r-shell)
4838 ;; Add arguments for asynchronous processes.
4842 ;; Add gateway arguments if necessary.
4848 ;; Check for port number. Until now, there's no
4849 ;; need for handling like method, user, host.
4854 ;; Check, whether there is a restricted shell.
4859 ;; Set variables for computing the prompt for
4860 ;; reading password. They can also be derived
4861 ;; from a gateway.
4866 ;; Add login environment.
4869 login-env
4874 login-env))
4878 "%s=%s %s"
4881 command)))
4884 ;; Replace `login-args' place holders.
4892 ?h l-host ?u l-user ?p l-port ?c options)
4893 command
4895 ;; We do not want to see the trailing local
4896 ;; prompt in `start-file-process'.
4898 command " "
4904 ;; Local shell could be a Windows COMSPEC. It
4905 ;; doesn't know the ";" syntax, but we must exit
4906 ;; always for `start-file-process'. It could
4907 ;; also be a restricted shell, which does not
4908 ;; allow "exec".
4911 ;; Send the command.
4915 p vec
4918 tramp-actions-before-shell
4922 ;; Next hop.
4926 ;; Set connection-local variables.
4929 ;; Make initial shell settings.
4932 ;; Mark it as connected.
4935 ;; Cleanup, and propagate the signal.
4941 "Send the COMMAND to connection VEC.
4942 Erases temporary buffer before sending the command. If optional
4943 arg NEVEROPEN is non-nil, never try to open the connection. This
4944 is meant to be used from `tramp-maybe-open-connection' only. The
4945 function waits for output unless NOOUTPUT is set."
4949 ;; We mark the command string that it can be erased in the output buffer.
4951 ;; If we put `tramp-echo-mark' after a trailing newline (which
4952 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4953 ;; that newline and adds `tramp-rsh-end-of-line' right after
4954 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4955 ;; trailing line endings and sends two prompts after executing
4956 ;; the command, which confuses `tramp-wait-for-output'.
4960 ;; No need to restore a trailing newline here since `tramp-send-string'
4961 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4963 ;; Send the command.
4969 "Wait for output from remote command."
4975 ;; be leading escape sequences, which must be ignored.
4976 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4977 ;; option send also escape sequences, which must be
4978 ;; ignored.
4981 tramp-device-escape-sequence-regexp))
4982 ;; Sometimes, the commands do not return a newline but a
4983 ;; null byte before the shell prompt, for example "git
4984 ;; ls-files -c -z ...".
4989 ;; A simple-minded busybox has sent " ^H" sequences.
4990 ;; Delete them.
4995 ;; Delete the prompt.
5001 proc 'file-error
5002 "[[Remote prompt `%s' not found in %d secs]]"
5003 tramp-end-of-output timeout)
5005 proc 'file-error
5007 ;; Return value is whether end-of-output sentinel was found.
5008 found)))
5012 "Run COMMAND and check its exit status.
5013 Sends `echo $?' along with the COMMAND for checking the exit status.
5014 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5015 status is 0, and nil otherwise.
5017 If the optional argument SUBSHELL is non-nil, the command is
5018 executed in a subshell, ie surrounded by parentheses. If
5019 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5021 vec
5023 command
5025 "echo tramp_exit_status $?"
5039 "Run COMMAND, check exit status, throw error if exit status not okay.
5040 Similar to `tramp-send-command-and-check' but accepts two more arguments
5041 FMT and ARGS which are passed to `error'."
5046 "Run COMMAND and return the output, which must be a Lisp expression.
5047 If MARKER is a regexp, read the output after that string.
5048 In case there is no valid Lisp expression and NOERROR is nil, it
5049 raises an error."
5056 ;; Read the marker.
5062 vec 'file-error
5063 "`%s' does not return the marker `%s': `%s'"
5065 ;; Read the expression.
5068 ;; Error handling.
5073 vec 'file-error
5074 "`%s' does not return a valid Lisp expression: `%s'"
5078 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5079 Convert file mode bits to string and set virtual device number.
5080 Return ATTR."
5082 ;; Remove color escape sequences from symlink.
5086 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5087 ;; indication of unusable value.
5098 ;; Convert last access time.
5103 ;; Convert last modification time.
5108 ;; Convert last status change time.
5113 ;; Convert file size.
5119 ;; Convert file mode bits to string.
5124 ;; Convert directory indication bit.
5127 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5133 ;; Set file's gid change bit.
5141 ;; Convert inode.
5147 ;; Inodes can be incredible huge. We must hide this.
5149 ;; Set virtual device number.
5152 attr))
5155 "Converts STRING to shell glob pattern which ignores case."
5161 string
5165 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5176 localname)
5183 "Return t if this is an out-of-band method, nil otherwise."
5185 ;; It shall be an out-of-band method.
5187 ;; There must be a size, otherwise the file doesn't exist.
5189 ;; Either the file size is large enough, or (in rare cases) there
5190 ;; does not exist a remote encoding.
5195 ;; Variables local to connection.
5198 "Compile list of remote directories for $PATH.
5199 Nonexistent directories are removed from spec."
5201 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5202 ;; cache the result for the session only. Otherwise, the result
5203 ;; is cached persistently.
5206 vec)
5207 "remote-path"
5216 ;; Default if "getconf" is not available.
5219 vec 3
5224 ;; The login shell could return more than just the $PATH
5225 ;; string. So we use `tramp-end-of-heredoc' as marker.
5229 vec
5234 'identity
5238 'identity
5246 nil)))))
5248 ;; Replace place holder `tramp-default-remote-path'.
5256 ;; Replace place holder `tramp-own-remote-path'.
5264 ;; Remove double entries.
5271 ;; Remove non-existing directories.
5273 nil
5283 x))
5284 x))
5285 remote-path)))))
5288 "Determine remote locale, supporting UTF8 if possible."
5292 locale)
5299 candidates nil)
5301 ;; Return value.
5305 "Determine remote `ls' command."
5312 result)
5314 ;; Check parameters. On busybox, "ls" output coloring is
5315 ;; enabled by default sometimes. So we try to disable it
5316 ;; when possible. $LS_COLORING is not supported there.
5317 ;; Some "ls" versions are sensible wrt the order of
5318 ;; arguments, they fail when "-al" is after the
5319 ;; "--color=never" argument (for example on FreeBSD).
5331 "Check, whether the remote `ls' command supports the --dired option."
5335 ;; Some "ls" versions are sensible wrt the order of arguments,
5336 ;; they fail when "-al" is after the "--dired" argument (for
5337 ;; example on FreeBSD).
5342 "Check, whether the remote `ls' command supports the --quoting-style option."
5351 "Check, whether the remote `ls' command supports the -w option."
5355 ;; Option "-w" is available on BSD systems. No argument is
5356 ;; given, because this could return wrong results in case "ls"
5357 ;; supports the "-w NUM" argument, as for busyboxes.
5362 "Determine remote `test' command."
5366 "test"
5370 "Check, whether the remote `test' command supports the -nt option."
5371 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5372 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5373 ;; for otherwise the shell crashes.
5385 vec
5392 "Determine remote command for file existing check."
5398 "Determine remote `ln' command."
5404 "Determine remote `perl' command."
5410 ;; Perform a basic check.
5415 ;; We must check also for some Perl modules.
5423 result)))
5426 "Determine remote `stat' command."
5431 tmp)
5432 ;; Check whether stat(1) returns usable syntax. "%s" does not
5433 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5434 ;; use shell quoted format for "%N", we check the boundaries "`"
5435 ;; and "'", therefore. See Bug#23422 in coreutils.
5444 result)))
5447 "Determine remote `readlink' command."
5455 result))))
5458 "Determine remote `trash' command."
5464 "Determine remote `touch' command."
5473 ;; Busyboxes do support the "-t" option only when they have been
5474 ;; built with the DESKTOP config option. Let's check it.
5477 vec "touch-t"
5479 vec
5481 "%s -t %s %s"
5482 result
5486 result)))
5489 "Determine remote `gvfs-monitor-dir' command."
5496 "Determine remote `inotifywait' command."
5502 "Determine remote `id' command."
5508 result)
5510 ;; Check POSIX parameter.
5516 "Implement `tramp-get-remote-uid' for Tramp files using `id'."
5518 vec
5526 "Implement `tramp-get-remote-uid' for Tramp files using a Perl script."
5528 vec
5532 "print $>"
5536 "Determine remote `python' command."
5544 "Implement `tramp-get-remote-uid' for Tramp files using `python'."
5546 vec
5550 "import os; print (os.getuid())"
5554 "The uid of the remote connection VEC, in ID-FORMAT.
5555 ID-FORMAT valid values are `string' and `integer'."
5566 ;; Ensure there is a valid result.
5569 tramp-unknown-id-integer)
5571 tramp-unknown-id-string)
5575 "Implement `tramp-get-remote-gid' for Tramp files using `id'."
5577 vec
5585 "Implement `tramp-get-remote-gid' for Tramp files using a Perl script."
5587 vec
5595 "Implement `tramp-get-remote-gid' for Tramp files using `python'."
5597 vec
5601 "import os; print (os.getgid())"
5605 "The gid of the remote connection VEC, in ID-FORMAT.
5606 ID-FORMAT valid values are `string' and `integer'."
5617 ;; Ensure there is a valid result.
5620 tramp-unknown-id-integer)
5622 tramp-unknown-id-string)
5626 "Check, whether the remote `env' command supports the -u option."
5629 ;; Option "-u" is a GNU extension.
5633 ;; Some predefined connection properties.
5635 "Return the compress command related to PROP.
5636 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5637 the length of the file to be compressed.
5639 If no corresponding command is found, nil is returned."
5648 "Return the coding command related to PROP.
5649 PROP is either `remote-encoding', `remote-decoding',
5650 `local-encoding' or `local-decoding'.
5652 SIZE is the length of the file to be coded. Depending on SIZE,
5653 compression might be applied.
5655 If no corresponding command is found, nil is returned.
5656 Otherwise, either a string is returned which contains a `%s' mark
5657 to be used for the respective input or output file; or a Lisp
5658 function cell is returned to be applied on a buffer."
5659 ;; We must catch the errors, because we want to return nil, when
5660 ;; no inline coding is found.
5670 compress)
5671 ;; The connection property might have been cached. So we must
5672 ;; send the script to the remote side - maybe.
5680 ;; Check for the `compress' command.
5682 ;; Return the value.
5703 coding)
5706 ;; Windows shells need the program file name after
5707 ;; the pipe symbol be quoted if they use forward
5708 ;; slashes as directory separators.
5715 coding compress))
5718 ;; Windows shells need the program file name after
5719 ;; the pipe symbol be quoted if they use forward
5720 ;; slashes as directory separators.
5725 compress coding))
5739 ;;; TODO:
5741 ;; * Don't use globbing for directories with many files, as this is
5742 ;; likely to produce long command lines, and some shells choke on
5743 ;; long command lines.
5744 ;;
5745 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5746 ;; then look if it's the right version (with `perl -v').
5747 ;;
5748 ;; * When editing a remote CVS controlled file as a different user, VC
5749 ;; gets confused about the file locking status. Try to find out why
5750 ;; the workaround doesn't work.
5751 ;;
5752 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5753 ;; until the last but one hop via `start-file-process'. Apply it
5754 ;; also for ftp and smb.
5755 ;;
5756 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5757 ;; some shell with root privileges, it would be nice if I could
5758 ;; just call
5759 ;; trampclient filename.c
5760 ;; as an editor, and the _current_ shell would connect to an Emacs
5761 ;; server and would be used in an existing non-privileged Emacs
5762 ;; session for doing the editing in question.
5763 ;; That way, I need not tell Emacs my password again and be afraid
5764 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5765 ;; once display a just typed password in the context of a keyboard
5766 ;; sequence prompt for a question immediately following in a shell
5767 ;; script run within Emacs -- nasty).
5768 ;; And if I have some ssh session running to a different computer,
5769 ;; having the possibility of passing a local file there to a local
5770 ;; Emacs session (in case I can arrange for a connection back) would
5771 ;; be nice.
5772 ;; Likely the corresponding Tramp server should not allow the
5773 ;; equivalent of the emacsclient -eval option in order to make this
5774 ;; reasonably unproblematic. And maybe trampclient should have some
5775 ;; way of passing credentials, like by using an SSL socket or
5776 ;; something. (David Kastrup)
5777 ;;
5778 ;; * Reconnect directly to a compliant shell without first going
5779 ;; through the user's default shell. (Pete Forman)
5780 ;;
5781 ;; * How can I interrupt the remote process with a signal
5782 ;; (interrupt-process seems not to work)? (Markus Triska)
5783 ;;
5784 ;; * Avoid the local shell entirely for starting remote processes. If
5785 ;; so, I think even a signal, when delivered directly to the local
5786 ;; SSH instance, would correctly be propagated to the remote process
5787 ;; automatically; possibly SSH would have to be started with
5788 ;; "-t". (Markus Triska)
5789 ;;
5790 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5791 ;; isn't on the remote host. (Mark A. Hershberger)
5792 ;;
5793 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5794 ;;
5795 ;; * Optimize out-of-band copying when both methods are scp-like (not
5796 ;; rsync).
5797 ;;
5798 ;; * Keep a second connection open for out-of-band methods like scp or
5799 ;; rsync.
5800 ;;
5801 ;; * Implement completion for "/method:user@host:~<abc> TAB".
5802 ;;
5803 ;; * I think you could get the best of both worlds by using an
5804 ;; approach similar to Tramp but running a little tramp-daemon on
5805 ;; the other end, such that we can use a more efficient
5806 ;; communication protocol (e.g. when saving a file we could locally
5807 ;; diff it against the last version (of which the remote daemon
5808 ;; would also keep a copy), and then only send the diff).
5809 ;;
5810 ;; This said, even using such a daemon it might be difficult to get
5811 ;; good performance: part of the problem is the number of
5812 ;; round-trips. E.g. when saving a file we have to check if the
5813 ;; file was modified in the mean time and whether saving into a new
5814 ;; inode would change the owner (etc...), which each require a
5815 ;; round-trip. To get rid of these round-trips, we'd have to
5816 ;; shortcut this code and delegate the higher-level "save file"
5817 ;; operation to the remote server, which then has to perform those
5818 ;; tasks but still obeying the locally set customizations about how
5819 ;; to do each one of those tasks.
5820 ;;
5821 ;; We could either put higher-level ops in there (like
5822 ;; `save-buffer'), which implies replicating the whole `save-buffer'
5823 ;; behavior, which is a lot of work and likely to be not 100%
5824 ;; faithful.
5825 ;;
5826 ;; Or we could introduce new low-level ops that are asynchronous,
5827 ;; and then rewrite save-buffer to use them. IOW save-buffer would
5828 ;; start with a bunch of calls like `start-getting-file-attributes'
5829 ;; which could immediately be passed on to the remote side, and
5830 ;; later on checks the return value of those calls as and when
5831 ;; needed. (Stefan Monnier)
5833 ;;; tramp-sh.el ends here