| blob | 19f687c3433a17efa291231366ea2f13fd66174a |
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."
51 ;;;###tramp-autoload
53 "The maximum file size where inline copying is preferred over an \
54 out-of-the-band copy.
55 If it is nil, out-of-the-band copy will be used without a check."
59 ;;;###tramp-autoload
61 "Value of TERM environment variable for logging in to remote host.
62 Because Tramp wants to parse the output of the remote shell, it is easily
63 confused by ANSI color escape sequences and suchlike. Often, shell init
64 files conditionalize this setup based on the TERM environment variable."
68 ;;;###tramp-autoload
70 "When invoking a shell, override the HISTFILE with this value.
71 When setting to a string, it redirects the shell history to that
75 The value t, the default value, unsets any setting of HISTFILE,
76 and sets both HISTFILESIZE and HISTSIZE to 0. If you set this
77 variable to nil, however, the *override* is disabled, so the
78 history will go to the default storage location,
86 ;;;###tramp-autoload
90 ;;;###tramp-autoload
94 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
95 ;; root users. It uses the `$' character for other users. In order
96 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
100 "///%s#$"
102 "String used to recognize end of output.
103 The `$' character at the end is quoted; the string cannot be
106 ;;;###tramp-autoload
113 ;;;###tramp-autoload
115 "Whether to use `tramp-ssh-controlmaster-options'."
121 "Which ssh Control* arguments to use.
123 If it is a string, it should have the form
126 spec must be doubled, because the string is used as format string.
128 Otherwise, it will be auto-detected by Tramp, if
129 `tramp-use-ssh-controlmaster-options' is non-nil. The value
130 depends on the installed local ssh version.
134 ;; Initialize `tramp-methods' with the supported methods.
135 ;;;###tramp-autoload
147 ;;;###tramp-autoload
158 ;;;###tramp-autoload
176 ;;;###tramp-autoload
195 ;;;###tramp-autoload
211 ;;;###tramp-autoload
219 ;;;###tramp-autoload
227 ;;;###tramp-autoload
241 ;;;###tramp-autoload
255 ;;;###tramp-autoload
264 ;;;###tramp-autoload
273 ;; We use "-v" for better error tracking.
276 ;; We use "-p" as required for newer busyboxes. For older
277 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
278 ;; can be achieved by tweaking `tramp-connection-properties'.
281 ;;;###tramp-autoload
290 ;;;###tramp-autoload
292 'tramp-methods
299 ;;;###tramp-autoload
303 ;; The password template must be masked. Otherwise, it could be
304 ;; interpreted as password prompt if the remote host echoes the command.
307 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
313 ;;;###tramp-autoload
321 ;;;###tramp-autoload
330 ;;;###tramp-autoload
338 ;;;###tramp-autoload
342 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
346 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
347 tramp-terminal-type
348 tramp-initial-end-of-output))
354 ;;;###tramp-autoload
360 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
361 tramp-terminal-type
362 tramp-initial-end-of-output))
367 ;;;###tramp-autoload
374 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
375 tramp-terminal-type
376 tramp-initial-end-of-output))
387 ;;;###tramp-autoload
394 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
395 tramp-terminal-type
396 tramp-initial-end-of-output))
405 ;;;###tramp-autoload
417 ;;;###tramp-autoload
421 ;;;###tramp-autoload
425 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
426 ;; Do not add "plink" based methods, they ask interactively for the user.
427 ;;;###tramp-autoload
436 ;;;###tramp-autoload
442 ;;;###tramp-autoload
458 ;;;###tramp-autoload
463 ;;;###tramp-autoload
468 ;;;###tramp-autoload
473 ;;;###tramp-autoload
481 ;;;###tramp-autoload
510 ;; "getconf PATH" yields:
511 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
512 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
513 ;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
514 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
515 ;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
516 ;; IRIX64: /usr/bin
517 ;;;###tramp-autoload
523 "List of directories to search for executables on remote host.
524 For every remote host, this variable will be set buffer local,
525 keeping the list of existing directories on that host.
527 You can use `~' in this list, but when searching for a shell which groks
528 tilde expansion, all directory names starting with `~' will be ignored.
530 `Default Directories' represent the list of directories given by
532 entry on top of this list, because these are the default
533 directories for POSIX compatible commands. On remote hosts which
534 do not offer the getconf command (like cygwin), the value
537 `Private Directories' are the settings of the $PATH environment,
538 as given in your `~/.profile'."
545 ;;;###tramp-autoload
552 "List of environment variables to be set on the remote host.
554 Each element should be a string of the form ENVVARNAME=VALUE. An
555 entry ENVVARNAME= disables the corresponding environment variable,
556 which might have been set in the init files like ~/.profile.
558 Special handling is applied to the PATH environment, which should
559 not be set here. Instead, it should be set via `tramp-remote-path'."
564 ;;;###tramp-autoload
566 "Alist specifying extra arguments to pass to the remote shell.
567 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
568 matching the shell file name and ARGS is a string specifying the
569 arguments.
571 This variable is only used when Tramp needs to start up another shell
572 for tilde expansion. The extra arguments should typically prevent the
573 shell from reading its init file."
575 ;; This might be the wrong way to test whether the widget type
576 ;; `alist' is available. Who knows the right way to test it?
591 "List of pattern/action pairs.
592 Whenever a pattern matches, the corresponding action is performed.
593 Each item looks like (PATTERN ACTION).
595 The PATTERN should be a symbol, a variable. The value of this
596 variable gives the regular expression to search for. Note that the
598 appended to it.
600 The ACTION should also be a symbol, but a function. When the
608 "List of pattern/action pairs.
609 This list is used for copying/renaming with out-of-band methods.
614 "(echo begin 600 %t; tail -n +2) | uudecode
615 cat %t
616 rm -f %t"
617 "Shell function to implement `uudecode' to standard output.
618 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
619 for this or `uudecode -p', but some systems don't, and for them
623 "%s -e '
624 use File::Spec;
627 sub myrealpath {
628 my ($file) = @_;
629 return realpath($file) if -e $file;
630 }
632 sub recursive {
633 my ($volume, @dirs) = @_;
634 my $real = myrealpath(File::Spec->catpath(
636 if ($real) {
637 my ($vol, $dir) = File::Spec->splitpath($real, 1);
638 return ($vol, File::Spec->splitdir($dir));
639 }
640 else {
641 my $last = pop(@dirs);
642 ($volume, @dirs) = recursive($volume, @dirs);
643 push(@dirs, $last);
644 return ($volume, @dirs);
645 }
646 }
648 $result = myrealpath($ARGV[0]);
649 if (!$result) {
650 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
651 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
654 }
659 "Perl script to produce output suitable for use with `file-truename'
660 on the remote file system.
661 Escape sequence %s is replaced with name of Perl binary.
665 "%s -e '
667 @files = readdir(d); closedir(d);
668 foreach $f (@files) {
671 }
672 else {
674 }
675 }
678 "Perl script to produce output suitable for use with
679 `file-name-all-completions' on the remote file system. Escape
680 sequence %s is replaced with name of Perl binary. This string is
683 ;; Perl script to implement `file-attributes' in a Lisp `read'able
684 ;; output. If you are hacking on this, note that you get *no* output
685 ;; unless this spits out a complete line, including the '\n' at the
686 ;; end.
687 ;; The device number is returned as "-1", because there will be a virtual
688 ;; device number set in `tramp-sh-handle-file-attributes'.
690 "%s -e '
691 @stat = lstat($ARGV[0]);
692 if (!@stat) {
694 exit 0;
695 }
696 if (($stat[2] & 0170000) == 0120000)
697 {
698 $type = readlink($ARGV[0]);
701 }
702 elsif (($stat[2] & 0170000) == 040000)
703 {
705 }
706 else
707 {
709 };
712 printf(
714 $type,
715 $stat[3],
716 $uid,
717 $gid,
718 $stat[8] >> 16 & 0xffff,
719 $stat[8] & 0xffff,
720 $stat[9] >> 16 & 0xffff,
721 $stat[9] & 0xffff,
722 $stat[10] >> 16 & 0xffff,
723 $stat[10] & 0xffff,
724 $stat[7],
725 $stat[2],
726 $stat[1] >> 16 & 0xffff,
727 $stat[1] & 0xffff
729 "Perl script to produce output suitable for use with `file-attributes'
730 on the remote file system.
731 Escape sequence %s is replaced with name of Perl binary.
735 "%s -e '
738 @list = readdir(DIR);
739 closedir(DIR);
740 $n = scalar(@list);
742 for($i = 0; $i < $n; $i++)
743 {
744 $filename = $list[$i];
745 @stat = lstat($filename);
746 if (($stat[2] & 0170000) == 0120000)
747 {
748 $type = readlink($filename);
751 }
752 elsif (($stat[2] & 0170000) == 040000)
753 {
755 }
756 else
757 {
759 };
763 printf(
764 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
765 $filename,
766 $type,
767 $stat[3],
768 $uid,
769 $gid,
770 $stat[8] >> 16 & 0xffff,
771 $stat[8] & 0xffff,
772 $stat[9] >> 16 & 0xffff,
773 $stat[9] & 0xffff,
774 $stat[10] >> 16 & 0xffff,
775 $stat[10] & 0xffff,
776 $stat[7],
777 $stat[2],
778 $stat[1] >> 16 & 0xffff,
779 $stat[1] & 0xffff,
780 $stat[0] >> 16 & 0xffff,
781 $stat[0] & 0xffff);
782 }
784 "Perl script implementing `directory-files-attributes' as Lisp `read'able
785 output.
786 Escape sequence %s is replaced with name of Perl binary.
789 ;; These two use base64 encoding.
791 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
792 "Perl program to use for encoding 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 -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
800 "Perl program to use for decoding a file.
801 Escape sequence %s is replaced with name of Perl binary.
802 This string is passed to `format', so percent characters need to be doubled.
803 This implementation requires the MIME::Base64 Perl module to be installed
807 "%s -e '
808 # This script contributed by Juanma Barranquero <lektu@terra.es>.
809 # Copyright (C) 2002-2016 Free Software Foundation, Inc.
810 use strict;
812 my %%trans = do {
813 my $i = 0;
814 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
815 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
816 };
817 my $data;
819 # We read in chunks of 54 bytes, to generate output lines
820 # of 72 chars (plus end of line)
821 while (read STDIN, $data, 54) {
822 my $pad = q();
824 # Only for the last chunk, and only if did not fill the last three-byte packet
825 if (eof) {
826 my $mod = length($data) %% 3;
827 $pad = q(=) x (3 - $mod) if $mod;
828 }
830 # Not the fastest method, but it is simple: unpack to binary string, split
831 # by groups of 6 bits and convert back from binary to byte; then map into
832 # the translation table
833 print
834 join q(),
835 map($trans{$_},
836 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
837 $pad,
839 }' 2>/dev/null"
840 "Perl program to use for encoding a file.
841 Escape sequence %s is replaced with name of Perl binary.
845 "%s -e '
846 # This script contributed by Juanma Barranquero <lektu@terra.es>.
847 # Copyright (C) 2002-2016 Free Software Foundation, Inc.
848 use strict;
850 my %%trans = do {
851 my $i = 0;
852 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
853 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
854 };
856 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
860 # We are going to accumulate into $pending to accept any line length
861 # (we do not check they are <= 76 chars as the RFC says)
862 my $pending = q();
864 while (my $data = <STDIN>) {
865 chomp $data;
867 # If we find one or two =, we have reached the end and
868 # any following data is to be discarded
869 my $finished = $data =~ s/(==?).*/$1/;
870 $pending .= $data;
872 my $len = length($pending);
873 my $chunk = substr($pending, 0, $len & ~3);
874 $pending = substr($pending, $len & ~3 + 1);
876 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
877 # split in 8-bit chunks and convert back to char.
878 print join q(),
879 map $bytes{$_},
880 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
882 last if $finished;
883 }' 2>/dev/null"
884 "Perl program to use for decoding a file.
885 Escape sequence %s is replaced with name of Perl binary.
889 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
890 "Perl program to use for encoding a file.
894 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
895 "Perl program to use for decoding a file.
900 BEGIN {
903 }
904 {
905 for (c=1; c<=length($0); c++) {
906 d=index(b16, substr($0,c,1))
907 if (d--) {
908 for (b=1; b<=4; b++) {
909 o=o*2+int(d/8); d=(d*2)%%16
910 if (++obc==6) {
911 printf substr(b64,o+1,1)
913 obc=0; o=0
914 }
915 }
916 }
917 }
918 }
919 END {
920 if (obc) {
922 while (obc++<6) { o=o*2 }
924 } else {
926 }
927 printf tail
928 }'"
929 "Awk program to use for encoding a file.
934 BEGIN {
936 }
937 {
938 for (i=1; i<=length($0); i++) {
939 c=index(b64, substr($0,i,1))
940 if(c--) {
941 for(b=0; b<6; b++) {
942 o=o*2+int(c/32); c=(c*2)%%64
943 if(++obc==8) {
944 if (o) {
946 } else {
948 }
949 obc=0; o=0
950 }
951 }
952 }
953 }
954 }'"
955 "Awk program to use for decoding a file.
959 "test -c /dev/zero && \
960 od -v -t x1 -A n </dev/null && \
961 busybox awk '{}' </dev/null"
972 while read file; do
975 else
977 fi
980 else
982 fi
983 done
985 "Script to check existence of VC related files.
986 It must be send formatted with two strings; the tests for file
987 existence, and file readability. Input shall be read via
988 here-document, otherwise the command could exceed maximum length
991 ;; New handlers should be added here.
995 ;; `byte-compiler-base-file-name' performed by default handler.
1000 ;; `diff-latest-backup-file' performed by default handler.
1004 . tramp-sh-handle-directory-files-and-attributes)
1023 ;; `file-name-sans-versions' performed by default handler.
1037 ;; `find-file-noselect' performed by default handler.
1038 ;; `get-file-buffer' performed by default handler.
1059 "Alist of handler functions.
1062 ;; This must be the last entry, because `identity' always matches.
1063 ;;;###tramp-autoload
1067 ;;; File Name Handler Functions:
1071 "Like `make-symbolic-link' for Tramp files.
1072 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1073 the symlink. If LINKNAME is a Tramp file, only the localname component is
1074 used as the target of the symlink.
1076 If LINKNAME is a Tramp file and the localname component is relative, then
1077 it is expanded first, before the localname component is taken. Note that
1078 this can give surprising results if the user/host for the source and
1079 target of the symlink differ."
1086 l 'file-error
1089 ;; Do the 'confirm if exists' thing.
1091 ;; What to do?
1096 "File %s already exists; make it a link anyway? "
1097 l-localname)))))
1102 ;; If FILENAME is a Tramp name, use just the localname component.
1111 ;; Right, they are on the same host, regardless of user, method,
1112 ;; etc. We now make the link on the remote machine. This will
1113 ;; occur as the user that FILENAME belongs to.
1118 "%s -sf %s %s"
1119 ln
1121 ;; The command could exceed PATH_MAX, so we use
1122 ;; relative file names. However, relative file names
1123 ;; could start with "-". `tramp-shell-quote-argument'
1124 ;; does not handle this, we must do it ourselves.
1129 "Like `file-truename' for Tramp files."
1131 "%s%s"
1134 method user host
1139 ;; Use GNU readlink --canonicalize-missing where available.
1142 v
1150 ;; Use Perl implementation.
1158 v
1162 ;; Do it yourself.
1166 ;; Don't make the following value larger than
1167 ;; necessary. People expect an error message in a
1168 ;; timely fashion when something is wrong;
1169 ;; otherwise they might think that Emacs is hung.
1170 ;; Of course, correctness has to come first.
1172 symlink-target)
1183 method user host
1195 ;; It's a symlink, follow it.
1201 ;; If the symlink was absolute, we'll get a
1202 ;; string like "/user@host:/some/target";
1203 ;; extract the "/some/target" part from it.
1207 v 'file-error
1208 "Symlink target `%s' on wrong host"
1209 symlink-target))
1215 ;; It's a file.
1219 v 'file-error
1222 ;; Combine list to form string.
1231 result))))
1233 ;; Preserve trailing "/".
1236 ;; Basic functions.
1239 "Like `file-exists-p' for Tramp files."
1247 v
1249 "%s %s"
1254 "Like `file-attributes' for Tramp files."
1257 ;; Don't modify `last-coding-system-used' by accident.
1264 v
1272 ;; The scripts could fail, for example with huge file size.
1276 "Implement `file-attributes' for Tramp files using the ls(1) command."
1278 res-inode res-filemodes res-numlinks
1279 res-uid res-gid res-size res-symlink-target)
1281 ;; We cannot send all three commands combined, it could exceed
1282 ;; NAME_MAX or PATH_MAX. Happened on Mac OS X, for example.
1284 vec
1289 vec
1294 vec
1298 ;; On systems which have no quoting style, file names
1299 ;; with special characters could fail.
1307 ;; Parse `ls -l' output ...
1311 ;; ... inode
1327 ;; ... file mode flags
1329 ;; ... number links
1331 ;; ... uid and gid
1343 ;; ... size
1345 ;; From the file modes, figure out other stuff.
1348 ;; If symlink, find out file name pointed to.
1355 ;; Return data gathered.
1357 ;; 0. t for directory, string (name linked to) for symbolic
1358 ;; link, or nil.
1360 ;; 1. Number of links to file.
1361 res-numlinks
1362 ;; 2. File uid.
1363 res-uid
1364 ;; 3. File gid.
1365 res-gid
1366 ;; 4. Last access time, as a list of integers. Normally
1367 ;; this would be in the same format as `current-time', but
1368 ;; the subseconds part is not currently implemented, and
1369 ;; (0 0) denotes an unknown time.
1370 ;; 5. Last modification time, likewise.
1371 ;; 6. Last status change time, likewise.
1373 ;; 7. Size in bytes (-1, if number is out of range).
1374 res-size
1375 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1376 res-filemodes
1377 ;; 9. t if file's gid would change if file were deleted and
1378 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1379 t
1380 ;; 10. Inode number.
1381 res-inode
1382 ;; 11. Device number. Will be replaced by a virtual device number.
1387 "Implement `file-attributes' for Tramp files using a Perl script."
1392 vec
1398 "Implement `file-attributes' for Tramp files using stat(1) command."
1401 vec
1404 ;; On Opsware, pdksh (which is the true name of ksh there)
1405 ;; doesn't parse correctly the sequence "((". Therefore, we add
1406 ;; a space. Apostrophes in the stat output are masked as
1407 ;; `tramp-stat-marker', in order to make a proper shell escape of
1408 ;; them in file names.
1409 "( (%s %s || %s -h %s) && (%s -c "
1410 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1417 tramp-stat-marker tramp-stat-marker
1422 tramp-stat-marker tramp-stat-marker
1424 tramp-stat-quoted-marker)))
1427 "Like `set-visited-file-modtime' for Tramp files."
1434 coding-system-used)
1438 ;; '(-1 65535) means file doesn't exists yet.
1441 ;; We use '(0 0) as a don't-know value. See also
1442 ;; `tramp-do-file-attributes-with-ls'.
1447 v
1455 nil)))))
1457 ;; This function makes the same assumption as
1458 ;; `tramp-sh-handle-set-visited-file-modtime'.
1460 "Like `verify-visited-file-modtime' for Tramp files.
1461 At the time `verify-visited-file-modtime' calls this function, we
1462 already know that the buffer is visiting a file and that
1463 `visited-file-modtime' does not return 0. Do not call this
1464 function directly, unless those two cases are already taken care
1465 of."
1468 ;; There is no file visiting the buffer, or the buffer has no
1469 ;; recorded last modification time, or there is no established
1470 ;; connection.
1474 t
1482 ;; File exists, and has a known modtime.
1485 modtime
1486 ;; For compatibility, deal with both the old
1487 ;; (HIGH . LOW) and the new (HIGH LOW) return
1488 ;; values of `visited-file-modtime'.
1491 mt)))
1493 ;; Modtime has the don't know value.
1496 v
1503 attr
1506 ;; If file does not exist, say it is not modified if and
1507 ;; only if that agrees with the buffer's record.
1511 "Like `set-file-modes' for Tramp files."
1515 ;; FIXME: extract the proper text from chmod's stderr.
1517 v
1522 "Like `set-file-times' for Tramp files."
1529 time)))
1532 "env TZ=UTC %s %s %s"
1540 "Set the ownership for FILENAME.
1541 If UID and GID are provided, these values are used; otherwise uid
1542 and gid of the corresponding user is taken. Both parameters must
1543 be non-negative integers."
1544 ;; Modern Unices allow chown only for root. So we might need
1545 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1546 ;; working with su(do)? when it is needed, so it shall succeed in
1547 ;; the majority of cases.
1548 ;; Don't modify `last-coding-system-used' by accident.
1553 ;; If we are root on the local host, we can do it directly.
1561 "chown %d:%d %s" uid gid
1564 ;; We handle also the local part, because there doesn't exist
1565 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1566 ;; timeout for this.
1571 nil "chown" nil nil nil
1575 "Check, whether SELINUX is enabled on the remote host."
1580 "Like `file-selinux-context' for Tramp files."
1589 "%s -d -Z %s"
1597 ;; Return the context.
1598 context))))
1601 "Like `set-file-selinux-context' for Tramp files."
1621 t)))))
1624 "Check, whether ACL is enabled on the remote host."
1629 "Like `file-acl' for Tramp files."
1635 "getfacl -ac %s"
1644 "Like `set-file-acl' for Tramp files."
1651 tramp-end-of-heredoc
1652 acl-string
1653 tramp-end-of-heredoc))
1655 ;; Success.
1658 t)
1659 ;; In case of errors, we return nil.
1661 nil)))
1663 ;; Simple functions using the `test' command.
1666 "Like `file-executable-p' for Tramp files."
1669 ;; Examine `file-attributes' cache to see if request can be
1670 ;; satisfied without remote operation.
1675 "Like `file-readable-p' for Tramp files."
1678 ;; Examine `file-attributes' cache to see if request can be
1679 ;; satisfied without remote operation.
1683 ;; When the remote shell is started, it looks for a shell which groks
1684 ;; tilde expansion. Here, we assume that all shells which grok tilde
1685 ;; expansion will also provide a `test' command which groks `-nt' (for
1686 ;; newer than). If this breaks, tell me about it and I'll try to do
1687 ;; something smarter about it.
1689 "Like `file-newer-than-file-p' for Tramp files."
1691 nil)
1693 t)
1694 ;; We are sure both files exist at this point.
1697 ;; We try to get the mtime of both files. If they are not
1698 ;; equal to the "dont-know" value, then we subtract the times
1699 ;; and obtain the result.
1705 ;; If one of them is the dont-know value, then we can
1706 ;; still try to run a shell command on the remote host.
1707 ;; However, this only works if both files are Tramp
1708 ;; files and both have the same method, same user, same
1709 ;; host.
1714 v 'file-error
1715 "Files %s and %s must have same method, user, host"
1716 file1 file2)))
1721 ;; Functions implemented using the basic functions above.
1724 "Like `file-directory-p' for Tramp files."
1726 ;; `file-directory-p' is used as predicate for file name completion.
1727 ;; Sometimes, when a connection is not established yet, it is
1728 ;; desirable to return t immediately for "/method:foo:". It can
1729 ;; be expected that this is always a directory.
1735 "Like `file-writable-p' for Tramp files."
1739 ;; Examine `file-attributes' cache to see if request can be
1740 ;; satisfied without remote operation.
1743 ;; If file doesn't exist, check if directory is writable.
1748 "Like `file-ownership-preserved-p' for Tramp files."
1752 ;; Return t if the file doesn't exist, since it's true that no
1753 ;; information would be lost by an (attempted) delete and create.
1760 ;; Directory listings.
1764 "Like `directory-files-and-attributes' for Tramp files."
1772 v localname
1783 v localname id-format))
1786 v localname id-format))
1788 result item)
1798 result
1800 ;; The scripts could fail, for example with huge file size.
1802 directory full match nosort id-format)))))
1806 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1809 vec tramp-perl-directory-files-and-attributes
1813 vec
1817 object))
1821 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1824 vec
1827 ;; We must care about file names with spaces, or starting with
1828 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1829 ;; but it does not work on all remote systems. Apostrophes in
1830 ;; the stat output are masked as `tramp-stat-marker', in order to
1831 ;; make a proper shell escape of them in file names.
1833 "xargs %s -c "
1834 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1838 ;; On systems which have no quoting style, file names with special
1839 ;; characters could fail.
1847 tramp-stat-marker tramp-stat-marker
1848 tramp-stat-marker tramp-stat-marker
1853 tramp-stat-marker tramp-stat-marker
1854 tramp-stat-quoted-marker)))
1856 ;; This function should return "foo/" for directories and "bar" for
1857 ;; files.
1859 "Like `file-name-all-completions' for Tramp files."
1862 filename
1866 ;; Get a list of directories and files, including reliably
1867 ;; tagging the directories with a trailing "/". Because I
1868 ;; rock. --daniel@danann.net
1870 v
1874 v tramp-perl-file-name-all-completions
1880 "(cd %s 2>&1 && %s -a 2>/dev/null"
1881 " | while IFS= read f; do"
1889 ;; Now grab the output.
1893 ;; Check result code, found in last line of output.
1897 ;; Grab error message from line before last line
1898 ;; (it was put there by `cd 2>&1').
1901 v 'file-error
1902 "tramp-sh-handle-file-name-all-completions: %s"
1904 ;; For peace of mind, if buffer doesn't end in `fail'
1905 ;; then it should end in `ok'. If neither are in the
1906 ;; buffer something went seriously wrong on the remote
1907 ;; side.
1910 v 'file-error
1911 "\
1912 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1917 result))))))
1919 ;; cp, mv and ln
1923 "Like `add-name-to-file' for Tramp files."
1928 v 'file-error
1929 "add-name-to-file: %s"
1938 "File %s already exists; make it a new name anyway? "
1939 newname)))
1946 v1
1950 "error with add-name-to-file, see buffer `%s' for details"
1955 preserve-uid-gid preserve-extended-attributes)
1956 "Like `copy-file' for Tramp files."
1960 ;; At least one file a Tramp file?
1964 'copy filename newname ok-if-already-exists keep-date
1965 preserve-uid-gid preserve-extended-attributes))
1966 ;; Compat section. PRESERVE-EXTENDED-ATTRIBUTES has been
1967 ;; introduced with Emacs 24.1 (as PRESERVE-SELINUX-CONTEXT), and
1968 ;; renamed in Emacs 24.3.
1971 'copy-file
1973 preserve-uid-gid preserve-extended-attributes)))
1976 'copy-file
1981 "Like `copy-directory' for Tramp files."
1987 ;; When DIRNAME and NEWNAME are remote, they must have
1988 ;; the same method.
1994 ;; scp or rsync DTRT.
2008 ;; We must do it file-wise.
2010 'copy-directory
2015 ;; When newname did exist, we have wrong cached values.
2023 "Like `rename-file' for Tramp files."
2024 ;; Check if both files are local -- invoke normal rename-file.
2025 ;; Otherwise, use Tramp from local system.
2028 ;; At least one file a Tramp file?
2032 'rename filename newname ok-if-already-exists
2039 preserve-uid-gid preserve-extended-attributes)
2040 "Copy or rename a remote file.
2041 OP must be `copy' or `rename' and indicates the operation to perform.
2042 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2043 the new file (for copy) or the new name of the file (for rename).
2044 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2045 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2046 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2047 the uid and gid if both files are on the same host.
2048 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2050 This function is invoked by `tramp-sh-handle-copy-file' and
2051 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2052 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2053 file names."
2070 filename newname)
2073 ;; Both are Tramp files.
2078 ;; Shortcut: if method, host, user are the same for
2079 ;; both files, we invoke `cp' or `mv' on the remote
2080 ;; host directly.
2083 op filename newname
2084 ok-if-already-exists keep-date preserve-uid-gid))
2086 ;; Try out-of-band operation.
2091 op filename newname keep-date))
2093 ;; No shortcut was possible. So we copy the file
2094 ;; first. If the operation was `rename', we go back
2095 ;; and delete the original file (if the copy was
2096 ;; successful). The approach is simple-minded: we
2097 ;; create a new buffer, insert the contents of the
2098 ;; source file into it, then write out the buffer to
2099 ;; the target file. The advantage is that it doesn't
2100 ;; matter which file name handlers are used for the
2101 ;; source and target file.
2104 op filename newname keep-date))))))
2106 ;; One file is a Tramp file, the other one is local.
2109 ;; Fast track on local machine.
2112 op filename newname
2113 ok-if-already-exists keep-date preserve-uid-gid))
2115 ;; If the Tramp file has an out-of-band method, the
2116 ;; corresponding copy-program can be invoked.
2119 op filename newname keep-date))
2121 ;; Use the inline method via a Tramp buffer.
2123 op filename newname keep-date))))
2126 ;; One of them must be a Tramp file.
2129 ;; Handle `preserve-extended-attributes'. We ignore possible
2130 ;; errors, because ACL strings could be incompatible.
2135 ;; In case of `rename', we must flush the cache of the source file.
2141 ;; When newname did exist, we have wrong cached values.
2148 "Use an Emacs buffer to copy or rename a file.
2149 First arg OP is either `copy' or `rename' and indicates the operation.
2150 FILENAME is the source file, NEWNAME the target file.
2151 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2152 ;; We must disable multibyte, because binary data shall not be
2153 ;; converted. We don't want the target file to be compressed, so we
2154 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2155 ;; be called either. We remove `tramp-file-name-handler' from
2156 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2157 ;; `insert-file-contents' might be deactivated in some corner cases.
2168 ;; KEEP-DATE handling.
2170 ;; Set the mode.
2172 ;; If the operation was `rename', delete the original file.
2177 "Invokes `cp' or `mv' on the remote system.
2178 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2179 respectively. FILENAME specifies the file to copy or rename,
2180 NEWNAME is the name of the new file (for copy) or the new name of
2181 the file (for rename). Both files must reside on the same host.
2182 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2183 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2184 the uid and gid from FILENAME."
2194 v 'file-error
2195 "Unknown operation `%s', must be `copy' or `rename'"
2196 op))))
2200 filename))
2204 newname))
2206 cmd-result)
2209 ;; Both files are on a remote host, with same user.
2221 ;; Mask cp -f error.
2223 tramp-operation-not-permitted-regexp nil t))
2224 cmd-result)
2226 nil v 'file-error
2227 "Copying directly failed, see buffer `%s' for details."
2230 ;; We are on the local host.
2233 ;; We can do it directly.
2236 ;; No sticky bit when renaming.
2247 localname1 localname2 ok-if-already-exists
2248 keep-date preserve-uid-gid)
2252 ;; We can do it directly with `tramp-send-command'
2260 ok-if-already-exists keep-date t)
2261 ;; We must change the ownership to the local user.
2267 ;; We need a temporary file in between.
2269 ;; Create the temporary file.
2277 "%s %s %s" cmd
2280 "Copying directly failed, see buffer `%s' for details."
2282 ;; We must change the ownership as remote user.
2283 ;; Since this does not work reliable, we also
2284 ;; give read permissions.
2294 localname1 tmpfile t
2295 keep-date preserve-uid-gid)
2297 'rename-file
2299 ;; We must change the ownership as local user.
2300 ;; Since this does not work reliable, we also
2301 ;; give read permissions.
2304 tmpfile
2308 ;; Move the temporary file to its destination.
2313 "cp -f -p %s %s"
2316 "Copying directly failed, see buffer `%s' for details."
2320 'rename-file
2323 ;; Save exit.
2326 ;; Set the time and mode. Mask possible errors.
2333 "Invoke `scp' program to copy.
2334 The method used must be an out-of-band method."
2338 copy-program copy-args copy-env copy-keep-date port listener spec
2339 options source target remote-copy-program remote-copy-args)
2344 ;; Both are Tramp files. We shall optimize it when the
2345 ;; methods for FILENAME and NEWNAME are the same.
2355 op filename tmpfile keep-date)
2358 ;; Save exit.
2365 ;; Set variables for computing the prompt for reading
2366 ;; password.
2373 ;; Expand hops. Might be necessary for gateway methods.
2377 ;; Check which ones of source and target are Tramp files.
2389 'file-name-directory
2391 newname))))
2393 ;; Check for host and port number. We cannot use
2394 ;; `tramp-file-name-port', because this returns also
2395 ;; `tramp-default-port', which might clash with settings in
2396 ;; "~/.ssh/config".
2403 ;; Check for user. There might be an interactive setting.
2407 ;; Check for listener port.
2414 ;; Compose copy command.
2423 ?h host ?u user ?p port ?r listener ?c options
2429 copy-args
2431 ;; " " has either been a replacement of "%k" (when
2432 ;; keep-date argument is non-nil), or a replacement
2433 ;; for the whole keep-date sublist.
2434 " "
2439 copy-args
2443 copy-env
2445 nil
2452 remote-copy-program
2458 remote-copy-args
2462 ;; Check for local copy program.
2467 ;; Install listener on the remote side. The prompt must be
2468 ;; consumed later on, when the process does not listen anymore.
2475 v 'file-error
2479 'identity
2487 v 'file-error
2488 "Listener process not running on remote host: `%s'"
2489 remote-copy-program))
2497 ;; The default directory must be remote.
2501 ;; Set the transfer process properties.
2511 copy-args
2513 copy-args
2518 ;; Use an asynchronous process. By this, password can
2519 ;; be handled. We don't set a timeout, because the
2520 ;; copying of large files can last longer than 60 secs.
2530 command))))
2535 ;; We must adapt `tramp-local-end-of-line' for
2536 ;; sending the password.
2539 p v nil tramp-actions-copy-out-of-band))))
2541 ;; Reset the transfer process properties.
2544 ;; Clear the remote prompt.
2547 ;; Houston, we have a problem! Likely, the listener is
2548 ;; still running, so let's clear everything (but the
2549 ;; cached password).
2552 ;; Handle KEEP-DATE argument.
2556 ;; Set the mode.
2561 ;; If the operation was `rename', delete the original file.
2568 "Like `make-directory' for Tramp files."
2580 "Like `delete-directory' for Tramp files."
2592 "Like `delete-file' for Tramp files."
2603 ;; Dired.
2609 "Like `dired-compress-file' for Tramp files."
2610 ;; Code stolen mainly from dired-aux.el.
2615 suffix)
2616 ;; See if any suffix rule matches this file name.
2624 nil)
2626 ;; We found an uncompression rule.
2636 ;; We don't recognize the file as compressed, so compress it.
2637 ;; Try gzip.
2651 "Like `insert-directory' for Tramp files."
2658 filename switches wildcard full-directory-p)
2678 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2679 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2682 v
2685 switches
2687 localname
2690 v
2694 "Couldn't `cd %s'"
2698 v
2701 switches
2706 ""
2714 ;; We cannot use `insert-buffer-substring' because the Tramp
2715 ;; buffer changes its contents before insertion due to calling
2716 ;; `expand-file-name' and alike.
2721 ;; Check for "--dired" output.
2728 ;; Now read the numeric positions of file names.
2734 ;; End is followed by \n or by " -> ".
2736 ;; Remove trailing lines.
2742 ;; Some busyboxes are reluctant to discard colors.
2750 ;; Decode the output, it could be multibyte.
2755 ;; The inserted file could be from somewhere else.
2762 "."
2769 ;; Canonicalization of file names.
2772 "Like `expand-file-name' for Tramp files.
2774 the result will be a local, non-Tramp, file name."
2775 ;; If DIR is not given, use `default-directory' or "/".
2777 ;; Unless NAME is absolute, concat DIR and NAME.
2780 ;; If connection is not established yet, run the real handler.
2784 ;; Dissect NAME.
2788 ;; Tilde expansion if necessary. This needs a shell which
2789 ;; groks tilde expansion! The function `tramp-find-shell' is
2790 ;; supposed to find such a shell on the remote host. Please
2791 ;; tell me about it when this doesn't work on your system.
2795 ;; We cannot simply apply "~/", because under sudo "~/" is
2796 ;; expanded to the local user home directory but to the
2797 ;; root home directory. On the other hand, using always
2798 ;; the default user name for tilde expansion is not
2799 ;; appropriate either, because ssh and companions might
2800 ;; use a user name from the config file.
2812 ;; There might be a double slash, for example when "~/"
2813 ;; expands to "/". Remove this.
2816 ;; No tilde characters in file name, do normal
2817 ;; `expand-file-name' (this does "/./" and "/../").
2818 ;; `default-directory' is bound, because on Windows there would
2819 ;; be problems with UNC shares or Cygwin mounts.
2822 method user host
2826 hop)))))
2828 ;;; Remote commands:
2831 "Flush file caches."
2839 ;; We use BUFFER also as connection buffer during setup. Because of
2840 ;; this, its original contents must be saved, and restored once
2841 ;; connection has been setup.
2843 "Like `start-file-process' for Tramp files."
2848 ;; BUFFER can be nil. We use a temporary buffer.
2850 ;; When PROGRAM matches "*sh", and the first arg is "-c",
2851 ;; it might be that the arguments exceed the command line
2852 ;; length. Therefore, we modify the command.
2857 ;; When PROGRAM is nil, we just provide a tty.
2863 args
2867 ;; Use a human-friendly prompt, for example for `shell'.
2868 ;; We discard hops, if existing, that's why we cannot use
2869 ;; `file-remote-p'.
2876 tramp-initial-end-of-output))
2877 ;; We use as environment the difference to toplevel
2878 ;; `process-environment'.
2879 env
2884 env)
2903 ;; We do not want to raise an error when
2904 ;; `start-file-process' has been started several times in
2905 ;; `eshell' and friends.
2909 ;; NAME must be unique as process name.
2913 ;; Set the new process properties.
2919 ;; We catch this event. Otherwise, `start-process' could
2920 ;; be called on the local host.
2923 ;; Activate narrowing in order to save BUFFER
2924 ;; contents. Clear also the modification time;
2925 ;; otherwise we might be interrupted by
2926 ;; `verify-visited-file-modtime'.
2932 ;; We call `tramp-maybe-open-connection', in order
2933 ;; to cleanup the prompt afterwards.
2939 ;; Now do it.
2941 ;; Send the command.
2943 ;; Check, whether a pty is associated.
2947 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'.
2988 "env %s %s"
2990 ;; Determine input.
2995 ;; INFILE is on the same remote host.
2997 ;; INFILE must be copied to remote host.
3003 ;; Determine output.
3005 ;; Just a buffer.
3008 ;; A buffer name.
3011 ;; (REAL-DESTINATION ERROR-DESTINATION)
3013 ;; output.
3021 ;; stderr.
3026 ;; stderr is on the same remote host.
3029 ;; stderr must be copied to remote host. The temporary
3030 ;; file must be deleted after execution.
3033 method user host stderr))))
3034 ;; stderr to be discarded.
3037 ;; 't
3042 ;; Send the command. It might not return in time, so we protect
3043 ;; it. Call it in a subshell, in order to preserve working
3044 ;; directory.
3051 command)
3052 t t)
3054 ;; We should add the output anyway.
3061 ;; When the user did interrupt, we should do it also. We use
3062 ;; return code -1 as marker.
3066 ;; Handle errors.
3071 ;; Provide error file.
3074 ;; Cleanup. We remove all file cache values for the connection,
3075 ;; because the remote process could have changed them.
3081 ;; Return exit status.
3084 ret))))
3087 "Like `file-local-copy' for Tramp files."
3091 v 'file-error
3101 ;; `copy-file' handles direct copy and out-of-band methods.
3106 ;; Use inline encoding for file transfer.
3110 v 3
3112 filename rem-enc)
3119 tmpfile loc-dec)
3121 ;; If local decoding is a function, we call it.
3122 ;; We must disable multibyte, because
3123 ;; `uudecode-decode-region' doesn't handle it
3124 ;; correctly. Unset `file-name-handler-alist'.
3125 ;; Otherwise, epa-file gets confused.
3133 ;; If tramp-decoding-function is not defined for this
3134 ;; method, we invoke tramp-decoding-command instead.
3136 ;; Unset `file-name-handler-alist'. Otherwise,
3137 ;; epa-file gets confused.
3145 loc-dec tmpfile2 tmpfile)
3148 ;; Set proper permissions.
3150 ;; Set local user ownership.
3153 ;; Oops, I don't know what to do.
3157 ;; Error handling.
3163 tmpfile)))
3165 ;; CCC grok LOCKNAME
3168 "Like `write-region' for Tramp files."
3171 ;; Following part commented out because we don't know what to do about
3172 ;; file locking, and it does not appear to be a problem to ignore it.
3173 ;; Ange-ftp ignores it, too.
3174 ;; (when (and lockname (stringp lockname))
3175 ;; (setq lockname (expand-file-name lockname)))
3176 ;; (unless (or (eq lockname nil)
3177 ;; (string= lockname filename))
3178 ;; (error
3179 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3191 ;; `file-writable-p' calls `file-expand-file-name'. We
3192 ;; cannot use `tramp-run-real-handler' therefore.
3198 ;; Short track: if we are on the local host, we can run directly.
3200 'write-region
3204 ;; We use this to save the value of
3205 ;; `last-coding-system-used' after writing the tmp
3206 ;; file. At the end of the function, we set
3207 ;; `last-coding-system-used' to this saved value. This
3208 ;; way, any intermediary coding systems used while
3209 ;; talking to the remote shell or suchlike won't hose
3210 ;; this variable. This approach was snarfed from
3211 ;; ange-ftp.el.
3212 coding-system-used
3213 ;; Write region into a tmp file. This isn't really
3214 ;; needed if we use an encoding function, but currently
3215 ;; we use it always because this makes the logic
3216 ;; simpler. We must also set `temporary-file-directory',
3217 ;; because it could point to a remote directory.
3223 ;; If `append' is non-nil, we copy the file locally, and let
3224 ;; the native `write-region' implementation do the job.
3227 ;; We say `no-message' here because we don't want the
3228 ;; visited file modtime data to be clobbered from the temp
3229 ;; file. We call `set-visited-file-modtime' ourselves later
3230 ;; on. We must ensure that `file-coding-system-alist'
3231 ;; matches `tmpfile'.
3237 'write-region
3244 ;; Now, `last-coding-system-used' has the right value. Remember it.
3247 ;; The permissions of the temporary file should be set. If
3248 ;; FILENAME does not exist (eq modes nil) it has been
3249 ;; renamed to the backup file. This case `save-buffer'
3250 ;; handles permissions.
3251 ;; Ensure that it is still readable.
3254 tmpfile
3257 ;; This is a bit lengthy due to the different methods
3258 ;; possible for file transfer. First, we check whether the
3259 ;; method uses an scp program. If so, we call it.
3260 ;; Otherwise, both encoding and decoding command must be
3261 ;; specified. However, if the method _also_ specifies an
3262 ;; encoding function, then that is used for encoding the
3263 ;; contents of the tmp file.
3268 ;; `copy-file' handles direct copy and out-of-band methods.
3278 ;; We keep the local file for performance
3279 ;; reasons, useful for "rsync".
3286 ;; Don't rename, in order to keep context in SELinux.
3291 ;; Use inline file transfer.
3293 ;; Encode tmpfile.
3297 ;; Use encoding function or command.
3300 "Encoding local file `%s' using `%s'"
3301 tmpfile loc-enc)
3303 ;; The following `let' is a workaround for
3304 ;; the base64.el that comes with pgnus-0.84.
3305 ;; If both of the following conditions are
3306 ;; satisfied, it tries to write to a local
3307 ;; file in default-directory, but at this
3308 ;; point, default-directory is remote.
3309 ;; (`call-process-region' can't write to
3310 ;; remote files, it seems.) The file in
3311 ;; question is a tmp file anyway.
3319 loc-enc tmpfile t))
3321 v 'file-error
3324 filename loc-enc))))
3326 ;; Send buffer into remote decoding command which
3327 ;; writes to remote file. Because this happens on
3328 ;; the remote host, we cannot use the function.
3331 "Decoding remote file `%s' using `%s'"
3332 filename rem-dec)
3336 v
3340 tramp-end-of-heredoc
3342 tramp-end-of-heredoc))
3344 v nil
3345 "Couldn't write region to `%s', decode using `%s' failed"
3346 filename rem-dec)
3347 ;; When `file-precious-flag' is set, the region is
3348 ;; written to a temporary file. Check that the
3349 ;; checksum is equal to that from the local tmpfile.
3353 ;; cksum runs locally, if possible.
3355 ;; cksum runs remotely.
3357 v
3360 ;; ... they are different.
3367 v 'file-error
3370 filename rem-dec)))))
3372 ;; Save exit.
3375 ;; That's not expected.
3378 v 'file-error
3381 method))))
3383 ;; Make `last-coding-system-used' have the right value.
3390 ;; We must protect `last-coding-system-used', now we have set it
3391 ;; to its correct value.
3393 ;; Set file modification time.
3397 ;; We must pass modtime explicitly, because FILENAME can
3398 ;; be different from (buffer-file-name), f.e. if
3399 ;; `file-precious-flag' is set.
3405 ;; Set the ownership.
3415 ;; VC backends check for the existence of various different special
3416 ;; files. This is very time consuming, because every single check
3417 ;; requires a remote command (the file cache must be invalidated).
3418 ;; Therefore, we apply a kind of optimization. We install the file
3419 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3420 ;; remembers all file names for which `file-exists-p' or
3421 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3422 ;; is performed. Afterwards, a script is applied for all collected
3423 ;; file names, using just one remote command. The result of this
3424 ;; script is used to fill the file cache with actual values. Now we
3425 ;; can reset the file name handlers, and we make a second run of
3426 ;; `vc-registered', which returns the expected result without sending
3427 ;; any other remote command.
3429 "Like `vc-registered' for Tramp files."
3435 ;; There could be new files, created by the vc backend. We
3436 ;; cannot reuse the old cache entries, therefore. In
3437 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3438 ;; could also be a timestamp as `current-time' returns. This
3439 ;; means invalidate all cache entries with an older timestamp.
3445 ;; Here we collect only file names, which need an operation.
3449 ;; Send just one command, in order to fill the cache.
3452 v
3461 ;; We cannot use `tramp-send-command-and-read',
3462 ;; because this does not cooperate well with
3463 ;; heredoc documents.
3465 v
3468 tramp-end-of-heredoc
3470 tramp-vc-registered-file-names
3472 tramp-end-of-heredoc))
3474 ;; Read the expression.
3481 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3482 ;; calls shall be answered from the file cache. We unset
3483 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3484 ;; in order to keep the cache.
3486 remote-file-name-inhibit-cache process-file-side-effects)
3487 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3506 ;; Run.
3510 ;;;###tramp-autoload
3512 "Invoke remote-shell Tramp file name handler.
3513 Fall back to normal file name handler if no Tramp handler exists."
3531 "Invoke special file name handler, which collects files to be handled."
3539 ;; That's what we want: file names, for which checks are
3540 ;; applied. We assume that VC uses only `file-exists-p' and
3541 ;; `file-readable-p' checks; otherwise we must extend the
3542 ;; list. We do not perform any action, but return nil, in
3543 ;; order to keep `vc-registered' running.
3546 nil)
3547 ;; `process-file' and `start-file-process' shall be ignored.
3550 ;; Tramp file name handlers like `expand-file-name'. They
3551 ;; must still work.
3553 ;; Default file name handlers, we don't care.
3557 "Like `file-notify-add-watch' for Tramp files."
3561 command events filter p sequence)
3563 ;; gvfs-monitor-dir.
3566 events
3570 attribute-changed))
3575 ;; inotifywait.
3578 events
3588 ;; Make events a list of symbols.
3589 events
3593 ;; None.
3595 v 'file-notify-error
3596 "No file notification program found on %s"
3598 ;; Start process.
3600 'start-file-process
3604 sequence))
3605 ;; Return the process object as watch-descriptor.
3608 v 'file-notify-error
3609 "`%s' failed to start on remote host"
3613 ;; Needed for process filter.
3618 ;; There might be an error if the monitor is not supported.
3619 ;; Give the filter a chance to read the output.
3624 p))))
3628 file-notify events."
3638 ;; Attribute change is returned in unused wording.
3650 string)
3655 proc
3660 ;; File names are returned as absolute paths. We must
3661 ;; add the remote prefix.
3665 ;; Remove watch when file or directory to be watched is deleted.
3669 ;; Usually, we would add an Emacs event now. Unfortunately,
3670 ;; `unread-command-events' does not accept several events at
3671 ;; once. Therefore, we apply the handler directly.
3674 'file-notify-handle-event
3677 ;; Save rest of the string.
3687 ;; Check, whether there is a problem.
3693 line)
3698 proc
3705 ;; Remove watch when file or directory to be watched is deleted.
3708 ;; Usually, we would add an Emacs event now. Unfortunately,
3709 ;; `unread-command-events' does not accept several events at
3710 ;; once. Therefore, we apply the handler directly.
3713 'file-notify-handle-event
3716 ;;; Internal Functions:
3719 "Define in remote shell function NAME implemented as SCRIPT.
3720 Only send the definition if it has not already been done."
3721 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3722 ;; might be nil.
3728 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3729 ;; could result in unwanted command expansion. Avoid this.
3732 ;; The script could contain a call of Perl. This is masked with `%s'.
3737 vec
3745 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3746 Returns the exit code of the `test' program."
3749 v
3751 "%s %s %s"
3753 switch
3757 "Run `test'-like program on the remote system, given FILE1, FILE2.
3758 FORMAT-STRING contains the program name, switches, and place holders.
3759 Returns the exit code of the `test' program. Barfs if the methods,
3760 hosts, or files, disagree."
3764 v 'file-error
3769 v1
3776 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3777 First arg VEC specifies the connection, PROGNAME is the program
3778 to search for, and DIRLIST gives the list of directories to
3779 search. If IGNORE-TILDE is non-nil, directory names starting
3780 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3781 only in DIRLIST.
3783 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3785 This function expects to be in the right *tramp* buffer."
3788 ;; Check whether the executable is in $PATH. "which(1)" does not
3789 ;; report always a correct error code; therefore we check the
3790 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3791 ;; 5.11") have problems with this command, we disable the call
3792 ;; therefore.
3803 ;; Remove all ~/foo directories from dirlist.
3812 vec
3814 "do if test -x $d/%s && test -f $d/%s; "
3815 "then echo tramp_executable $d/%s; "
3818 progname progname progname
3819 tramp-end-of-heredoc
3821 tramp-end-of-heredoc))
3827 result)))
3830 "Sets the remote environment PATH to existing directories.
3831 I.e., for each directory in `tramp-remote-path', it is tested
3832 whether it exists and if so, it is added to the environment
3833 variable PATH."
3839 ;; ------------------------------------------------------------
3840 ;; -- Communication with external shell --
3841 ;; ------------------------------------------------------------
3844 "Find a command on the remote host for checking if a file exists.
3845 Here, we are looking for a command which has zero exit status if the
3846 file exists and nonzero exit status otherwise."
3850 result)
3851 ;; The algorithm is as follows: we try a list of several commands.
3852 ;; For each command, we first run `$cmd /' -- this should return
3853 ;; true, as the root directory always exists. And then we run
3854 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3855 ;; does not exist. This should return false. We use the first
3856 ;; command we find that seems to work.
3857 ;; The list of commands to try is as follows:
3858 ;; `ls -d' This works on most systems, but NetBSD 1.4
3859 ;; has a bug: `ls' always returns zero exit
3860 ;; status, even for files which don't exist.
3861 ;; `test -e' Some Bourne shells have a `test' builtin
3862 ;; which does not know the `-e' option.
3863 ;; `/bin/test -e' For those, the `test' binary on disk normally
3864 ;; provides the option. Alas, the binary
3865 ;; is sometimes `/bin/test' and sometimes it's
3866 ;; `/usr/bin/test'.
3867 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3895 result))
3898 "Opens shell SHELL."
3901 ;; Find arguments for this shell.
3903 item extra-args)
3908 ;; It is useful to set the prompt in the following command
3909 ;; because some people have a setting for $PS1 which /bin/sh
3910 ;; doesn't know about and thus /bin/sh will display a strange
3911 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3912 ;; ksh will display the current working directory but /bin/sh
3913 ;; will display a dollar sign. The following command line sets
3914 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3915 ;; well as csh-like shells. We also unset the variable $ENV
3916 ;; because that is read by some sh implementations (eg, bash
3917 ;; when called as sh) on startup; this way, we avoid the startup
3918 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3919 ;; the prompt in /bin/bash, it must be discarded as well.
3920 ;; $HISTFILE is set according to `tramp-histfile-override'.
3923 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3928 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3932 t))
3937 "Opens a shell on the remote host which groks tilde expansion."
3940 shell)
3943 ;; CCC: "root" does not exist always, see my QNAP TS-459.
3944 ;; Which check could we apply instead?
3947 ;; The default shell (ksh93) of OpenSolaris and
3948 ;; Solaris is buggy. We've got reports for
3949 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3958 ;; Maybe it works at least for some other commands.
3960 default-shell
3962 vec 2
3964 "Couldn't find a remote shell which groks tilde "
3966 default-shell)))
3968 default-shell)))
3970 ;; Open a new shell if needed.
3976 ;; Utility functions.
3979 "Wait for shell prompt and barf if none appears.
3980 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3981 seconds. If not, it produces an error message with the given ERROR-ARGS."
3985 proc timeout
3994 "Set up an interactive shell.
3995 Mainly sets the prompt and the echo correctly. PROC is the shell
3996 process to set up. VEC specifies the connection."
4001 ;; Disable tab and echo expansion.
4005 ;; Check whether the echo has really been disabled. Some
4006 ;; implementations, like busybox of embedded GNU/Linux, don't
4007 ;; support disabling.
4014 ;; Make sure backspaces and their echo are enabled and no line
4015 ;; width magic interferes with them.
4023 ;; Check whether the output of "uname -sr" has been changed. If
4024 ;; yes, this is a strong indication that we must expire all
4025 ;; connection properties. We start again with
4026 ;; `tramp-maybe-open-connection', it will be caught there.
4031 vec "uname"
4035 vec 3
4036 "Connection reset, because remote host changed from `%s' to `%s'"
4037 old-uname new-uname)
4038 ;; We want to keep the password.
4042 ;; Try to set up the coding system correctly.
4043 ;; CCC this can't be the right way to do it. Hm.
4046 ;; Use MULE to select the right EOL convention for communicating
4047 ;; with the process.
4053 cs-decode cs-encode)
4057 cs-encode
4059 cs-encode
4067 ;; Special setting for Mac OS X.
4079 ;; Check whether the remote host suffers from buggy
4080 ;; `send-process-string'. This is known for FreeBSD (see comment in
4081 ;; `send_process', file process.c). I've tested sending 624 bytes
4082 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4083 ;; this host type is detected locally. It cannot handle remote
4084 ;; hosts, though.
4088 tramp-chunksize)
4096 ;; Set remote PATH variable.
4099 ;; Search for a good shell before searching for a command which
4100 ;; checks if a file exists. This is done because Tramp wants to use
4101 ;; "test foo; echo $?" to check if various conditions hold, and
4102 ;; there are buggy /bin/sh implementations which don't execute the
4103 ;; "echo $?" part if the "test" part has an error. In particular,
4104 ;; the OpenSolaris /bin/sh is a problem. There are also other
4105 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4106 ;; in function declarations, or changing HISTFILE in place.
4107 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4108 ;; detected.
4111 ;; Disable unexpected output.
4114 ;; IRIX64 bash expands "!" even when in single quotes. This
4115 ;; destroys our shell functions, we must disable it. See
4116 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4120 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4125 ;; Set utf8 encoding. Needed for Mac OS X, for example. This is
4126 ;; non-POSIX, so we must expect errors on some systems.
4129 ;; Set `remote-tty' process property.
4134 ;; Dump stty settings in the traces.
4138 ;; Set the environment.
4143 unset vars item)
4153 vec
4155 tramp-end-of-heredoc
4157 tramp-end-of-heredoc)
4158 t))
4163 ;; Old text from documentation of tramp-methods:
4164 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4165 ;; of the base64 methods instead since base64 encoding is much more
4166 ;; reliable and the commands are more standardized between the different
4167 ;; Unix versions. But if you can't use base64 for some reason, please
4168 ;; note that the default uudecode command does not work well for some
4169 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4170 ;; the following command for uudecode:
4171 ;;
4172 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4173 ;;
4174 ;; For Irix, no solution is known yet.
4182 "List of local coding commands for inline transfer.
4183 Each item is a list that looks like this:
4185 \(FORMAT ENCODING DECODING)
4187 FORMAT is symbol describing the encoding/decoding format. It can be
4188 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4190 ENCODING and DECODING can be strings, giving commands, or symbols,
4191 giving functions. If they are strings, then they can contain
4193 file name will be put into the command line at that spot. If the
4194 specifier is not present, the input should be read from standard
4195 input.
4197 If they are functions, they will be called with two arguments, start
4198 and end of region, and are expected to replace the region contents
4203 ;; "-i" is more robust with older base64 from GNU coreutils.
4204 ;; However, I don't know whether all base64 versions do supports
4205 ;; this option.
4213 ;; This is painful slow, so we put it on the end.
4220 "List of remote coding commands for inline transfer.
4221 Each item is a list that looks like this:
4223 \(FORMAT ENCODING DECODING [TEST])
4225 FORMAT is a symbol describing the encoding/decoding format. It can be
4226 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4228 ENCODING and DECODING can be strings, giving commands, or symbols,
4229 giving variables. If they are strings, then they can contain
4231 file name will be put into the command line at that spot. If the
4232 specifier is not present, the input should be read from standard
4233 input.
4235 If they are variables, this variable is a string containing a
4236 Perl or Shell implementation for this functionality. This
4237 program will be transferred to the remote host, and it is
4239 specifier in the variable value denotes a temporary file.
4241 The optional TEST command can be used for further tests, whether
4245 "Find an inline transfer encoding that works.
4246 Goes through the list `tramp-local-coding-commands' and
4247 `tramp-remote-coding-commands'."
4252 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4260 ;; If the local encoder or decoder is a string, the
4261 ;; corresponding command has to work locally.
4268 loc-enc nil nil))
4276 loc-dec nil nil))
4278 ;; Search for remote coding commands with the same format
4286 ;; Check the remote test command if exists.
4292 ;; Check if remote perl exists when necessary.
4297 ;; Check if remote encoding and decoding commands can be
4298 ;; called remotely with null input and output. This makes
4299 ;; sure there are no syntax errors and the command is really
4300 ;; found. Note that we do not redirect stdout to /dev/null,
4301 ;; for two reasons: when checking the decoding command, we
4302 ;; actually check the output it gives. And also, when
4303 ;; redirecting "mimencode" output to /dev/null, then as root
4304 ;; it might change the permissions of /dev/null!
4312 vec 5
4321 tmpfile)
4328 tramp-temp-name-prefix
4330 value
4332 value
4334 ?t
4339 vec 5
4342 vec
4344 t)
4352 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4358 ;; Set connection properties. Since the commands are risky
4359 ;; (due to output direction), we cache them in the process cache.
4370 "Call the local encoding or decoding command.
4372 Otherwise, INPUT is passed via standard input.
4373 INPUT can also be nil which means `/dev/null'.
4374 OUTPUT can be a string (which specifies a file name), or t (which
4375 means standard output and thus the current buffer), or nil (which
4376 means discard it)."
4378 nil tramp-encoding-shell
4381 nil
4382 tramp-encoding-command-switch
4392 "List of compress and decompress commands for inline transfer.
4393 Each item is a list that looks like this:
4395 \(COMPRESS DECOMPRESS)
4400 "Find an inline transfer compress command that works.
4401 Goes through the list `tramp-inline-compress-commands'."
4406 item compress decompress found)
4413 vec 5
4414 "Checking local compress commands `%s', `%s' for sanity"
4415 compress decompress)
4420 ;; Windows shells need the program file name after
4421 ;; the pipe symbol be quoted if they use forward
4422 ;; slashes as directory separators.
4429 vec 5
4430 "Checking remote compress commands `%s', `%s' for sanity"
4431 compress decompress)
4437 ;; Did we find something?
4440 ;; Set connection properties. Since the commands are
4441 ;; risky (due to output direction), we cache them in the
4442 ;; process cache.
4456 "Expands VEC according to `tramp-default-proxies-alist'.
4457 Gateway hops are already opened."
4461 choices proxy)
4463 ;; Ad-hoc proxy definitions.
4468 tramp-prefix-format proxy tramp-postfix-host-format)))
4473 proxy)
4474 ;; Add the hop.
4476 'tramp-default-proxies-alist
4479 proxy))
4481 ;; Save the new value.
4486 ;; Look for proxy hosts to be passed.
4492 ;; Host.
4495 ;; User.
4499 ;; No more hops needed.
4501 ;; Replace placeholders.
4504 proxy
4509 ;; Add the hop.
4511 ;; Start next search.
4514 ;; Handle gateways.
4522 ;; Is the method prepared for gateways?
4525 vec 'file-error
4527 ;; Open the gateway connection.
4532 target-alist)
4533 ;; For the password prompt, we need the correct values.
4534 ;; Therefore, we must remember the gateway vector. But we
4535 ;; cannot do it as connection property, because it shouldn't
4536 ;; be persistent. And we have no started process yet either.
4540 ;; Foreign and out-of-band methods are not supported for multi-hops.
4547 vec 'file-error
4548 "Method `%s' is not supported for multi-hops."
4551 ;; In case the host name is not used for the remote shell
4552 ;; command, the user could be misguided by applying a random
4553 ;; host name.
4559 ;; There are multi-hops.
4561 ;; The host name is used for the remote shell command.
4563 ;; The host is local. We cannot use `tramp-local-host-p'
4564 ;; here, because it opens a connection as well.
4567 v 'file-error
4568 "Host `%s' looks like a remote host, `%s' can only use the local host"
4569 host method)))
4571 ;; Result.
4572 target-alist))
4575 "Return the Control* arguments of the local ssh."
4577 ;; No options to be computed.
4582 ;; There is already a value to be used.
4585 ;; Determine the options.
4597 ;; We use a non-existing IP address, in order to avoid
4598 ;; useless connections, and DNS timeouts.
4605 " -o ControlPath='tramp.%%r@%%h:%%p'"
4614 tramp-ssh-controlmaster-options)))
4617 "Maybe open a connection VEC.
4618 Does not do anything if a connection is already open, but re-opens the
4619 connection if a previous connection has died for some reason."
4627 ;; If Tramp opens the same connection within a short time frame,
4628 ;; there is a problem. We shall signal this.
4637 ;; If too much time has passed since last command was sent, look
4638 ;; whether process is still alive. If it isn't, kill it. When
4639 ;; using ssh, it can sometimes happen that the remote end has hung
4640 ;; up but the local ssh client doesn't recognize this until it
4641 ;; tries to send some data to the remote end. So that's why we
4642 ;; try to send a command from time to time, then look again
4643 ;; whether the process is really alive.
4654 ;; The error will be caught locally.
4660 ;; New connection must be opened.
4664 ;; If `non-essential' is non-nil, don't reopen a new connection.
4665 ;; This variable has been introduced with Emacs 24.1.
4670 vec 3
4681 ;; Start new process.
4698 ;; We will apply `tramp-ssh-controlmaster-options'
4699 ;; only for the first hop.
4703 ;; There are unfortunate settings for "cmdproxy" on
4704 ;; W32 systems.
4707 ;; This must be done in order to avoid our file
4708 ;; name handler.
4712 'start-process
4717 tramp-encoding-command-interactive)
4720 ;; Set sentinel and query flag.
4731 ;; Check whether process is alive.
4733 p 10
4736 ;; Now do all the connections as specified.
4762 ;; We don't create the temporary file. In
4763 ;; fact, it is just a prefix for the
4764 ;; ControlPath option of ssh; the real
4765 ;; temporary file has another name, and it is
4766 ;; created and protected by ssh. It is also
4767 ;; removed by ssh when the connection is
4768 ;; closed. The temporary file name is cached
4769 ;; in the main connection process, therefore
4770 ;; we cannot use `tramp-get-connection-process'.
4776 tramp-temp-name-prefix
4778 spec r-shell)
4780 ;; Add arguments for asynchronous processes.
4784 ;; Add gateway arguments if necessary.
4790 ;; Check for port number. Until now, there's no
4791 ;; need for handling like method, user, host.
4796 ;; Check, whether there is a restricted shell.
4801 ;; Set variables for computing the prompt for
4802 ;; reading password. They can also be derived
4803 ;; from a gateway.
4808 ;; Add login environment.
4811 login-env
4816 login-env))
4820 "%s=%s %s"
4823 command)))
4826 ;; Replace `login-args' place holders.
4834 ?h l-host ?u l-user ?p l-port ?c options)
4835 command
4837 ;; We do not want to see the trailing local
4838 ;; prompt in `start-file-process'.
4840 command " "
4846 ;; Local shell could be a Windows COMSPEC. It
4847 ;; doesn't know the ";" syntax, but we must exit
4848 ;; always for `start-file-process'. It could
4849 ;; also be a restricted shell, which does not
4850 ;; allow "exec".
4853 ;; Send the command.
4857 p vec pos tramp-actions-before-shell
4861 ;; Next hop.
4865 ;; Make initial shell settings.
4868 ;; Mark it as connected.
4871 ;; When the user did interrupt, we must cleanup.
4874 ;; Propagate the quit signal.
4878 "Send the COMMAND to connection VEC.
4879 Erases temporary buffer before sending the command. If optional
4880 arg NEVEROPEN is non-nil, never try to open the connection. This
4881 is meant to be used from `tramp-maybe-open-connection' only. The
4882 function waits for output unless NOOUTPUT is set."
4886 ;; We mark the command string that it can be erased in the output buffer.
4888 ;; If we put `tramp-echo-mark' after a trailing newline (which
4889 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4890 ;; that newline and adds `tramp-rsh-end-of-line' right after
4891 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4892 ;; trailing line endings and sends two prompts after executing
4893 ;; the command, which confuses `tramp-wait-for-output'.
4897 ;; No need to restore a trailing newline here since `tramp-send-string'
4898 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4900 ;; Send the command.
4906 "Wait for output from remote command."
4912 ;; be leading escape sequences, which must be ignored.
4913 ;; Busyboxes built with the EDITING_ASK_TERMINAL config
4914 ;; option send also escape sequences, which must be
4915 ;; ignored.
4918 tramp-device-escape-sequence-regexp))
4919 ;; Sometimes, the commands do not return a newline but a
4920 ;; null byte before the shell prompt, for example "git
4921 ;; ls-files -c -z ...".
4926 ;; A simple-minded busybox has sent " ^H" sequences.
4927 ;; Delete them.
4932 ;; Delete the prompt.
4938 proc 'file-error
4939 "[[Remote prompt `%s' not found in %d secs]]"
4940 tramp-end-of-output timeout)
4942 proc 'file-error
4944 ;; Return value is whether end-of-output sentinel was found.
4945 found)))
4949 "Run COMMAND and check its exit status.
4950 Sends `echo $?' along with the COMMAND for checking the exit status.
4951 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4952 status is 0, and nil otherwise.
4954 If the optional argument SUBSHELL is non-nil, the command is
4955 executed in a subshell, ie surrounded by parentheses. If
4956 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4958 vec
4960 command
4962 "echo tramp_exit_status $?"
4976 "Run COMMAND, check exit status, throw error if exit status not okay.
4977 Similar to `tramp-send-command-and-check' but accepts two more arguments
4978 FMT and ARGS which are passed to `error'."
4983 "Run COMMAND and return the output, which must be a Lisp expression.
4984 If MARKER is a regexp, read the output after that string.
4985 In case there is no valid Lisp expression and NOERROR is nil, it
4986 raises an error."
4993 ;; Read the marker.
4999 vec 'file-error
5000 "`%s' does not return the marker `%s': `%s'"
5002 ;; Read the expression.
5005 ;; Error handling.
5010 vec 'file-error
5011 "`%s' does not return a valid Lisp expression: `%s'"
5015 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5016 Convert file mode bits to string and set virtual device number.
5017 Return ATTR."
5019 ;; Remove color escape sequences from symlink.
5023 ;; Convert uid and gid. Use `tramp-unknown-id-integer' as
5024 ;; indication of unusable value.
5035 ;; Convert last access time.
5040 ;; Convert last modification time.
5045 ;; Convert last status change time.
5050 ;; Convert file size.
5056 ;; Convert file mode bits to string.
5061 ;; Convert directory indication bit.
5064 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5070 ;; Set file's gid change bit.
5078 ;; Convert inode.
5084 ;; Inodes can be incredible huge. We must hide this.
5086 ;; Set virtual device number.
5089 attr))
5092 "Converts STRING to shell glob pattern which ignores case."
5098 string
5102 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5113 localname)
5119 "Return t if this is an out-of-band method, nil otherwise."
5121 ;; It shall be an out-of-band method.
5123 ;; There must be a size, otherwise the file doesn't exist.
5125 ;; Either the file size is large enough, or (in rare cases) there
5126 ;; does not exist a remote encoding.
5131 ;; Variables local to connection.
5135 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5136 ;; cache the result for the session only. Otherwise, the result
5137 ;; is cached persistently.
5140 vec)
5141 "remote-path"
5150 ;; Default if "getconf" is not available.
5153 vec 3
5158 ;; The login shell could return more than just the $PATH
5159 ;; string. So we use `tramp-end-of-heredoc' as marker.
5163 vec
5168 'identity
5172 'identity
5180 nil)))))
5182 ;; Replace place holder `tramp-default-remote-path'.
5190 ;; Replace place holder `tramp-own-remote-path'.
5198 ;; Remove double entries.
5205 ;; Remove non-existing directories.
5207 nil
5217 x))
5218 x))
5219 remote-path)))))
5225 locale)
5232 candidates nil)
5234 ;; Return value.
5244 result)
5246 ;; Check parameters. On busybox, "ls" output coloring is
5247 ;; enabled by default sometimes. So we try to disable it
5248 ;; when possible. $LS_COLORING is not supported there.
5249 ;; Some "ls" versions are sensible wrt the order of
5250 ;; arguments, they fail when "-al" is after the
5251 ;; "--color=never" argument (for example on FreeBSD).
5266 ;; Some "ls" versions are sensible wrt the order of arguments,
5267 ;; they fail when "-al" is after the "--dired" argument (for
5268 ;; example on FreeBSD).
5284 ;; Option "-w" is available on BSD systems. No argument is
5285 ;; given, because this could return wrong results in case "ls"
5286 ;; supports the "-w NUM" argument, as for busyboxes.
5294 "test"
5298 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5299 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5300 ;; for otherwise the shell crashes.
5312 vec
5335 ;; We must check also for some Perl modules.
5343 result)))
5350 tmp)
5351 ;; Check whether stat(1) returns usable syntax. "%s" does not
5352 ;; work on older AIX systems. Recent GNU stat versions (8.24?)
5353 ;; use shell quoted format for "%N", we check the boundaries "`"
5354 ;; and "'", therefore. See Bug#23422 in coreutils.
5363 result)))
5373 result))))
5389 ;; Busyboxes do support the "-t" option only when they have been
5390 ;; built with the DESKTOP config option. Let's check it.
5393 vec "touch-t"
5395 vec
5397 "%s -t %s %s"
5398 result
5402 result)))
5421 result)
5423 ;; Check POSIX parameter.
5430 vec
5439 vec
5443 "print $>"
5455 vec
5459 "import os; print (os.getuid())"
5473 ;; Ensure there is a valid result.
5476 tramp-unknown-id-integer)
5478 tramp-unknown-id-string)
5483 vec
5492 vec
5501 vec
5505 "import os; print (os.getgid())"
5519 ;; Ensure there is a valid result.
5522 tramp-unknown-id-integer)
5524 tramp-unknown-id-string)
5527 ;; Some predefined connection properties.
5529 "Return the compress command related to PROP.
5530 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5531 the length of the file to be compressed.
5533 If no corresponding command is found, nil is returned."
5542 "Return the coding command related to PROP.
5543 PROP is either `remote-encoding', `remote-decoding',
5544 `local-encoding' or `local-decoding'.
5546 SIZE is the length of the file to be coded. Depending on SIZE,
5547 compression might be applied.
5549 If no corresponding command is found, nil is returned.
5550 Otherwise, either a string is returned which contains a `%s' mark
5551 to be used for the respective input or output file; or a Lisp
5552 function cell is returned to be applied on a buffer."
5553 ;; We must catch the errors, because we want to return nil, when
5554 ;; no inline coding is found.
5564 compress)
5565 ;; The connection property might have been cached. So we must
5566 ;; send the script to the remote side - maybe.
5574 ;; Check for the `compress' command.
5576 ;; Return the value.
5597 coding)
5600 ;; Windows shells need the program file name after
5601 ;; the pipe symbol be quoted if they use forward
5602 ;; slashes as directory separators.
5609 coding compress))
5612 ;; Windows shells need the program file name after
5613 ;; the pipe symbol be quoted if they use forward
5614 ;; slashes as directory separators.
5619 compress coding))
5633 ;;; TODO:
5635 ;; * Don't use globbing for directories with many files, as this is
5636 ;; likely to produce long command lines, and some shells choke on
5637 ;; long command lines.
5638 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5639 ;; then look if it's the right version (with `perl -v').
5640 ;; * When editing a remote CVS controlled file as a different user, VC
5641 ;; gets confused about the file locking status. Try to find out why
5642 ;; the workaround doesn't work.
5643 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5644 ;; until the last but one hop via `start-file-process'. Apply it
5645 ;; also for ftp and smb.
5646 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5647 ;; some shell with root privileges, it would be nice if I could
5648 ;; just call
5649 ;; trampclient filename.c
5650 ;; as an editor, and the _current_ shell would connect to an Emacs
5651 ;; server and would be used in an existing non-privileged Emacs
5652 ;; session for doing the editing in question.
5653 ;; That way, I need not tell Emacs my password again and be afraid
5654 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5655 ;; once display a just typed password in the context of a keyboard
5656 ;; sequence prompt for a question immediately following in a shell
5657 ;; script run within Emacs -- nasty).
5658 ;; And if I have some ssh session running to a different computer,
5659 ;; having the possibility of passing a local file there to a local
5660 ;; Emacs session (in case I can arrange for a connection back) would
5661 ;; be nice.
5662 ;; Likely the corresponding Tramp server should not allow the
5663 ;; equivalent of the emacsclient -eval option in order to make this
5664 ;; reasonably unproblematic. And maybe trampclient should have some
5665 ;; way of passing credentials, like by using an SSL socket or
5666 ;; something. (David Kastrup)
5667 ;; * Reconnect directly to a compliant shell without first going
5668 ;; through the user's default shell. (Pete Forman)
5669 ;; * How can I interrupt the remote process with a signal
5670 ;; (interrupt-process seems not to work)? (Markus Triska)
5671 ;; * Avoid the local shell entirely for starting remote processes. If
5672 ;; so, I think even a signal, when delivered directly to the local
5673 ;; SSH instance, would correctly be propagated to the remote process
5674 ;; automatically; possibly SSH would have to be started with
5675 ;; "-t". (Markus Triska)
5676 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5677 ;; isn't on the remote host. (Mark A. Hershberger)
5678 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5679 ;; * Optimize out-of-band copying when both methods are scp-like (not
5680 ;; rsync).
5681 ;; * Keep a second connection open for out-of-band methods like scp or
5682 ;; rsync.
5684 ;;; tramp-sh.el ends here