| blob | 1753c73f8694ee8915e4ab2fb4984c190e6f7f00 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2015 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.
43 ;;;###tramp-autoload
45 "The minimum size of compressing where inline transfer.
46 When inline transfer, compress transferred data of file
47 whose size is this value or above (up to `tramp-copy-size-limit').
48 If it is nil, no compression at all will be applied."
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."
60 ;;;###tramp-autoload
62 "Value of TERM environment variable for logging in to remote host.
63 Because Tramp wants to parse the output of the remote shell, it is easily
64 confused by ANSI color escape sequences and suchlike. Often, shell init
65 files conditionalize this setup based on the TERM environment variable."
69 ;;;###tramp-autoload
71 "When invoking a shell, override the HISTFILE with this value.
72 When setting to a string, it redirects the shell history to that
76 The value t, the default value, unsets any setting of HISTFILE,
77 and sets both HISTFILESIZE and HISTSIZE to 0. If you set this
78 variable to nil, however, the *override* is disabled, so the
79 history will go to the default storage location,
87 ;;;###tramp-autoload
91 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
92 ;; root users. It uses the `$' character for other users. In order
93 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
97 "///%s#$"
99 "String used to recognize end of output.
100 The `$' character at the end is quoted; the string cannot be
103 ;;;###tramp-autoload
110 ;;;###tramp-autoload
112 "Whether to use `tramp-ssh-controlmaster-options'."
118 "Which ssh Control* arguments to use.
120 If it is a string, it should have the form
123 spec must be doubled, because the string is used as format string.
125 Otherwise, it will be auto-detected by Tramp, if
126 `tramp-use-ssh-controlmaster-options' is non-nil. The value
127 depends on the installed local ssh version.
131 ;; Initialize `tramp-methods' with the supported methods.
132 ;;;###tramp-autoload
144 ;;;###tramp-autoload
155 ;;;###tramp-autoload
173 ;;;###tramp-autoload
192 ;;;###tramp-autoload
208 ;;;###tramp-autoload
216 ;;;###tramp-autoload
224 ;;;###tramp-autoload
238 ;;;###tramp-autoload
252 ;;;###tramp-autoload
261 ;;;###tramp-autoload
270 ;; We use "-v" for better error tracking.
273 ;; We use "-p" as required for newer busyboxes. For older
274 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
275 ;; can be achieved by tweaking `tramp-connection-properties'.
278 ;;;###tramp-autoload
287 ;;;###tramp-autoload
291 ;; The password template must be masked. Otherwise, it could be
292 ;; interpreted as password prompt if the remote host echoes the command.
295 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
301 ;;;###tramp-autoload
310 ;;;###tramp-autoload
318 ;;;###tramp-autoload
322 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
326 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
327 tramp-terminal-type
328 tramp-initial-end-of-output))
334 ;;;###tramp-autoload
340 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
341 tramp-terminal-type
342 tramp-initial-end-of-output))
347 ;;;###tramp-autoload
354 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
355 tramp-terminal-type
356 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))
386 ;;;###tramp-autoload
398 ;;;###tramp-autoload
402 ;;;###tramp-autoload
406 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
407 ;; Do not add "plink" based methods, they ask interactively for the user.
408 ;;;###tramp-autoload
417 ;;;###tramp-autoload
423 ;;;###tramp-autoload
439 ;;;###tramp-autoload
444 ;;;###tramp-autoload
449 ;;;###tramp-autoload
457 ;;;###tramp-autoload
484 ;; "getconf PATH" yields:
485 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
486 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
487 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
488 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
489 ;; IRIX64: /usr/bin
490 ;;;###tramp-autoload
496 "List of directories to search for executables on remote host.
497 For every remote host, this variable will be set buffer local,
498 keeping the list of existing directories on that host.
500 You can use `~' in this list, but when searching for a shell which groks
501 tilde expansion, all directory names starting with `~' will be ignored.
503 `Default Directories' represent the list of directories given by
505 entry on top of this list, because these are the default
506 directories for POSIX compatible commands. On remote hosts which
507 do not offer the getconf command (like cygwin), the value
510 `Private Directories' are the settings of the $PATH environment,
511 as given in your `~/.profile'."
518 ;;;###tramp-autoload
525 "List of environment variables to be set on the remote host.
527 Each element should be a string of the form ENVVARNAME=VALUE. An
528 entry ENVVARNAME= disables the corresponding environment variable,
529 which might have been set in the init files like ~/.profile.
531 Special handling is applied to the PATH environment, which should
532 not be set here. Instead, it should be set via `tramp-remote-path'."
537 ;;;###tramp-autoload
539 "Alist specifying extra arguments to pass to the remote shell.
540 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
541 matching the shell file name and ARGS is a string specifying the
542 arguments.
544 This variable is only used when Tramp needs to start up another shell
545 for tilde expansion. The extra arguments should typically prevent the
546 shell from reading its init file."
548 ;; This might be the wrong way to test whether the widget type
549 ;; `alist' is available. Who knows the right way to test it?
564 "List of pattern/action pairs.
565 Whenever a pattern matches, the corresponding action is performed.
566 Each item looks like (PATTERN ACTION).
568 The PATTERN should be a symbol, a variable. The value of this
569 variable gives the regular expression to search for. Note that the
571 appended to it.
573 The ACTION should also be a symbol, but a function. When the
581 "List of pattern/action pairs.
582 This list is used for copying/renaming with out-of-band methods.
587 "(echo begin 600 %t; tail -n +2) | uudecode
588 cat %t
589 rm -f %t"
590 "Shell function to implement `uudecode' to standard output.
591 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
592 for this or `uudecode -p', but some systems don't, and for them
596 "%s -e '
597 use File::Spec;
600 sub recursive {
601 my ($volume, @dirs) = @_;
602 my $real = realpath(File::Spec->catpath(
604 if ($real) {
605 my ($vol, $dir) = File::Spec->splitpath($real, 1);
606 return ($vol, File::Spec->splitdir($dir));
607 }
608 else {
609 my $last = pop(@dirs);
610 ($volume, @dirs) = recursive($volume, @dirs);
611 push(@dirs, $last);
612 return ($volume, @dirs);
613 }
614 }
616 $result = realpath($ARGV[0]);
617 if (!$result) {
618 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
619 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
622 }
626 }
630 "Perl script to produce output suitable for use with `file-truename'
631 on the remote file system.
632 Escape sequence %s is replaced with name of Perl binary.
636 "%s -e 'sub case {
637 my $str = shift;
638 if ($ARGV[2]) {
639 return lc($str);
640 }
641 else {
642 return $str;
643 }
644 }
646 @files = readdir(d); closedir(d);
647 foreach $f (@files) {
648 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
651 }
652 else {
654 }
655 }
656 }
659 "Perl script to produce output suitable for use with
660 `file-name-all-completions' on the remote file system. Escape
661 sequence %s is replaced with name of Perl binary. This string is
664 ;; Perl script to implement `file-attributes' in a Lisp `read'able
665 ;; output. If you are hacking on this, note that you get *no* output
666 ;; unless this spits out a complete line, including the '\n' at the
667 ;; end.
668 ;; The device number is returned as "-1", because there will be a virtual
669 ;; device number set in `tramp-sh-handle-file-attributes'.
671 "%s -e '
672 @stat = lstat($ARGV[0]);
673 if (!@stat) {
675 exit 0;
676 }
677 if (($stat[2] & 0170000) == 0120000)
678 {
679 $type = readlink($ARGV[0]);
682 }
683 elsif (($stat[2] & 0170000) == 040000)
684 {
686 }
687 else
688 {
690 };
693 printf(
695 $type,
696 $stat[3],
697 $uid,
698 $gid,
699 $stat[8] >> 16 & 0xffff,
700 $stat[8] & 0xffff,
701 $stat[9] >> 16 & 0xffff,
702 $stat[9] & 0xffff,
703 $stat[10] >> 16 & 0xffff,
704 $stat[10] & 0xffff,
705 $stat[7],
706 $stat[2],
707 $stat[1] >> 16 & 0xffff,
708 $stat[1] & 0xffff
710 "Perl script to produce output suitable for use with `file-attributes'
711 on the remote file system.
712 Escape sequence %s is replaced with name of Perl binary.
716 "%s -e '
719 @list = readdir(DIR);
720 closedir(DIR);
721 $n = scalar(@list);
723 for($i = 0; $i < $n; $i++)
724 {
725 $filename = $list[$i];
726 @stat = lstat($filename);
727 if (($stat[2] & 0170000) == 0120000)
728 {
729 $type = readlink($filename);
732 }
733 elsif (($stat[2] & 0170000) == 040000)
734 {
736 }
737 else
738 {
740 };
744 printf(
745 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
746 $filename,
747 $type,
748 $stat[3],
749 $uid,
750 $gid,
751 $stat[8] >> 16 & 0xffff,
752 $stat[8] & 0xffff,
753 $stat[9] >> 16 & 0xffff,
754 $stat[9] & 0xffff,
755 $stat[10] >> 16 & 0xffff,
756 $stat[10] & 0xffff,
757 $stat[7],
758 $stat[2],
759 $stat[1] >> 16 & 0xffff,
760 $stat[1] & 0xffff,
761 $stat[0] >> 16 & 0xffff,
762 $stat[0] & 0xffff);
763 }
765 "Perl script implementing `directory-files-attributes' as Lisp `read'able
766 output.
767 Escape sequence %s is replaced with name of Perl binary.
770 ;; These two use base64 encoding.
772 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
773 "Perl program to use for encoding a file.
774 Escape sequence %s is replaced with name of Perl binary.
775 This string is passed to `format', so percent characters need to be doubled.
776 This implementation requires the MIME::Base64 Perl module to be installed
780 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
781 "Perl program to use for decoding a file.
782 Escape sequence %s is replaced with name of Perl binary.
783 This string is passed to `format', so percent characters need to be doubled.
784 This implementation requires the MIME::Base64 Perl module to be installed
788 "%s -e '
789 # This script contributed by Juanma Barranquero <lektu@terra.es>.
790 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
791 use strict;
793 my %%trans = do {
794 my $i = 0;
795 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
796 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
797 };
798 my $data;
800 # We read in chunks of 54 bytes, to generate output lines
801 # of 72 chars (plus end of line)
802 while (read STDIN, $data, 54) {
803 my $pad = q();
805 # Only for the last chunk, and only if did not fill the last three-byte packet
806 if (eof) {
807 my $mod = length($data) %% 3;
808 $pad = q(=) x (3 - $mod) if $mod;
809 }
811 # Not the fastest method, but it is simple: unpack to binary string, split
812 # by groups of 6 bits and convert back from binary to byte; then map into
813 # the translation table
814 print
815 join q(),
816 map($trans{$_},
817 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
818 $pad,
820 }' 2>/dev/null"
821 "Perl program to use for encoding a file.
822 Escape sequence %s is replaced with name of Perl binary.
826 "%s -e '
827 # This script contributed by Juanma Barranquero <lektu@terra.es>.
828 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
829 use strict;
831 my %%trans = do {
832 my $i = 0;
833 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
834 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
835 };
837 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
841 # We are going to accumulate into $pending to accept any line length
842 # (we do not check they are <= 76 chars as the RFC says)
843 my $pending = q();
845 while (my $data = <STDIN>) {
846 chomp $data;
848 # If we find one or two =, we have reached the end and
849 # any following data is to be discarded
850 my $finished = $data =~ s/(==?).*/$1/;
851 $pending .= $data;
853 my $len = length($pending);
854 my $chunk = substr($pending, 0, $len & ~3);
855 $pending = substr($pending, $len & ~3 + 1);
857 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
858 # split in 8-bit chunks and convert back to char.
859 print join q(),
860 map $bytes{$_},
861 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
863 last if $finished;
864 }' 2>/dev/null"
865 "Perl program to use for decoding a file.
866 Escape sequence %s is replaced with name of Perl binary.
870 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
871 "Perl program to use for encoding a file.
875 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
876 "Perl program to use for decoding a file.
881 BEGIN {
884 }
885 {
886 for (c=1; c<=length($0); c++) {
887 d=index(b16, substr($0,c,1))
888 if (d--) {
889 for (b=1; b<=4; b++) {
890 o=o*2+int(d/8); d=(d*2)%%16
891 if (++obc==6) {
892 printf substr(b64,o+1,1)
894 obc=0; o=0
895 }
896 }
897 }
898 }
899 }
900 END {
901 if (obc) {
903 while (obc++<6) { o=o*2 }
905 } else {
907 }
908 printf tail
909 }'"
910 "Awk program to use for encoding a file.
915 BEGIN {
917 }
918 {
919 for (i=1; i<=length($0); i++) {
920 c=index(b64, substr($0,i,1))
921 if(c--) {
922 for(b=0; b<6; b++) {
923 o=o*2+int(c/32); c=(c*2)%%64
924 if(++obc==8) {
925 if (o) {
927 } else {
929 }
930 obc=0; o=0
931 }
932 }
933 }
934 }
935 }'"
936 "Awk program to use for decoding a file.
940 "test -c /dev/zero && \
941 od -v -t x1 -A n </dev/null && \
942 busybox awk '{}' </dev/null"
953 while read file; do
956 else
958 fi
961 else
963 fi
964 done
966 "Script to check existence of VC related files.
967 It must be send formatted with two strings; the tests for file
968 existence, and file readability. Input shall be read via
969 here-document, otherwise the command could exceed maximum length
972 ;; New handlers should be added here.
976 ;; `byte-compiler-base-file-name' performed by default handler.
981 ;; `diff-latest-backup-file' performed by default handler.
985 . tramp-sh-handle-directory-files-and-attributes)
986 ;; `dired-call-process' performed by default handler.
989 . tramp-sh-handle-dired-recursive-delete-directory)
996 ;; `file-equal-p' performed by default handler.
999 ;; `file-in-directory-p' performed by default handler.
1007 ;; `file-name-sans-versions' performed by default handler.
1021 ;; `find-file-noselect' performed by default handler.
1022 ;; `get-file-buffer' performed by default handler.
1026 . tramp-sh-handle-insert-file-contents-literally)
1045 "Alist of handler functions.
1048 ;; This must be the last entry, because `identity' always matches.
1049 ;;;###tramp-autoload
1053 ;;; File Name Handler Functions:
1057 "Like `make-symbolic-link' for Tramp files.
1058 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1059 the symlink. If LINKNAME is a Tramp file, only the localname component is
1060 used as the target of the symlink.
1062 If LINKNAME is a Tramp file and the localname component is relative, then
1063 it is expanded first, before the localname component is taken. Note that
1064 this can give surprising results if the user/host for the source and
1065 target of the symlink differ."
1072 l 'file-error
1075 ;; Do the 'confirm if exists' thing.
1077 ;; What to do?
1082 "File %s already exists; make it a link anyway? "
1083 l-localname)))))
1088 ;; If FILENAME is a Tramp name, use just the localname component.
1097 ;; Right, they are on the same host, regardless of user, method,
1098 ;; etc. We now make the link on the remote machine. This will
1099 ;; occur as the user that FILENAME belongs to.
1101 l
1103 "cd %s && %s -sf %s %s"
1105 ln
1108 t))))
1111 "Like `file-truename' for Tramp files."
1113 "%s%s"
1116 method user host
1121 ;; Use GNU readlink --canonicalize-missing where available.
1124 v
1132 ;; Use Perl implementation.
1140 v
1144 ;; Do it yourself. We bind `directory-sep-char' here for
1145 ;; XEmacs on Windows, which would otherwise use backslash.
1153 ;; Don't make the following value larger than
1154 ;; necessary. People expect an error message in
1155 ;; a timely fashion when something is wrong;
1156 ;; otherwise they might think that Emacs is hung.
1157 ;; Of course, correctness has to come first.
1159 symlink-target)
1170 method user host
1182 ;; It's a symlink, follow it.
1188 ;; If the symlink was absolute, we'll get a
1189 ;; string like "/user@host:/some/target";
1190 ;; extract the "/some/target" part from it.
1194 v 'file-error
1195 "Symlink target `%s' on wrong host"
1196 symlink-target))
1201 steps)))
1203 ;; It's a file.
1207 v 'file-error
1210 ;; Combine list to form string.
1221 result))))
1223 ;; Preserve trailing "/".
1226 ;; Basic functions.
1229 "Like `file-exists-p' for Tramp files."
1237 v
1239 "%s %s"
1244 "Like `file-attributes' for Tramp files."
1247 ;; Don't modify `last-coding-system-used' by accident.
1254 v
1262 ;; The scripts could fail, for example with huge file size.
1266 "Implement `file-attributes' for Tramp files using the ls(1) command."
1268 res-inode res-filemodes res-numlinks
1269 res-uid res-gid res-size res-symlink-target)
1272 vec
1279 ;; On systems which have no quoting style, file names
1280 ;; with special characters could fail.
1285 ;; Parse `ls -l' output ...
1289 ;; ... inode
1305 ;; ... file mode flags
1307 ;; ... number links
1309 ;; ... uid and gid
1319 ;; ... size
1321 ;; From the file modes, figure out other stuff.
1324 ;; If symlink, find out file name pointed to.
1331 ;; Return data gathered.
1333 ;; 0. t for directory, string (name linked to) for symbolic
1334 ;; link, or nil.
1336 ;; 1. Number of links to file.
1337 res-numlinks
1338 ;; 2. File uid.
1339 res-uid
1340 ;; 3. File gid.
1341 res-gid
1342 ;; 4. Last access time, as a list of integers. Normally this
1343 ;; would be in the same format as `current-time', but the
1344 ;; subseconds part is not currently implemented, and (0 0)
1345 ;; denotes an unknown time.
1346 ;; 5. Last modification time, likewise.
1347 ;; 6. Last status change time, likewise.
1349 ;; 7. Size in bytes (-1, if number is out of range).
1350 res-size
1351 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1352 res-filemodes
1353 ;; 9. t if file's gid would change if file were deleted and
1354 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1355 t
1356 ;; 10. Inode number.
1357 res-inode
1358 ;; 11. Device number. Will be replaced by a virtual device number.
1359 -1
1360 )))))
1364 "Implement `file-attributes' for Tramp files using a Perl script."
1369 vec
1375 "Implement `file-attributes' for Tramp files using stat(1) command."
1378 vec
1381 ;; On Opsware, pdksh (which is the true name of ksh there)
1382 ;; doesn't parse correctly the sequence "((". Therefore, we add
1383 ;; a space. Apostrophes in the stat output are masked as
1384 ;; `tramp-stat-marker', in order to make a proper shell escape of
1385 ;; them in file names.
1386 "( (%s %s || %s -h %s) && (%s -c "
1387 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1394 tramp-stat-marker tramp-stat-marker
1399 tramp-stat-marker tramp-stat-marker
1401 tramp-stat-quoted-marker)))
1404 "Like `set-visited-file-modtime' for Tramp files."
1411 coding-system-used)
1415 ;; '(-1 65535) means file doesn't exists yet.
1419 ;; We use '(0 0) as a don't-know value. See also
1420 ;; `tramp-do-file-attributes-with-ls'.
1425 v
1434 nil)))))
1436 ;; This function makes the same assumption as
1437 ;; `tramp-sh-handle-set-visited-file-modtime'.
1439 "Like `verify-visited-file-modtime' for Tramp files.
1440 At the time `verify-visited-file-modtime' calls this function, we
1441 already know that the buffer is visiting a file and that
1442 `visited-file-modtime' does not return 0. Do not call this
1443 function directly, unless those two cases are already taken care
1444 of."
1447 ;; There is no file visiting the buffer, or the buffer has no
1448 ;; recorded last modification time, or there is no established
1449 ;; connection.
1453 t
1461 ;; File exists, and has a known modtime.
1464 modtime
1465 ;; For compatibility, deal with both the old
1466 ;; (HIGH . LOW) and the new (HIGH LOW) return
1467 ;; values of `visited-file-modtime'.
1470 mt)))
1472 ;; Modtime has the don't know value.
1475 v
1482 attr
1485 ;; If file does not exist, say it is not modified if and
1486 ;; only if that agrees with the buffer's record.
1490 "Like `set-file-modes' for Tramp files."
1494 ;; FIXME: extract the proper text from chmod's stderr.
1496 v
1503 "Like `set-file-times' for Tramp files."
1511 time))
1512 ;; With GNU Emacs, `format-time-string' has an
1513 ;; optional parameter UNIVERSAL. This is preferred,
1514 ;; because we could handle the case when the remote
1515 ;; host is located in a different time zone as the
1516 ;; local host.
1520 "%s %s %s %s"
1531 ;; We handle also the local part, because in older Emacsen,
1532 ;; without `set-file-times', this function is an alias for this.
1533 ;; We are local, so we don't need the UTC settings.
1541 "Set the ownership for FILENAME.
1542 If UID and GID are provided, these values are used; otherwise uid
1543 and gid of the corresponding user is taken. Both parameters must
1544 be non-negative integers."
1545 ;; Modern Unices allow chown only for root. So we might need
1546 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1547 ;; working with su(do)? when it is needed, so it shall succeed in
1548 ;; the majority of cases.
1549 ;; Don't modify `last-coding-system-used' by accident.
1554 ;; If we are root on the local host, we can do it directly.
1562 "chown %d:%d %s" uid gid
1565 ;; We handle also the local part, because there doesn't exist
1566 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1567 ;; timeout for this.
1572 nil "chown" nil nil nil
1576 "Check, whether SELINUX is enabled on the remote host."
1581 "Like `file-selinux-context' for Tramp files."
1590 "%s -d -Z %s"
1598 ;; Return the context.
1599 context))))
1602 "Like `set-file-selinux-context' for Tramp files."
1622 t)))))
1625 "Check, whether ACL is enabled on the remote host."
1630 "Like `file-acl' for Tramp files."
1636 "getfacl -ac %s"
1646 "Like `set-file-acl' for Tramp files."
1653 tramp-end-of-heredoc
1654 acl-string
1655 tramp-end-of-heredoc))
1657 ;; Success.
1660 t)
1661 ;; In case of errors, we return nil.
1663 nil)))
1665 ;; Simple functions using the `test' command.
1668 "Like `file-executable-p' for Tramp files."
1671 ;; Examine `file-attributes' cache to see if request can be
1672 ;; satisfied without remote operation.
1677 "Like `file-readable-p' for Tramp files."
1680 ;; Examine `file-attributes' cache to see if request can be
1681 ;; satisfied without remote operation.
1685 ;; When the remote shell is started, it looks for a shell which groks
1686 ;; tilde expansion. Here, we assume that all shells which grok tilde
1687 ;; expansion will also provide a `test' command which groks `-nt' (for
1688 ;; newer than). If this breaks, tell me about it and I'll try to do
1689 ;; something smarter about it.
1691 "Like `file-newer-than-file-p' for Tramp files."
1693 nil)
1695 t)
1696 ;; We are sure both files exist at this point.
1699 ;; We try to get the mtime of both files. If they are not
1700 ;; equal to the "dont-know" value, then we subtract the times
1701 ;; and obtain the result.
1707 ;; If one of them is the dont-know value, then we can
1708 ;; still try to run a shell command on the remote host.
1709 ;; However, this only works if both files are Tramp
1710 ;; files and both have the same method, same user, same
1711 ;; host.
1716 v 'file-error
1717 "Files %s and %s must have same method, user, host"
1718 file1 file2)))
1723 ;; Functions implemented using the basic functions above.
1726 "Like `file-directory-p' for Tramp files."
1728 ;; `file-directory-p' is used as predicate for file name completion.
1729 ;; Sometimes, when a connection is not established yet, it is
1730 ;; desirable to return t immediately for "/method:foo:". It can
1731 ;; be expected that this is always a directory.
1737 "Like `file-writable-p' for Tramp files."
1741 ;; Examine `file-attributes' cache to see if request can be
1742 ;; satisfied without remote operation.
1745 ;; If file doesn't exist, check if directory is writable.
1750 "Like `file-ownership-preserved-p' for Tramp files."
1754 ;; Return t if the file doesn't exist, since it's true that no
1755 ;; information would be lost by an (attempted) delete and create.
1762 ;; Directory listings.
1766 "Like `directory-files-and-attributes' for Tramp files."
1774 v localname
1785 v localname id-format))
1788 v localname id-format))
1790 result item)
1800 result
1802 ;; The scripts could fail, for example with huge file size.
1804 directory full match nosort id-format)))))
1808 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1811 vec tramp-perl-directory-files-and-attributes
1815 vec
1819 object))
1823 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1826 vec
1829 ;; We must care about file names with spaces, or starting with
1830 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1831 ;; but it does not work on all remote systems. Apostrophes in
1832 ;; the stat output are masked as `tramp-stat-marker', in order to
1833 ;; make a proper shell escape of them in file names.
1835 "xargs %s -c "
1836 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1840 ;; On systems which have no quoting style, file names with
1841 ;; special characters could fail.
1845 tramp-stat-marker tramp-stat-marker
1846 tramp-stat-marker tramp-stat-marker
1851 tramp-stat-marker tramp-stat-marker
1852 tramp-stat-quoted-marker)))
1854 ;; This function should return "foo/" for directories and "bar" for
1855 ;; files.
1857 "Like `file-name-all-completions' for Tramp files."
1862 filename
1864 'list
1866 ;; Try cache entries for `filename', `filename' with last
1867 ;; character removed, `filename' with last two characters
1868 ;; removed, ..., and finally the empty string - all
1869 ;; concatenated to the local directory name.
1872 tramp-completion-reread-directory-timeout)))
1874 ;; This is inefficient for very long file names, pity
1875 ;; `reduce' is not available...
1878 'append
1883 v
1885 "file-name-all-completions"
1886 nil)))
1888 ;; We cannot use a length of 0, because file properties
1889 ;; for "foo" and "foo/" are identical.
1892 ;; Cache expired or no matching cache entry found so we need
1893 ;; to perform a remote operation.
1895 ;; Get a list of directories and files, including reliably
1896 ;; tagging the directories with a trailing '/'. Because I
1897 ;; rock. --daniel@danann.net
1899 ;; Changed to perform `cd' in the same remote op and only
1900 ;; get entries starting with `filename'. Capture any `cd'
1901 ;; error messages. Ensure any `cd' and `echo' aliases are
1902 ;; ignored.
1904 v
1908 v tramp-perl-file-name-all-completions
1914 ;; `read-file-name-completion-ignore-case'
1915 ;; is introduced with Emacs 22.1.
1918 'read-file-name-completion-ignore-case
1923 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1924 ;; `ls' with wildcard might fail with `Argument
1925 ;; list too long' error in some corner cases; if
1926 ;; `ls' fails after `cd' succeeded, chances are
1927 ;; that's the case, so let's retry without
1928 ;; wildcard. This will return "too many" entries
1929 ;; but that isn't harmful.
1930 " || %s -a 2>/dev/null)"
1931 " | while IFS= read f; do"
1937 ;; When `filename' is empty, just `ls' without
1938 ;; `filename' argument is more efficient than `ls *'
1939 ;; for very large directories and might avoid the
1940 ;; `Argument list too long' error.
1941 ;;
1942 ;; With and only with wildcard, we need to add
1943 ;; `-d' to prevent `ls' from descending into
1944 ;; sub-directories.
1946 "."
1951 ;; Now grab the output.
1955 ;; Check result code, found in last line of output.
1959 ;; Grab error message from line before last line
1960 ;; (it was put there by `cd 2>&1').
1963 v 'file-error
1964 "tramp-sh-handle-file-name-all-completions: %s"
1966 ;; For peace of mind, if buffer doesn't end in `fail'
1967 ;; then it should end in `ok'. If neither are in the
1968 ;; buffer something went seriously wrong on the remote
1969 ;; side.
1972 v 'file-error
1973 "\
1974 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1980 ;; Because the remote op went through OK we know the
1981 ;; directory we `cd'-ed to exists.
1984 ;; Because the remote op went through OK we know every
1985 ;; file listed by `ls' exists.
1989 result)
1991 ;; Store result in the cache.
1996 ;; cp, mv and ln
2000 "Like `add-name-to-file' for Tramp files."
2005 v 'file-error
2006 "add-name-to-file: %s"
2015 "File %s already exists; make it a new name anyway? "
2016 newname)))
2023 v1
2027 "error with add-name-to-file, see buffer `%s' for details"
2032 preserve-uid-gid preserve-extended-attributes)
2033 "Like `copy-file' for Tramp files."
2037 ;; At least one file a Tramp file?
2041 'copy filename newname ok-if-already-exists keep-date
2042 preserve-uid-gid preserve-extended-attributes))
2043 ;; Compat section.
2046 'copy-file
2048 preserve-uid-gid preserve-extended-attributes)))
2051 'copy-file
2059 "Like `copy-directory' for Tramp files."
2065 ;; When DIRNAME and NEWNAME are remote, they must have
2066 ;; the same method.
2072 ;; scp or rsync DTRT.
2086 ;; We must do it file-wise.
2088 'copy-directory
2093 ;; When newname did exist, we have wrong cached values.
2101 "Like `rename-file' for Tramp files."
2102 ;; Check if both files are local -- invoke normal rename-file.
2103 ;; Otherwise, use Tramp from local system.
2106 ;; At least one file a Tramp file?
2116 preserve-uid-gid preserve-extended-attributes)
2117 "Copy or rename a remote file.
2118 OP must be `copy' or `rename' and indicates the operation to perform.
2119 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2120 the new file (for copy) or the new name of the file (for rename).
2121 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2122 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2123 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2124 the uid and gid if both files are on the same host.
2125 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2127 This function is invoked by `tramp-sh-handle-copy-file' and
2128 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2129 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2130 file names."
2147 filename newname)
2150 ;; Both are Tramp files.
2155 ;; Shortcut: if method, host, user are the same for
2156 ;; both files, we invoke `cp' or `mv' on the remote
2157 ;; host directly.
2160 op filename newname
2161 ok-if-already-exists keep-date preserve-uid-gid))
2163 ;; Try out-of-band operation.
2168 op filename newname keep-date))
2170 ;; No shortcut was possible. So we copy the file
2171 ;; first. If the operation was `rename', we go back
2172 ;; and delete the original file (if the copy was
2173 ;; successful). The approach is simple-minded: we
2174 ;; create a new buffer, insert the contents of the
2175 ;; source file into it, then write out the buffer to
2176 ;; the target file. The advantage is that it doesn't
2177 ;; matter which file name handlers are used for the
2178 ;; source and target file.
2181 op filename newname keep-date))))))
2183 ;; One file is a Tramp file, the other one is local.
2186 ;; Fast track on local machine.
2189 op filename newname
2190 ok-if-already-exists keep-date preserve-uid-gid))
2192 ;; If the Tramp file has an out-of-band method, the
2193 ;; corresponding copy-program can be invoked.
2196 op filename newname keep-date))
2198 ;; Use the inline method via a Tramp buffer.
2200 op filename newname keep-date))))
2203 ;; One of them must be a Tramp file.
2206 ;; Handle `preserve-extended-attributes'. We ignore possible
2207 ;; errors, because ACL strings could be incompatible.
2212 ;; In case of `rename', we must flush the cache of the source file.
2218 ;; When newname did exist, we have wrong cached values.
2225 "Use an Emacs buffer to copy or rename a file.
2226 First arg OP is either `copy' or `rename' and indicates the operation.
2227 FILENAME is the source file, NEWNAME the target file.
2228 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2229 ;; We must disable multibyte, because binary data shall not be
2230 ;; converted. We don't want the target file to be compressed, so we
2231 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2232 ;; be called either. We remove `tramp-file-name-handler' from
2233 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2234 ;; `insert-file-contents' might be deactivated in some corner cases.
2245 ;; KEEP-DATE handling.
2247 ;; Set the mode.
2249 ;; If the operation was `rename', delete the original file.
2254 "Invokes `cp' or `mv' on the remote system.
2255 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2256 respectively. FILENAME specifies the file to copy or rename,
2257 NEWNAME is the name of the new file (for copy) or the new name of
2258 the file (for rename). Both files must reside on the same host.
2259 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2260 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2261 the uid and gid from FILENAME."
2271 v 'file-error
2272 "Unknown operation `%s', must be `copy' or `rename'"
2273 op))))
2277 filename))
2281 newname))
2283 cmd-result)
2286 ;; Both files are on a remote host, with same user.
2298 ;; Mask cp -f error.
2300 tramp-operation-not-permitted-regexp nil t))
2301 cmd-result)
2303 nil v 'file-error
2304 "Copying directly failed, see buffer `%s' for details."
2307 ;; We are on the local host.
2310 ;; We can do it directly.
2313 ;; No sticky bit when renaming.
2324 localname1 localname2 ok-if-already-exists
2325 keep-date preserve-uid-gid)
2329 ;; We can do it directly with `tramp-send-command'
2337 ok-if-already-exists keep-date t)
2338 ;; We must change the ownership to the local user.
2344 ;; We need a temporary file in between.
2346 ;; Create the temporary file.
2354 "%s %s %s" cmd
2357 "Copying directly failed, see buffer `%s' for details."
2359 ;; We must change the ownership as remote user.
2360 ;; Since this does not work reliable, we also
2361 ;; give read permissions.
2372 localname1 tmpfile t
2373 keep-date preserve-uid-gid)
2375 'rename-file
2377 ;; We must change the ownership as local user.
2378 ;; Since this does not work reliable, we also
2379 ;; give read permissions.
2383 tmpfile
2387 ;; Move the temporary file to its destination.
2392 "cp -f -p %s %s"
2395 "Copying directly failed, see buffer `%s' for details."
2399 'rename-file
2402 ;; Save exit.
2405 ;; Set the time and mode. Mask possible errors.
2412 "Invoke `scp' program to copy.
2413 The method used must be an out-of-band method."
2417 copy-program copy-args copy-env copy-keep-date port listener spec
2418 options source target remote-copy-program remote-copy-args)
2423 ;; Both are Tramp files. We shall optimize it when the
2424 ;; methods for FILENAME and NEWNAME are the same.
2434 op filename tmpfile keep-date)
2437 ;; Save exit.
2444 ;; Set variables for computing the prompt for reading
2445 ;; password.
2452 ;; Expand hops. Might be necessary for gateway methods.
2456 ;; Check which ones of source and target are Tramp files.
2468 'file-name-directory
2470 newname))))
2472 ;; Check for host and port number. We cannot use
2473 ;; `tramp-file-name-port', because this returns also
2474 ;; `tramp-default-port', which might clash with settings in
2475 ;; "~/.ssh/config".
2482 ;; Check for user. There might be an interactive setting.
2486 ;; Check for listener port.
2493 ;; Compose copy command.
2502 ?h host ?u user ?p port ?r listener ?c options
2508 copy-args
2510 ;; " " has either been a replacement of "%k" (when
2511 ;; keep-date argument is non-nil), or a replacement
2512 ;; for the whole keep-date sublist.
2513 " "
2518 copy-args
2522 copy-env
2524 nil
2531 remote-copy-program
2537 remote-copy-args
2541 ;; Check for local copy program.
2546 ;; Install listener on the remote side. The prompt must be
2547 ;; consumed later on, when the process does not listen anymore.
2554 v 'file-error
2558 'identity
2566 v 'file-error
2567 "Listener process not running on remote host: `%s'"
2568 remote-copy-program))
2576 ;; The default directory must be remote.
2580 ;; Set the transfer process properties.
2590 copy-args
2592 copy-args
2597 ;; Use an asynchronous process. By this, password can
2598 ;; be handled. We don't set a timeout, because the
2599 ;; copying of large files can last longer than 60
2600 ;; secs.
2604 copy-program
2606 copy-args
2615 ;; We must adapt `tramp-local-end-of-line' for
2616 ;; sending the password.
2619 p v nil tramp-actions-copy-out-of-band))
2621 ;; Check the return code.
2626 orig-vec 'file-error
2627 "Couldn't find exit status of `%s'"
2633 orig-vec 'file-error
2634 "Error copying: `%s'"
2637 ;; Reset the transfer process properties.
2640 ;; Clear the remote prompt.
2643 ;; Houston, we have a problem! Likely, the listener is
2644 ;; still running, so let's clear everything (but the
2645 ;; cached password).
2648 ;; Handle KEEP-DATE argument.
2652 ;; Set the mode.
2657 ;; If the operation was `rename', delete the original file.
2664 "Like `make-directory' for Tramp files."
2676 "Like `delete-directory' for Tramp files."
2688 "Like `delete-file' for Tramp files."
2699 ;; Dired.
2701 ;; CCC: This does not seem to be enough. Something dies when
2702 ;; we try and delete two directories under Tramp :/
2704 "Recursively delete the directory given.
2705 This is like `dired-recursive-delete-directory' for Tramp files."
2707 ;; Run a shell command 'rm -r <localname>'.
2708 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2711 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2713 v
2715 ;; Don't read the output, do it explicitly.
2716 nil t)
2717 ;; Wait for the remote system to return to us...
2718 ;; This might take a while, allow it plenty of time.
2720 ;; Make sure that it worked...
2728 "Like `dired-compress-file' for Tramp files."
2729 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2730 ;; Code stolen mainly from dired-aux.el.
2736 ;; Emacs case
2738 ;; XEmacs has `dired-compression-method-alist', which is
2739 ;; transformed into `dired-compress-file-suffixes' structure.
2743 nil
2746 suffix)
2747 ;; See if any suffix rule matches this file name.
2755 nil)
2757 ;; We found an uncompression rule.
2763 ;; `dired-remove-file' is not defined in XEmacs.
2768 ;; We don't recognize the file as compressed, so compress it.
2769 ;; Try gzip.
2774 ;; `dired-remove-file' is not defined in XEmacs.
2784 "Like `insert-directory' for Tramp files."
2791 filename switches wildcard full-directory-p)
2811 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2812 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2815 v
2818 switches
2820 localname
2823 v
2827 "Couldn't `cd %s'"
2831 v
2834 switches
2839 ""
2847 ;; We cannot use `insert-buffer-substring' because the Tramp
2848 ;; buffer changes its contents before insertion due to calling
2849 ;; `expand-file' and alike.
2854 ;; Check for "--dired" output.
2861 ;; Now read the numeric positions of file names.
2867 ;; End is followed by \n or by " -> ".
2869 ;; Remove trailing lines.
2875 ;; Some busyboxes are reluctant to discard colors.
2882 ;; Decode the output, it could be multibyte.
2889 ;; The inserted file could be from somewhere else.
2896 "."
2903 ;; Canonicalization of file names.
2906 "Like `expand-file-name' for Tramp files.
2908 the result will be a local, non-Tramp, file name."
2909 ;; If DIR is not given, use `default-directory' or "/".
2911 ;; Unless NAME is absolute, concat DIR and NAME.
2914 ;; If NAME is not a Tramp file, run the real handler.
2917 ;; Dissect NAME.
2921 ;; Tilde expansion if necessary. This needs a shell which
2922 ;; groks tilde expansion! The function `tramp-find-shell' is
2923 ;; supposed to find such a shell on the remote host. Please
2924 ;; tell me about it when this doesn't work on your system.
2928 ;; We cannot simply apply "~/", because under sudo "~/" is
2929 ;; expanded to the local user home directory but to the
2930 ;; root home directory. On the other hand, using always
2931 ;; the default user name for tilde expansion is not
2932 ;; appropriate either, because ssh and companions might
2933 ;; use a user name from the config file.
2945 ;; There might be a double slash, for example when "~/"
2946 ;; expands to "/". Remove this.
2949 ;; No tilde characters in file name, do normal
2950 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2951 ;; `directory-sep-char' here for XEmacs on Windows, which would
2952 ;; otherwise use backslash. `default-directory' is bound,
2953 ;; because on Windows there would be problems with UNC shares or
2954 ;; Cygwin mounts.
2958 method user host
2962 hop)))))
2964 ;;; Remote commands:
2967 "Flush file caches."
2975 ;; We use BUFFER also as connection buffer during setup. Because of
2976 ;; this, its original contents must be saved, and restored once
2977 ;; connection has been setup.
2979 "Like `start-file-process' for Tramp files."
2982 ;; it might be that the arguments exceed the command line
2983 ;; length. Therefore, we modify the command.
2988 ;; When PROGRAM is nil, we just provide a tty.
2994 args
2998 ;; Use a human-friendly prompt, for example for `shell'.
2999 ;; We discard hops, if existing, that's why we cannot use
3000 ;; `file-remote-p'.
3007 tramp-initial-end-of-output))
3008 ;; We use as environment the difference to toplevel
3009 ;; `process-environment'.
3010 env
3015 env)
3034 ;; We do not want to raise an error when
3035 ;; `start-file-process' has been started several times in
3036 ;; `eshell' and friends.
3040 ;; BUFFER can be nil. We use a temporary buffer.
3043 ;; NAME must be unique as process name.
3047 ;; Set the new process properties.
3053 ;; We catch this event. Otherwise, `start-process' could
3054 ;; be called on the local host.
3057 ;; Activate narrowing in order to save BUFFER
3058 ;; contents. Clear also the modification time;
3059 ;; otherwise we might be interrupted by
3060 ;; `verify-visited-file-modtime'.
3066 ;; We call `tramp-maybe-open-connection', in order
3067 ;; to cleanup the prompt afterwards.
3073 ;; Now do it.
3075 ;; Send the command.
3077 ;; Check, whether a pty is associated.
3081 v 'file-error
3084 ;; Set query flag and process marker for this
3085 ;; process. We ignore errors, because the process
3086 ;; could have finished already.
3090 ;; Return process.
3091 p))))
3093 ;; Save exit.
3104 "Like `process-file' for Tramp files."
3105 ;; The implementation is not complete yet.
3111 ;; Compute command.
3114 ;; We use as environment the difference to toplevel `process-environment'.
3122 "env %s %s"
3124 ;; Determine input.
3129 ;; INFILE is on the same remote host.
3131 ;; INFILE must be copied to remote host.
3137 ;; Determine output.
3139 ;; Just a buffer.
3142 ;; A buffer name.
3145 ;; (REAL-DESTINATION ERROR-DESTINATION)
3147 ;; output.
3155 ;; stderr.
3160 ;; stderr is on the same remote host.
3163 ;; stderr must be copied to remote host. The temporary
3164 ;; file must be deleted after execution.
3167 method user host stderr))))
3168 ;; stderr to be discarded.
3171 ;; 't
3176 ;; Send the command. It might not return in time, so we protect
3177 ;; it. Call it in a subshell, in order to preserve working
3178 ;; directory.
3185 command)
3186 t t)
3188 ;; We should add the output anyway.
3195 ;; When the user did interrupt, we should do it also. We use
3196 ;; return code -1 as marker.
3200 ;; Handle errors.
3205 ;; Provide error file.
3208 ;; Cleanup. We remove all file cache values for the connection,
3209 ;; because the remote process could have changed them.
3212 ;; `process-file-side-effects' has been introduced with GNU
3213 ;; Emacs 23.2. If set to nil, no remote file will be changed
3214 ;; by `program'. If it doesn't exist, we assume its default
3215 ;; value t.
3220 ;; Return exit status.
3223 ret))))
3226 "Like `file-local-copy' for Tramp files."
3230 v 'file-error
3240 ;; `copy-file' handles direct copy and out-of-band methods.
3245 ;; Use inline encoding for file transfer.
3249 v 3
3251 filename rem-enc)
3258 tmpfile loc-dec)
3260 ;; If local decoding is a function, we call it.
3261 ;; We must disable multibyte, because
3262 ;; `uudecode-decode-region' doesn't handle it
3263 ;; correctly. Unset `file-name-handler-alist'.
3264 ;; Otherwise, epa-file gets confused.
3272 ;; If tramp-decoding-function is not defined for this
3273 ;; method, we invoke tramp-decoding-command instead.
3275 ;; Unset `file-name-handler-alist'. Otherwise,
3276 ;; epa-file gets confused.
3284 loc-dec tmpfile2 tmpfile)
3287 ;; Set proper permissions.
3289 ;; Set local user ownership.
3292 ;; Oops, I don't know what to do.
3296 ;; Error handling.
3302 tmpfile)))
3304 ;; This is needed for XEmacs only. Code stolen from files.el.
3307 "Like `insert-file-contents-literally' for Tramp files."
3315 nil))
3323 ;; Save exit.
3328 ;; CCC grok LOCKNAME
3331 "Like `write-region' for Tramp files."
3334 ;; Following part commented out because we don't know what to do about
3335 ;; file locking, and it does not appear to be a problem to ignore it.
3336 ;; Ange-ftp ignores it, too.
3337 ;; (when (and lockname (stringp lockname))
3338 ;; (setq lockname (expand-file-name lockname)))
3339 ;; (unless (or (eq lockname nil)
3340 ;; (string= lockname filename))
3341 ;; (error
3342 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3344 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3355 ;; `file-writable-p' calls `file-expand-file-name'. We
3356 ;; cannot use `tramp-run-real-handler' therefore.
3362 ;; Short track: if we are on the local host, we can run directly.
3364 'write-region
3368 ;; We use this to save the value of
3369 ;; `last-coding-system-used' after writing the tmp
3370 ;; file. At the end of the function, we set
3371 ;; `last-coding-system-used' to this saved value. This
3372 ;; way, any intermediary coding systems used while
3373 ;; talking to the remote shell or suchlike won't hose
3374 ;; this variable. This approach was snarfed from
3375 ;; ange-ftp.el.
3376 coding-system-used
3377 ;; Write region into a tmp file. This isn't really
3378 ;; needed if we use an encoding function, but currently
3379 ;; we use it always because this makes the logic
3380 ;; simpler. We must also set `temporary-file-directory',
3381 ;; because it could point to a remote directory.
3387 ;; If `append' is non-nil, we copy the file locally, and let
3388 ;; the native `write-region' implementation do the job.
3391 ;; We say `no-message' here because we don't want the
3392 ;; visited file modtime data to be clobbered from the temp
3393 ;; file. We call `set-visited-file-modtime' ourselves later
3394 ;; on. We must ensure that `file-coding-system-alist'
3395 ;; matches `tmpfile'.
3401 'write-region
3408 ;; Now, `last-coding-system-used' has the right value. Remember it.
3413 ;; The permissions of the temporary file should be set. If
3414 ;; FILENAME does not exist (eq modes nil) it has been
3415 ;; renamed to the backup file. This case `save-buffer'
3416 ;; handles permissions.
3417 ;; Ensure that it is still readable.
3420 tmpfile
3423 ;; This is a bit lengthy due to the different methods
3424 ;; possible for file transfer. First, we check whether the
3425 ;; method uses an scp program. If so, we call it.
3426 ;; Otherwise, both encoding and decoding command must be
3427 ;; specified. However, if the method _also_ specifies an
3428 ;; encoding function, then that is used for encoding the
3429 ;; contents of the tmp file.
3434 ;; `copy-file' handles direct copy and out-of-band methods.
3444 ;; We keep the local file for performance
3445 ;; reasons, useful for "rsync".
3452 ;; Don't rename, in order to keep context in SELinux.
3457 ;; Use inline file transfer.
3459 ;; Encode tmpfile.
3463 ;; Use encoding function or command.
3466 "Encoding local file `%s' using `%s'"
3467 tmpfile loc-enc)
3469 ;; The following `let' is a workaround for
3470 ;; the base64.el that comes with pgnus-0.84.
3471 ;; If both of the following conditions are
3472 ;; satisfied, it tries to write to a local
3473 ;; file in default-directory, but at this
3474 ;; point, default-directory is remote.
3475 ;; (`call-process-region' can't write to
3476 ;; remote files, it seems.) The file in
3477 ;; question is a tmp file anyway.
3485 loc-enc tmpfile t))
3487 v 'file-error
3490 filename loc-enc))))
3492 ;; Send buffer into remote decoding command which
3493 ;; writes to remote file. Because this happens on
3494 ;; the remote host, we cannot use the function.
3497 "Decoding remote file `%s' using `%s'"
3498 filename rem-dec)
3502 v
3506 tramp-end-of-heredoc
3508 tramp-end-of-heredoc))
3510 v nil
3511 "Couldn't write region to `%s', decode using `%s' failed"
3512 filename rem-dec)
3513 ;; When `file-precious-flag' is set, the region is
3514 ;; written to a temporary file. Check that the
3515 ;; checksum is equal to that from the local tmpfile.
3519 ;; cksum runs locally, if possible.
3521 ;; cksum runs remotely.
3523 v
3526 ;; ... they are different.
3533 v 'file-error
3536 filename rem-dec)))))
3538 ;; Save exit.
3541 ;; That's not expected.
3544 v 'file-error
3547 method))))
3549 ;; Make `last-coding-system-used' have the right value.
3556 ;; We must protect `last-coding-system-used', now we have set it
3557 ;; to its correct value.
3559 ;; Set file modification time.
3563 ;; We must pass modtime explicitly, because FILENAME can
3564 ;; be different from (buffer-file-name), f.e. if
3565 ;; `file-precious-flag' is set.
3571 ;; Set the ownership.
3581 ;; VC backends check for the existence of various different special
3582 ;; files. This is very time consuming, because every single check
3583 ;; requires a remote command (the file cache must be invalidated).
3584 ;; Therefore, we apply a kind of optimization. We install the file
3585 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3586 ;; remembers all file names for which `file-exists-p' or
3587 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3588 ;; is performed. Afterwards, a script is applied for all collected
3589 ;; file names, using just one remote command. The result of this
3590 ;; script is used to fill the file cache with actual values. Now we
3591 ;; can reset the file name handlers, and we make a second run of
3592 ;; `vc-registered', which returns the expected result without sending
3593 ;; any other remote command.
3595 "Like `vc-registered' for Tramp files."
3601 ;; There could be new files, created by the vc backend. We
3602 ;; cannot reuse the old cache entries, therefore. In
3603 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3604 ;; could also be a timestamp as `current-time' returns. This
3605 ;; means invalidate all cache entries with an older timestamp.
3611 ;; Here we collect only file names, which need an operation.
3615 ;; Send just one command, in order to fill the cache.
3618 v
3627 ;; We cannot use `tramp-send-command-and-read',
3628 ;; because this does not cooperate well with
3629 ;; heredoc documents.
3631 v
3634 tramp-end-of-heredoc
3636 tramp-vc-registered-file-names
3638 tramp-end-of-heredoc))
3640 ;; Read the expression.
3647 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3648 ;; calls shall be answered from the file cache. We unset
3649 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3650 ;; in order to keep the cache.
3652 remote-file-name-inhibit-cache process-file-side-effects)
3653 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3672 ;; Run.
3676 ;;;###tramp-autoload
3678 "Invoke remote-shell Tramp file name handler.
3679 Fall back to normal file name handler if no Tramp handler exists."
3697 "Invoke special file name handler, which collects files to be handled."
3705 ;; That's what we want: file names, for which checks are
3706 ;; applied. We assume that VC uses only `file-exists-p' and
3707 ;; `file-readable-p' checks; otherwise we must extend the
3708 ;; list. We do not perform any action, but return nil, in
3709 ;; order to keep `vc-registered' running.
3712 nil)
3713 ;; `process-file' and `start-file-process' shall be ignored.
3716 ;; Tramp file name handlers like `expand-file-name'. They
3717 ;; must still work.
3719 ;; Default file name handlers, we don't care.
3723 "Like `file-notify-add-watch' for Tramp files."
3727 command events filter p sequence)
3729 ;; gvfs-monitor-dir.
3732 events
3736 attribute-changed))
3741 ;; inotifywait.
3744 events
3754 ;; None.
3756 v 'file-notify-error
3757 "No file notification program found on %s"
3759 ;; Start process.
3761 'start-file-process
3765 sequence))
3766 ;; Return the process object as watch-descriptor.
3769 v 'file-notify-error
3770 "`%s' failed to start on remote host"
3774 ;; Needed for `tramp-sh-gvfs-monitor-dir-process-filter'.
3779 ;; There might be an error if the monitor is not supported.
3780 ;; Give the filter a chance to read the output.
3785 p))))
3789 file-notify events."
3798 ;; Attribute change is returned in unused wording.
3810 string)
3815 proc
3819 ;; File names are returned as absolute paths. We must
3820 ;; add the remote prefix.
3824 ;; Remove watch when file or directory to be watched is deleted.
3829 ;; Usually, we would add an Emacs event now. Unfortunately,
3830 ;; `unread-command-events' does not accept several events at
3831 ;; once. Therefore, we apply the callback directly.
3835 ;; Save rest of the string.
3844 ;; Check, whether there is a problem.
3850 line)
3855 proc
3862 ;; Remove watch when file or directory to be watched is deleted.
3865 ;; Usually, we would add an Emacs event now. Unfortunately,
3866 ;; `unread-command-events' does not accept several events at
3867 ;; once. Therefore, we apply the callback directly.
3870 ;;; Internal Functions:
3873 "Define in remote shell function NAME implemented as SCRIPT.
3874 Only send the definition if it has not already been done."
3875 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3876 ;; might be nil.
3882 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3883 ;; could result in unwanted command expansion. Avoid this.
3886 ;; The script could contain a call of Perl. This is masked with `%s'.
3891 vec
3899 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3900 Returns the exit code of the `test' program."
3903 v
3905 "%s %s %s"
3907 switch
3911 "Run `test'-like program on the remote system, given FILE1, FILE2.
3912 FORMAT-STRING contains the program name, switches, and place holders.
3913 Returns the exit code of the `test' program. Barfs if the methods,
3914 hosts, or files, disagree."
3918 v 'file-error
3923 v1
3930 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3931 First arg VEC specifies the connection, PROGNAME is the program
3932 to search for, and DIRLIST gives the list of directories to
3933 search. If IGNORE-TILDE is non-nil, directory names starting
3934 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3935 only in DIRLIST.
3937 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3939 This function expects to be in the right *tramp* buffer."
3942 ;; Check whether the executable is in $PATH. "which(1)" does not
3943 ;; report always a correct error code; therefore we check the
3944 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3945 ;; 5.11") have problems with this command, we disable the call
3946 ;; therefore.
3957 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3958 ;; `remove' is in CL, and we want to avoid CL dependencies.
3967 vec
3969 "do if test -x $d/%s && test -f $d/%s; "
3970 "then echo tramp_executable $d/%s; "
3973 progname progname progname
3974 tramp-end-of-heredoc
3976 tramp-end-of-heredoc))
3982 result)))
3985 "Sets the remote environment PATH to existing directories.
3986 I.e., for each directory in `tramp-remote-path', it is tested
3987 whether it exists and if so, it is added to the environment
3988 variable PATH."
3994 ;; ------------------------------------------------------------
3995 ;; -- Communication with external shell --
3996 ;; ------------------------------------------------------------
3999 "Find a command on the remote host for checking if a file exists.
4000 Here, we are looking for a command which has zero exit status if the
4001 file exists and nonzero exit status otherwise."
4005 result)
4006 ;; The algorithm is as follows: we try a list of several commands.
4007 ;; For each command, we first run `$cmd /' -- this should return
4008 ;; true, as the root directory always exists. And then we run
4009 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
4010 ;; does not exist. This should return false. We use the first
4011 ;; command we find that seems to work.
4012 ;; The list of commands to try is as follows:
4013 ;; `ls -d' This works on most systems, but NetBSD 1.4
4014 ;; has a bug: `ls' always returns zero exit
4015 ;; status, even for files which don't exist.
4016 ;; `test -e' Some Bourne shells have a `test' builtin
4017 ;; which does not know the `-e' option.
4018 ;; `/bin/test -e' For those, the `test' binary on disk normally
4019 ;; provides the option. Alas, the binary
4020 ;; is sometimes `/bin/test' and sometimes it's
4021 ;; `/usr/bin/test'.
4022 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
4050 result))
4053 "Opens shell SHELL."
4056 ;; Find arguments for this shell.
4058 item extra-args)
4063 ;; It is useful to set the prompt in the following command
4064 ;; because some people have a setting for $PS1 which /bin/sh
4065 ;; doesn't know about and thus /bin/sh will display a strange
4066 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4067 ;; ksh will display the current working directory but /bin/sh
4068 ;; will display a dollar sign. The following command line sets
4069 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4070 ;; well as csh-like shells. We also unset the variable $ENV
4071 ;; because that is read by some sh implementations (eg, bash
4072 ;; when called as sh) on startup; this way, we avoid the startup
4073 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4074 ;; the prompt in /bin/bash, it must be discarded as well.
4075 ;; $HISTFILE is set according to `tramp-histfile-override'.
4078 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
4083 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4087 t))
4092 "Opens a shell on the remote host which groks tilde expansion."
4095 shell)
4098 ;; CCC: "root" does not exist always, see QNAP 459.
4099 ;; Which check could we apply instead?
4102 ;; The default shell (ksh93) of OpenSolaris and
4103 ;; Solaris is buggy. We've got reports for
4104 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4113 ;; Maybe it works at least for some other commands.
4115 default-shell
4117 vec 2
4119 "Couldn't find a remote shell which groks tilde "
4121 default-shell)))
4123 default-shell)))
4125 ;; Open a new shell if needed.
4131 ;; Utility functions.
4134 "Wait for shell prompt and barf if none appears.
4135 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4136 seconds. If not, it produces an error message with the given ERROR-ARGS."
4140 proc timeout
4149 "Set up an interactive shell.
4150 Mainly sets the prompt and the echo correctly. PROC is the shell
4151 process to set up. VEC specifies the connection."
4155 ;; Disable tab and echo expansion.
4159 ;; Check whether the echo has really been disabled. Some
4160 ;; implementations, like busybox of embedded GNU/Linux, don't
4161 ;; support disabling.
4168 ;; Make sure backspaces and their echo are enabled and no line
4169 ;; width magic interferes with them.
4177 ;; Try to set up the coding system correctly.
4178 ;; CCC this can't be the right way to do it. Hm.
4182 ;; Use MULE to select the right EOL convention for communicating
4183 ;; with the process.
4189 cs-decode cs-encode)
4206 ;; Look for ^M and do something useful if found.
4208 ;; We have found a ^M but cannot frob the process coding system
4209 ;; because we're running on a non-MULE Emacs. Let's try
4210 ;; stty, instead.
4215 ;; Check whether the output of "uname -sr" has been changed. If
4216 ;; yes, this is a strong indication that we must expire all
4217 ;; connection properties. We start again with
4218 ;; `tramp-maybe-open-connection', it will be caught there.
4223 vec "uname"
4227 vec 3
4228 "Connection reset, because remote host changed from `%s' to `%s'"
4229 old-uname new-uname)
4230 ;; We want to keep the password.
4234 ;; Check whether the remote host suffers from buggy
4235 ;; `send-process-string'. This is known for FreeBSD (see comment in
4236 ;; `send_process', file process.c). I've tested sending 624 bytes
4237 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4238 ;; this host type is detected locally. It cannot handle remote
4239 ;; hosts, though.
4243 tramp-chunksize)
4251 ;; Set remote PATH variable.
4254 ;; Search for a good shell before searching for a command which
4255 ;; checks if a file exists. This is done because Tramp wants to use
4256 ;; "test foo; echo $?" to check if various conditions hold, and
4257 ;; there are buggy /bin/sh implementations which don't execute the
4258 ;; "echo $?" part if the "test" part has an error. In particular,
4259 ;; the OpenSolaris /bin/sh is a problem. There are also other
4260 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4261 ;; in function declarations, or changing HISTFILE in place.
4262 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4263 ;; detected.
4266 ;; Disable unexpected output.
4269 ;; IRIX64 bash expands "!" even when in single quotes. This
4270 ;; destroys our shell functions, we must disable it. See
4271 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4275 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4280 ;; Set `remote-tty' process property.
4285 ;; Dump stty settings in the traces.
4289 ;; Set the environment.
4294 unset vars item)
4304 vec
4306 tramp-end-of-heredoc
4308 tramp-end-of-heredoc)
4309 t))
4314 ;; Old text from documentation of tramp-methods:
4315 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4316 ;; of the base64 methods instead since base64 encoding is much more
4317 ;; reliable and the commands are more standardized between the different
4318 ;; Unix versions. But if you can't use base64 for some reason, please
4319 ;; note that the default uudecode command does not work well for some
4320 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4321 ;; the following command for uudecode:
4322 ;;
4323 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4324 ;;
4325 ;; For Irix, no solution is known yet.
4333 "List of local coding commands for inline transfer.
4334 Each item is a list that looks like this:
4336 \(FORMAT ENCODING DECODING)
4338 FORMAT is symbol describing the encoding/decoding format. It can be
4339 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4341 ENCODING and DECODING can be strings, giving commands, or symbols,
4342 giving functions. If they are strings, then they can contain
4344 file name will be put into the command line at that spot. If the
4345 specifier is not present, the input should be read from standard
4346 input.
4348 If they are functions, they will be called with two arguments, start
4349 and end of region, and are expected to replace the region contents
4354 ;; "-i" is more robust with older base64 from GNU coreutils.
4355 ;; However, I don't know whether all base64 versions do supports
4356 ;; this option.
4364 ;; This is painful slow, so we put it on the end.
4371 "List of remote coding commands for inline transfer.
4372 Each item is a list that looks like this:
4374 \(FORMAT ENCODING DECODING [TEST])
4376 FORMAT is a symbol describing the encoding/decoding format. It can be
4377 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4379 ENCODING and DECODING can be strings, giving commands, or symbols,
4380 giving variables. If they are strings, then they can contain
4382 file name will be put into the command line at that spot. If the
4383 specifier is not present, the input should be read from standard
4384 input.
4386 If they are variables, this variable is a string containing a
4387 Perl or Shell implementation for this functionality. This
4388 program will be transferred to the remote host, and it is
4390 specifier in the variable value denotes a temporary file.
4392 The optional TEST command can be used for further tests, whether
4396 "Find an inline transfer encoding that works.
4397 Goes through the list `tramp-local-coding-commands' and
4398 `tramp-remote-coding-commands'."
4403 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4411 ;; If the local encoder or decoder is a string, the
4412 ;; corresponding command has to work locally.
4419 loc-enc nil nil))
4427 loc-dec nil nil))
4429 ;; Search for remote coding commands with the same format
4437 ;; Check the remote test command if exists.
4443 ;; Check if remote perl exists when necessary.
4448 ;; Check if remote encoding and decoding commands can be
4449 ;; called remotely with null input and output. This makes
4450 ;; sure there are no syntax errors and the command is really
4451 ;; found. Note that we do not redirect stdout to /dev/null,
4452 ;; for two reasons: when checking the decoding command, we
4453 ;; actually check the output it gives. And also, when
4454 ;; redirecting "mimencode" output to /dev/null, then as root
4455 ;; it might change the permissions of /dev/null!
4463 vec 5
4472 tmpfile)
4479 tramp-temp-name-prefix
4481 value
4483 value
4485 ?t
4491 vec 5
4494 vec
4496 t)
4504 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4510 ;; Set connection properties. Since the commands are risky
4511 ;; (due to output direction), we cache them in the process cache.
4522 "Call the local encoding or decoding command.
4524 Otherwise, INPUT is passed via standard input.
4525 INPUT can also be nil which means `/dev/null'.
4526 OUTPUT can be a string (which specifies a file name), or t (which
4527 means standard output and thus the current buffer), or nil (which
4528 means discard it)."
4530 nil tramp-encoding-shell
4533 nil
4534 tramp-encoding-command-switch
4544 "List of compress and decompress commands for inline transfer.
4545 Each item is a list that looks like this:
4547 \(COMPRESS DECOMPRESS)
4552 "Find an inline transfer compress command that works.
4553 Goes through the list `tramp-inline-compress-commands'."
4558 item compress decompress found)
4565 vec 5
4566 "Checking local compress commands `%s', `%s' for sanity"
4567 compress decompress)
4572 ;; Windows shells need the program file name after
4573 ;; the pipe symbol be quoted if they use forward
4574 ;; slashes as directory separators.
4581 vec 5
4582 "Checking remote compress commands `%s', `%s' for sanity"
4583 compress decompress)
4589 ;; Did we find something?
4592 ;; Set connection properties. Since the commands are
4593 ;; risky (due to output direction), we cache them in the
4594 ;; process cache.
4608 "Expands VEC according to `tramp-default-proxies-alist'.
4609 Gateway hops are already opened."
4613 choices proxy)
4615 ;; Ad-hoc proxy definitions.
4620 tramp-prefix-format proxy tramp-postfix-host-format)))
4625 proxy)
4626 ;; Add the hop.
4628 'tramp-default-proxies-alist
4631 proxy))
4633 ;; Save the new value.
4638 ;; Look for proxy hosts to be passed.
4644 ;; Host.
4647 ;; User.
4651 ;; No more hops needed.
4653 ;; Replace placeholders.
4656 proxy
4661 ;; Add the hop.
4663 ;; Start next search.
4666 ;; Handle gateways.
4674 ;; Is the method prepared for gateways?
4677 vec 'file-error
4679 ;; Open the gateway connection.
4684 target-alist)
4685 ;; For the password prompt, we need the correct values.
4686 ;; Therefore, we must remember the gateway vector. But we
4687 ;; cannot do it as connection property, because it shouldn't
4688 ;; be persistent. And we have no started process yet either.
4692 ;; Foreign and out-of-band methods are not supported for multi-hops.
4699 vec 'file-error
4700 "Method `%s' is not supported for multi-hops."
4703 ;; In case the host name is not used for the remote shell
4704 ;; command, the user could be misguided by applying a random
4705 ;; host name.
4711 ;; There are multi-hops.
4713 ;; The host name is used for the remote shell command.
4715 ;; The host is local. We cannot use `tramp-local-host-p'
4716 ;; here, because it opens a connection as well.
4719 v 'file-error
4720 "Host `%s' looks like a remote host, `%s' can only use the local host"
4721 host method)))
4723 ;; Result.
4724 target-alist))
4727 "Return the Control* arguments of the local ssh."
4729 ;; No options to be computed.
4734 ;; There is already a value to be used.
4737 ;; Determine the options.
4749 ;; We use a non-existing IP address, in order to avoid
4750 ;; useless connections, and DNS timeouts.
4757 " -o ControlPath='tramp.%%r@%%h:%%p'"
4766 tramp-ssh-controlmaster-options)))
4769 "Maybe open a connection VEC.
4770 Does not do anything if a connection is already open, but re-opens the
4771 connection if a previous connection has died for some reason."
4779 ;; If Tramp opens the same connection within a short time frame,
4780 ;; there is a problem. We shall signal this.
4789 ;; If too much time has passed since last command was sent, look
4790 ;; whether process is still alive. If it isn't, kill it. When
4791 ;; using ssh, it can sometimes happen that the remote end has hung
4792 ;; up but the local ssh client doesn't recognize this until it
4793 ;; tries to send some data to the remote end. So that's why we
4794 ;; try to send a command from time to time, then look again
4795 ;; whether the process is really alive.
4806 ;; The error will be caught locally.
4812 ;; New connection must be opened.
4816 ;; If `non-essential' is non-nil, don't reopen a new connection.
4821 vec 3
4832 ;; Start new process.
4847 ;; We will apply `tramp-ssh-controlmaster-options'
4848 ;; only for the first hop.
4853 ;; This must be done in order to avoid our file
4854 ;; name handler.
4858 'start-process
4863 tramp-encoding-command-interactive)
4866 ;; Set sentinel and query flag.
4877 ;; Check whether process is alive.
4879 p 10
4882 ;; Now do all the connections as specified.
4908 ;; We don't create the temporary file. In
4909 ;; fact, it is just a prefix for the
4910 ;; ControlPath option of ssh; the real
4911 ;; temporary file has another name, and it is
4912 ;; created and protected by ssh. It is also
4913 ;; removed by ssh when the connection is
4914 ;; closed. The temporary file name is cached
4915 ;; in the main connection process, therefore
4916 ;; we cannot use `tramp-get-connection-process'.
4922 tramp-temp-name-prefix
4924 spec r-shell)
4926 ;; Add arguments for asynchronous processes.
4930 ;; Add gateway arguments if necessary.
4936 ;; Check for port number. Until now, there's no
4937 ;; need for handling like method, user, host.
4942 ;; Check, whether there is a restricted shell.
4947 ;; Set variables for computing the prompt for
4948 ;; reading password. They can also be derived
4949 ;; from a gateway.
4954 ;; Add login environment.
4957 login-env
4962 login-env))
4966 "%s=%s %s"
4969 command)))
4972 ;; Replace `login-args' place holders.
4980 ?h l-host ?u l-user ?p l-port ?c options)
4981 command
4983 ;; We do not want to see the trailing local
4984 ;; prompt in `start-file-process'.
4986 command " "
4992 ;; Local shell could be a Windows COMSPEC. It
4993 ;; doesn't know the ";" syntax, but we must exit
4994 ;; always for `start-file-process'. It could
4995 ;; also be a restricted shell, which does not
4996 ;; allow "exec".
4999 ;; Send the command.
5003 p vec pos tramp-actions-before-shell
5007 ;; Next hop.
5011 ;; Make initial shell settings.
5014 ;; When the user did interrupt, we must cleanup.
5017 ;; Propagate the quit signal.
5021 "Send the COMMAND to connection VEC.
5022 Erases temporary buffer before sending the command. If optional
5023 arg NEVEROPEN is non-nil, never try to open the connection. This
5024 is meant to be used from `tramp-maybe-open-connection' only. The
5025 function waits for output unless NOOUTPUT is set."
5029 ;; We mark the command string that it can be erased in the output buffer.
5031 ;; If we put `tramp-echo-mark' after a trailing newline (which
5032 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
5033 ;; that newline and adds `tramp-rsh-end-of-line' right after
5034 ;; `tramp-echo-mark', so the remote shell sees two consecutive
5035 ;; trailing line endings and sends two prompts after executing
5036 ;; the command, which confuses `tramp-wait-for-output'.
5040 ;; No need to restore a trailing newline here since `tramp-send-string'
5041 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
5043 ;; Send the command.
5049 "Wait for output from remote command."
5055 ;; be leading escape sequences, which must be ignored.
5057 ;; Sometimes, the commands do not return a newline but a
5058 ;; null byte before the shell prompt, for example "git
5059 ;; ls-files -c -z ...".
5064 ;; A simple-minded busybox has sent " ^H" sequences.
5065 ;; Delete them.
5070 ;; Delete the prompt.
5076 proc 'file-error
5077 "[[Remote prompt `%s' not found in %d secs]]"
5078 tramp-end-of-output timeout)
5080 proc 'file-error
5082 ;; Return value is whether end-of-output sentinel was found.
5083 found)))
5087 "Run COMMAND and check its exit status.
5088 Sends `echo $?' along with the COMMAND for checking the exit status.
5089 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5090 status is 0, and nil otherwise.
5092 If the optional argument SUBSHELL is non-nil, the command is
5093 executed in a subshell, ie surrounded by parentheses. If
5094 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5096 vec
5098 command
5100 "echo tramp_exit_status $?"
5114 "Run COMMAND, check exit status, throw error if exit status not okay.
5115 Similar to `tramp-send-command-and-check' but accepts two more arguments
5116 FMT and ARGS which are passed to `error'."
5121 "Run COMMAND and return the output, which must be a Lisp expression.
5122 If MARKER is a regexp, read the output after that string.
5123 In case there is no valid Lisp expression and NOERROR is nil, it
5124 raises an error."
5131 ;; Read the marker.
5137 vec 'file-error
5138 "`%s' does not return the marker `%s': `%s'"
5140 ;; Read the expression.
5143 ;; Error handling.
5148 vec 'file-error
5149 "`%s' does not return a valid Lisp expression: `%s'"
5153 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5154 Convert file mode bits to string and set virtual device number.
5155 Return ATTR."
5157 ;; Remove color escape sequences from symlink.
5161 ;; Convert uid and gid. Use -1 as indication of unusable value.
5172 ;; Convert last access time.
5177 ;; Convert last modification time.
5182 ;; Convert last status change time.
5187 ;; Convert file size.
5193 ;; Convert file mode bits to string.
5198 ;; Convert directory indication bit.
5201 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5207 ;; Set file's gid change bit.
5215 ;; Convert inode.
5221 ;; Inodes can be incredible huge. We must hide this.
5223 ;; Set virtual device number.
5226 attr))
5229 "Converts STRING to shell glob pattern which ignores case."
5235 string
5239 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5250 localname)
5256 "Return t if this is an out-of-band method, nil otherwise."
5258 ;; It shall be an out-of-band method.
5260 ;; There must be a size, otherwise the file doesn't exist.
5262 ;; Either the file size is large enough, or (in rare cases) there
5263 ;; does not exist a remote encoding.
5268 ;; Variables local to connection.
5272 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5273 ;; cache the result for the session only. Otherwise, the result
5274 ;; is cached persistently.
5277 vec)
5278 "remote-path"
5287 ;; Default if "getconf" is not available.
5290 vec 3
5295 ;; The login shell could return more than just the $PATH
5296 ;; string. So we use `tramp-end-of-heredoc' as marker.
5299 vec
5304 'identity
5308 'identity
5314 ;; Replace place holder `tramp-default-remote-path'.
5322 ;; Replace place holder `tramp-own-remote-path'.
5330 ;; Remove double entries.
5337 ;; Remove non-existing directories.
5339 nil
5349 x))
5350 x))
5351 remote-path)))))
5357 locale)
5364 candidates nil)
5366 ;; Return value.
5376 result)
5378 ;; Check parameters. On busybox, "ls" output coloring is
5379 ;; enabled by default sometimes. So we try to disable it
5380 ;; when possible. $LS_COLORING is not supported there.
5381 ;; Some "ls" versions are sensible wrt the order of
5382 ;; arguments, they fail when "-al" is after the
5383 ;; "--color=never" argument (for example on FreeBSD).
5398 ;; Some "ls" versions are sensible wrt the order of arguments,
5399 ;; they fail when "-al" is after the "--dired" argument (for
5400 ;; example on FreeBSD).
5408 ;; Some "ls" versions are sensible wrt the order of arguments,
5409 ;; they fail when "-al" is after the "--dired" argument (for
5410 ;; example on FreeBSD).
5419 "test"
5423 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5424 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5425 ;; for otherwise the shell crashes.
5437 vec
5460 ;; We must check also for some Perl modules.
5468 result)))
5475 tmp)
5476 ;; Check whether stat(1) returns usable syntax. "%s" does not
5477 ;; work on older AIX systems.
5486 result)))
5496 result))))
5512 ;; Busyboxes do support the "-t" option only when they have been
5513 ;; built with the DESKTOP config option. Let's check it.
5516 vec "touch-t"
5518 vec
5520 "%s -t %s %s"
5521 result
5525 result)))
5544 result)
5546 ;; Check POSIX parameter.
5553 vec
5562 vec
5566 "print $>"
5578 vec
5582 "import os; print (os.getuid())"
5596 ;; Ensure there is a valid result.
5604 vec
5613 vec
5622 vec
5626 "import os; print (os.getgid())"
5640 ;; Ensure there is a valid result.
5646 ;; Some predefined connection properties.
5648 "Return the compress command related to PROP.
5649 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5650 the length of the file to be compressed.
5652 If no corresponding command is found, nil is returned."
5661 "Return the coding command related to PROP.
5662 PROP is either `remote-encoding', `remote-decoding',
5663 `local-encoding' or `local-decoding'.
5665 SIZE is the length of the file to be coded. Depending on SIZE,
5666 compression might be applied.
5668 If no corresponding command is found, nil is returned.
5669 Otherwise, either a string is returned which contains a `%s' mark
5670 to be used for the respective input or output file; or a Lisp
5671 function cell is returned to be applied on a buffer."
5672 ;; We must catch the errors, because we want to return nil, when
5673 ;; no inline coding is found.
5683 compress)
5684 ;; The connection property might have been cached. So we must
5685 ;; send the script to the remote side - maybe.
5693 ;; Check for the `compress' command.
5695 ;; Return the value.
5720 coding)
5723 ;; Windows shells need the program file name after
5724 ;; the pipe symbol be quoted if they use forward
5725 ;; slashes as directory separators.
5732 coding compress))
5735 ;; Windows shells need the program file name after
5736 ;; the pipe symbol be quoted if they use forward
5737 ;; slashes as directory separators.
5742 compress coding))
5756 ;;; TODO:
5758 ;; * Don't use globbing for directories with many files, as this is
5759 ;; likely to produce long command lines, and some shells choke on
5760 ;; long command lines.
5761 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5762 ;; then look if it's the right version (with `perl -v').
5763 ;; * When editing a remote CVS controlled file as a different user, VC
5764 ;; gets confused about the file locking status. Try to find out why
5765 ;; the workaround doesn't work.
5766 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5767 ;; until the last but one hop via `start-file-process'. Apply it
5768 ;; also for ftp and smb.
5769 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5770 ;; some shell with root privileges, it would be nice if I could
5771 ;; just call
5772 ;; trampclient filename.c
5773 ;; as an editor, and the _current_ shell would connect to an Emacs
5774 ;; server and would be used in an existing non-privileged Emacs
5775 ;; session for doing the editing in question.
5776 ;; That way, I need not tell Emacs my password again and be afraid
5777 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5778 ;; once display a just typed password in the context of a keyboard
5779 ;; sequence prompt for a question immediately following in a shell
5780 ;; script run within Emacs -- nasty).
5781 ;; And if I have some ssh session running to a different computer,
5782 ;; having the possibility of passing a local file there to a local
5783 ;; Emacs session (in case I can arrange for a connection back) would
5784 ;; be nice.
5785 ;; Likely the corresponding Tramp server should not allow the
5786 ;; equivalent of the emacsclient -eval option in order to make this
5787 ;; reasonably unproblematic. And maybe trampclient should have some
5788 ;; way of passing credentials, like by using an SSL socket or
5789 ;; something. (David Kastrup)
5790 ;; * Reconnect directly to a compliant shell without first going
5791 ;; through the user's default shell. (Pete Forman)
5792 ;; * How can I interrupt the remote process with a signal
5793 ;; (interrupt-process seems not to work)? (Markus Triska)
5794 ;; * Avoid the local shell entirely for starting remote processes. If
5795 ;; so, I think even a signal, when delivered directly to the local
5796 ;; SSH instance, would correctly be propagated to the remote process
5797 ;; automatically; possibly SSH would have to be started with
5798 ;; "-t". (Markus Triska)
5799 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5800 ;; isn't on the remote host. (Mark A. Hershberger)
5801 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5802 ;; * Optimize out-of-band copying when both methods are scp-like (not
5803 ;; rsync).
5804 ;; * Keep a second connection open for out-of-band methods like scp or
5805 ;; rsync.
5807 ;;; tramp-sh.el ends here