| blob | c5ffb26b551c7befe9fd7a4766a18820aee1bd0b |
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
292 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
298 ;;;###tramp-autoload
307 ;;;###tramp-autoload
315 ;;;###tramp-autoload
319 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
323 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
324 tramp-terminal-type
325 tramp-initial-end-of-output))
331 ;;;###tramp-autoload
337 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
338 tramp-terminal-type
339 tramp-initial-end-of-output))
344 ;;;###tramp-autoload
351 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
352 tramp-terminal-type
353 tramp-initial-end-of-output))
364 ;;;###tramp-autoload
371 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
372 tramp-terminal-type
373 tramp-initial-end-of-output))
383 ;;;###tramp-autoload
395 ;;;###tramp-autoload
399 ;;;###tramp-autoload
403 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
404 ;; Do not add "plink" based methods, they ask interactively for the user.
405 ;;;###tramp-autoload
414 ;;;###tramp-autoload
420 ;;;###tramp-autoload
436 ;;;###tramp-autoload
441 ;;;###tramp-autoload
446 ;;;###tramp-autoload
454 ;;;###tramp-autoload
481 ;; "getconf PATH" yields:
482 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
483 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
484 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
485 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
486 ;; IRIX64: /usr/bin
487 ;;;###tramp-autoload
493 "List of directories to search for executables on remote host.
494 For every remote host, this variable will be set buffer local,
495 keeping the list of existing directories on that host.
497 You can use `~' in this list, but when searching for a shell which groks
498 tilde expansion, all directory names starting with `~' will be ignored.
500 `Default Directories' represent the list of directories given by
502 entry on top of this list, because these are the default
503 directories for POSIX compatible commands. On remote hosts which
504 do not offer the getconf command (like cygwin), the value
507 `Private Directories' are the settings of the $PATH environment,
508 as given in your `~/.profile'."
515 ;;;###tramp-autoload
522 "List of environment variables to be set on the remote host.
524 Each element should be a string of the form ENVVARNAME=VALUE. An
525 entry ENVVARNAME= disables the corresponding environment variable,
526 which might have been set in the init files like ~/.profile.
528 Special handling is applied to the PATH environment, which should
529 not be set here. Instead, it should be set via `tramp-remote-path'."
534 ;;;###tramp-autoload
536 "Alist specifying extra arguments to pass to the remote shell.
537 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
538 matching the shell file name and ARGS is a string specifying the
539 arguments.
541 This variable is only used when Tramp needs to start up another shell
542 for tilde expansion. The extra arguments should typically prevent the
543 shell from reading its init file."
545 ;; This might be the wrong way to test whether the widget type
546 ;; `alist' is available. Who knows the right way to test it?
561 "List of pattern/action pairs.
562 Whenever a pattern matches, the corresponding action is performed.
563 Each item looks like (PATTERN ACTION).
565 The PATTERN should be a symbol, a variable. The value of this
566 variable gives the regular expression to search for. Note that the
568 appended to it.
570 The ACTION should also be a symbol, but a function. When the
578 "List of pattern/action pairs.
579 This list is used for copying/renaming with out-of-band methods.
584 "(echo begin 600 %t; tail -n +2) | uudecode
585 cat %t
586 rm -f %t"
587 "Shell function to implement `uudecode' to standard output.
588 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
589 for this or `uudecode -p', but some systems don't, and for them
593 "%s -e '
594 use File::Spec;
597 sub recursive {
598 my ($volume, @dirs) = @_;
599 my $real = realpath(File::Spec->catpath(
601 if ($real) {
602 my ($vol, $dir) = File::Spec->splitpath($real, 1);
603 return ($vol, File::Spec->splitdir($dir));
604 }
605 else {
606 my $last = pop(@dirs);
607 ($volume, @dirs) = recursive($volume, @dirs);
608 push(@dirs, $last);
609 return ($volume, @dirs);
610 }
611 }
613 $result = realpath($ARGV[0]);
614 if (!$result) {
615 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
616 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
619 }
623 }
627 "Perl script to produce output suitable for use with `file-truename'
628 on the remote file system.
629 Escape sequence %s is replaced with name of Perl binary.
633 "%s -e 'sub case {
634 my $str = shift;
635 if ($ARGV[2]) {
636 return lc($str);
637 }
638 else {
639 return $str;
640 }
641 }
643 @files = readdir(d); closedir(d);
644 foreach $f (@files) {
645 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
648 }
649 else {
651 }
652 }
653 }
656 "Perl script to produce output suitable for use with
657 `file-name-all-completions' on the remote file system. Escape
658 sequence %s is replaced with name of Perl binary. This string is
661 ;; Perl script to implement `file-attributes' in a Lisp `read'able
662 ;; output. If you are hacking on this, note that you get *no* output
663 ;; unless this spits out a complete line, including the '\n' at the
664 ;; end.
665 ;; The device number is returned as "-1", because there will be a virtual
666 ;; device number set in `tramp-sh-handle-file-attributes'.
668 "%s -e '
669 @stat = lstat($ARGV[0]);
670 if (!@stat) {
672 exit 0;
673 }
674 if (($stat[2] & 0170000) == 0120000)
675 {
676 $type = readlink($ARGV[0]);
679 }
680 elsif (($stat[2] & 0170000) == 040000)
681 {
683 }
684 else
685 {
687 };
690 printf(
692 $type,
693 $stat[3],
694 $uid,
695 $gid,
696 $stat[8] >> 16 & 0xffff,
697 $stat[8] & 0xffff,
698 $stat[9] >> 16 & 0xffff,
699 $stat[9] & 0xffff,
700 $stat[10] >> 16 & 0xffff,
701 $stat[10] & 0xffff,
702 $stat[7],
703 $stat[2],
704 $stat[1] >> 16 & 0xffff,
705 $stat[1] & 0xffff
707 "Perl script to produce output suitable for use with `file-attributes'
708 on the remote file system.
709 Escape sequence %s is replaced with name of Perl binary.
713 "%s -e '
716 @list = readdir(DIR);
717 closedir(DIR);
718 $n = scalar(@list);
720 for($i = 0; $i < $n; $i++)
721 {
722 $filename = $list[$i];
723 @stat = lstat($filename);
724 if (($stat[2] & 0170000) == 0120000)
725 {
726 $type = readlink($filename);
729 }
730 elsif (($stat[2] & 0170000) == 040000)
731 {
733 }
734 else
735 {
737 };
741 printf(
742 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
743 $filename,
744 $type,
745 $stat[3],
746 $uid,
747 $gid,
748 $stat[8] >> 16 & 0xffff,
749 $stat[8] & 0xffff,
750 $stat[9] >> 16 & 0xffff,
751 $stat[9] & 0xffff,
752 $stat[10] >> 16 & 0xffff,
753 $stat[10] & 0xffff,
754 $stat[7],
755 $stat[2],
756 $stat[1] >> 16 & 0xffff,
757 $stat[1] & 0xffff,
758 $stat[0] >> 16 & 0xffff,
759 $stat[0] & 0xffff);
760 }
762 "Perl script implementing `directory-files-attributes' as Lisp `read'able
763 output.
764 Escape sequence %s is replaced with name of Perl binary.
767 ;; These two use base64 encoding.
769 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
770 "Perl program to use for encoding a file.
771 Escape sequence %s is replaced with name of Perl binary.
772 This string is passed to `format', so percent characters need to be doubled.
773 This implementation requires the MIME::Base64 Perl module to be installed
777 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
778 "Perl program to use for decoding a file.
779 Escape sequence %s is replaced with name of Perl binary.
780 This string is passed to `format', so percent characters need to be doubled.
781 This implementation requires the MIME::Base64 Perl module to be installed
785 "%s -e '
786 # This script contributed by Juanma Barranquero <lektu@terra.es>.
787 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
788 use strict;
790 my %%trans = do {
791 my $i = 0;
792 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
793 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
794 };
795 my $data;
797 # We read in chunks of 54 bytes, to generate output lines
798 # of 72 chars (plus end of line)
799 while (read STDIN, $data, 54) {
800 my $pad = q();
802 # Only for the last chunk, and only if did not fill the last three-byte packet
803 if (eof) {
804 my $mod = length($data) %% 3;
805 $pad = q(=) x (3 - $mod) if $mod;
806 }
808 # Not the fastest method, but it is simple: unpack to binary string, split
809 # by groups of 6 bits and convert back from binary to byte; then map into
810 # the translation table
811 print
812 join q(),
813 map($trans{$_},
814 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
815 $pad,
817 }' 2>/dev/null"
818 "Perl program to use for encoding a file.
819 Escape sequence %s is replaced with name of Perl binary.
823 "%s -e '
824 # This script contributed by Juanma Barranquero <lektu@terra.es>.
825 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
826 use strict;
828 my %%trans = do {
829 my $i = 0;
830 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
831 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
832 };
834 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
838 # We are going to accumulate into $pending to accept any line length
839 # (we do not check they are <= 76 chars as the RFC says)
840 my $pending = q();
842 while (my $data = <STDIN>) {
843 chomp $data;
845 # If we find one or two =, we have reached the end and
846 # any following data is to be discarded
847 my $finished = $data =~ s/(==?).*/$1/;
848 $pending .= $data;
850 my $len = length($pending);
851 my $chunk = substr($pending, 0, $len & ~3);
852 $pending = substr($pending, $len & ~3 + 1);
854 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
855 # split in 8-bit chunks and convert back to char.
856 print join q(),
857 map $bytes{$_},
858 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
860 last if $finished;
861 }' 2>/dev/null"
862 "Perl program to use for decoding a file.
863 Escape sequence %s is replaced with name of Perl binary.
867 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
868 "Perl program to use for encoding a file.
872 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
873 "Perl program to use for decoding a file.
878 BEGIN {
881 }
882 {
883 for (c=1; c<=length($0); c++) {
884 d=index(b16, substr($0,c,1))
885 if (d--) {
886 for (b=1; b<=4; b++) {
887 o=o*2+int(d/8); d=(d*2)%%16
888 if (++obc==6) {
889 printf substr(b64,o+1,1)
891 obc=0; o=0
892 }
893 }
894 }
895 }
896 }
897 END {
898 if (obc) {
900 while (obc++<6) { o=o*2 }
902 } else {
904 }
905 printf tail
906 }'"
907 "Awk program to use for encoding a file.
912 BEGIN {
914 }
915 {
916 for (i=1; i<=length($0); i++) {
917 c=index(b64, substr($0,i,1))
918 if(c--) {
919 for(b=0; b<6; b++) {
920 o=o*2+int(c/32); c=(c*2)%%64
921 if(++obc==8) {
922 if (o) {
924 } else {
926 }
927 obc=0; o=0
928 }
929 }
930 }
931 }
932 }'"
933 "Awk program to use for decoding a file.
937 "test -c /dev/zero && \
938 od -v -t x1 -A n </dev/null && \
939 busybox awk '{}' </dev/null"
950 while read file; do
953 else
955 fi
958 else
960 fi
961 done
963 "Script to check existence of VC related files.
964 It must be send formatted with two strings; the tests for file
965 existence, and file readability. Input shall be read via
966 here-document, otherwise the command could exceed maximum length
969 ;; New handlers should be added here.
973 ;; `byte-compiler-base-file-name' performed by default handler.
978 ;; `diff-latest-backup-file' performed by default handler.
982 . tramp-sh-handle-directory-files-and-attributes)
983 ;; `dired-call-process' performed by default handler.
986 . tramp-sh-handle-dired-recursive-delete-directory)
993 ;; `file-equal-p' performed by default handler.
996 ;; `file-in-directory-p' performed by default handler.
1004 ;; `file-name-sans-versions' performed by default handler.
1017 ;; `find-file-noselect' performed by default handler.
1018 ;; `get-file-buffer' performed by default handler.
1022 . tramp-sh-handle-insert-file-contents-literally)
1041 "Alist of handler functions.
1044 ;; This must be the last entry, because `identity' always matches.
1045 ;;;###tramp-autoload
1049 ;;; File Name Handler Functions:
1053 "Like `make-symbolic-link' for Tramp files.
1054 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1055 the symlink. If LINKNAME is a Tramp file, only the localname component is
1056 used as the target of the symlink.
1058 If LINKNAME is a Tramp file and the localname component is relative, then
1059 it is expanded first, before the localname component is taken. Note that
1060 this can give surprising results if the user/host for the source and
1061 target of the symlink differ."
1068 l 'file-error
1071 ;; Do the 'confirm if exists' thing.
1073 ;; What to do?
1078 "File %s already exists; make it a link anyway? "
1079 l-localname)))))
1084 ;; If FILENAME is a Tramp name, use just the localname component.
1093 ;; Right, they are on the same host, regardless of user, method,
1094 ;; etc. We now make the link on the remote machine. This will
1095 ;; occur as the user that FILENAME belongs to.
1097 l
1099 "cd %s && %s -sf %s %s"
1101 ln
1104 t))))
1107 "Like `file-truename' for Tramp files."
1109 "%s%s"
1112 method user host
1117 ;; Use GNU readlink --canonicalize-missing where available.
1120 v
1128 ;; Use Perl implementation.
1136 v
1140 ;; Do it yourself. We bind `directory-sep-char' here for
1141 ;; XEmacs on Windows, which would otherwise use backslash.
1149 ;; Don't make the following value larger than
1150 ;; necessary. People expect an error message in
1151 ;; a timely fashion when something is wrong;
1152 ;; otherwise they might think that Emacs is hung.
1153 ;; Of course, correctness has to come first.
1155 symlink-target)
1166 method user host
1178 ;; It's a symlink, follow it.
1184 ;; If the symlink was absolute, we'll get a
1185 ;; string like "/user@host:/some/target";
1186 ;; extract the "/some/target" part from it.
1190 v 'file-error
1191 "Symlink target `%s' on wrong host"
1192 symlink-target))
1197 steps)))
1199 ;; It's a file.
1203 v 'file-error
1206 ;; Combine list to form string.
1217 result))))
1219 ;; Preserve trailing "/".
1222 ;; Basic functions.
1225 "Like `file-exists-p' for Tramp files."
1233 v
1235 "%s %s"
1240 "Like `file-attributes' for Tramp files."
1243 ;; Don't modify `last-coding-system-used' by accident.
1250 v
1258 ;; The scripts could fail, for example with huge file size.
1262 "Implement `file-attributes' for Tramp files using the ls(1) command."
1264 res-inode res-filemodes res-numlinks
1265 res-uid res-gid res-size res-symlink-target)
1268 vec
1275 ;; On systems which have no quoting style, file names
1276 ;; with special characters could fail.
1281 ;; Parse `ls -l' output ...
1285 ;; ... inode
1301 ;; ... file mode flags
1303 ;; ... number links
1305 ;; ... uid and gid
1315 ;; ... size
1317 ;; From the file modes, figure out other stuff.
1320 ;; If symlink, find out file name pointed to.
1327 ;; Return data gathered.
1329 ;; 0. t for directory, string (name linked to) for symbolic
1330 ;; link, or nil.
1332 ;; 1. Number of links to file.
1333 res-numlinks
1334 ;; 2. File uid.
1335 res-uid
1336 ;; 3. File gid.
1337 res-gid
1338 ;; 4. Last access time, as a list of integers. Normally this
1339 ;; would be in the same format as `current-time', but the
1340 ;; subseconds part is not currently implemented, and (0 0)
1341 ;; denotes an unknown time.
1342 ;; 5. Last modification time, likewise.
1343 ;; 6. Last status change time, likewise.
1345 ;; 7. Size in bytes (-1, if number is out of range).
1346 res-size
1347 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1348 res-filemodes
1349 ;; 9. t if file's gid would change if file were deleted and
1350 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1351 t
1352 ;; 10. Inode number.
1353 res-inode
1354 ;; 11. Device number. Will be replaced by a virtual device number.
1355 -1
1356 )))))
1360 "Implement `file-attributes' for Tramp files using a Perl script."
1365 vec
1371 "Implement `file-attributes' for Tramp files using stat(1) command."
1374 vec
1377 ;; On Opsware, pdksh (which is the true name of ksh there)
1378 ;; doesn't parse correctly the sequence "((". Therefore, we add
1379 ;; a space. Apostrophes in the stat output are masked as
1380 ;; `tramp-stat-marker', in order to make a proper shell escape of
1381 ;; them in file names.
1382 "( (%s %s || %s -h %s) && (%s -c "
1383 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1390 tramp-stat-marker tramp-stat-marker
1395 tramp-stat-marker tramp-stat-marker
1397 tramp-stat-quoted-marker)))
1400 "Like `set-visited-file-modtime' for Tramp files."
1407 coding-system-used)
1411 ;; '(-1 65535) means file doesn't exists yet.
1415 ;; We use '(0 0) as a don't-know value. See also
1416 ;; `tramp-do-file-attributes-with-ls'.
1421 v
1430 nil)))))
1432 ;; This function makes the same assumption as
1433 ;; `tramp-sh-handle-set-visited-file-modtime'.
1435 "Like `verify-visited-file-modtime' for Tramp files.
1436 At the time `verify-visited-file-modtime' calls this function, we
1437 already know that the buffer is visiting a file and that
1438 `visited-file-modtime' does not return 0. Do not call this
1439 function directly, unless those two cases are already taken care
1440 of."
1443 ;; There is no file visiting the buffer, or the buffer has no
1444 ;; recorded last modification time, or there is no established
1445 ;; connection.
1449 t
1457 ;; File exists, and has a known modtime.
1460 modtime
1461 ;; For compatibility, deal with both the old
1462 ;; (HIGH . LOW) and the new (HIGH LOW) return
1463 ;; values of `visited-file-modtime'.
1466 mt)))
1468 ;; Modtime has the don't know value.
1471 v
1478 attr
1481 ;; If file does not exist, say it is not modified if and
1482 ;; only if that agrees with the buffer's record.
1486 "Like `set-file-modes' for Tramp files."
1490 ;; FIXME: extract the proper text from chmod's stderr.
1492 v
1499 "Like `set-file-times' for Tramp files."
1507 time))
1508 ;; With GNU Emacs, `format-time-string' has an
1509 ;; optional parameter UNIVERSAL. This is preferred,
1510 ;; because we could handle the case when the remote
1511 ;; host is located in a different time zone as the
1512 ;; local host.
1516 "%s %s %s %s"
1527 ;; We handle also the local part, because in older Emacsen,
1528 ;; without `set-file-times', this function is an alias for this.
1529 ;; We are local, so we don't need the UTC settings.
1537 "Set the ownership for FILENAME.
1538 If UID and GID are provided, these values are used; otherwise uid
1539 and gid of the corresponding user is taken. Both parameters must
1540 be non-negative integers."
1541 ;; Modern Unices allow chown only for root. So we might need
1542 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1543 ;; working with su(do)? when it is needed, so it shall succeed in
1544 ;; the majority of cases.
1545 ;; Don't modify `last-coding-system-used' by accident.
1550 ;; If we are root on the local host, we can do it directly.
1558 "chown %d:%d %s" uid gid
1561 ;; We handle also the local part, because there doesn't exist
1562 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1563 ;; timeout for this.
1568 nil "chown" nil nil nil
1572 "Check, whether SELINUX is enabled on the remote host."
1577 "Like `file-selinux-context' for Tramp files."
1586 "%s -d -Z %s"
1594 ;; Return the context.
1595 context))))
1598 "Like `set-file-selinux-context' for Tramp files."
1618 t)))))
1621 "Check, whether ACL is enabled on the remote host."
1626 "Like `file-acl' for Tramp files."
1632 "getfacl -ac %s"
1642 "Like `set-file-acl' for Tramp files."
1649 tramp-end-of-heredoc
1650 acl-string
1651 tramp-end-of-heredoc))
1653 ;; Success.
1656 t)
1657 ;; In case of errors, we return nil.
1659 nil)))
1661 ;; Simple functions using the `test' command.
1664 "Like `file-executable-p' for Tramp files."
1667 ;; Examine `file-attributes' cache to see if request can be
1668 ;; satisfied without remote operation.
1673 "Like `file-readable-p' for Tramp files."
1676 ;; Examine `file-attributes' cache to see if request can be
1677 ;; satisfied without remote operation.
1681 ;; When the remote shell is started, it looks for a shell which groks
1682 ;; tilde expansion. Here, we assume that all shells which grok tilde
1683 ;; expansion will also provide a `test' command which groks `-nt' (for
1684 ;; newer than). If this breaks, tell me about it and I'll try to do
1685 ;; something smarter about it.
1687 "Like `file-newer-than-file-p' for Tramp files."
1689 nil)
1691 t)
1692 ;; We are sure both files exist at this point.
1695 ;; We try to get the mtime of both files. If they are not
1696 ;; equal to the "dont-know" value, then we subtract the times
1697 ;; and obtain the result.
1703 ;; If one of them is the dont-know value, then we can
1704 ;; still try to run a shell command on the remote host.
1705 ;; However, this only works if both files are Tramp
1706 ;; files and both have the same method, same user, same
1707 ;; host.
1712 v 'file-error
1713 "Files %s and %s must have same method, user, host"
1714 file1 file2)))
1719 ;; Functions implemented using the basic functions above.
1722 "Like `file-directory-p' for Tramp files."
1724 ;; `file-directory-p' is used as predicate for file name completion.
1725 ;; Sometimes, when a connection is not established yet, it is
1726 ;; desirable to return t immediately for "/method:foo:". It can
1727 ;; be expected that this is always a directory.
1733 "Like `file-writable-p' for Tramp files."
1737 ;; Examine `file-attributes' cache to see if request can be
1738 ;; satisfied without remote operation.
1741 ;; If file doesn't exist, check if directory is writable.
1746 "Like `file-ownership-preserved-p' for Tramp files."
1750 ;; Return t if the file doesn't exist, since it's true that no
1751 ;; information would be lost by an (attempted) delete and create.
1758 ;; Directory listings.
1762 "Like `directory-files-and-attributes' for Tramp files."
1770 v localname
1781 v localname id-format))
1784 v localname id-format))
1786 result item)
1796 result
1798 ;; The scripts could fail, for example with huge file size.
1800 directory full match nosort id-format)))))
1804 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1807 vec tramp-perl-directory-files-and-attributes
1811 vec
1815 object))
1819 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1822 vec
1825 ;; We must care about file names with spaces, or starting with
1826 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1827 ;; but it does not work on all remote systems. Apostrophes in
1828 ;; the stat output are masked as `tramp-stat-marker', in order to
1829 ;; make a proper shell escape of them in file names.
1831 "xargs %s -c "
1832 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1836 ;; On systems which have no quoting style, file names with
1837 ;; special characters could fail.
1841 tramp-stat-marker tramp-stat-marker
1842 tramp-stat-marker tramp-stat-marker
1847 tramp-stat-marker tramp-stat-marker
1848 tramp-stat-quoted-marker)))
1850 ;; This function should return "foo/" for directories and "bar" for
1851 ;; files.
1853 "Like `file-name-all-completions' for Tramp files."
1858 filename
1860 'list
1862 ;; Try cache entries for `filename', `filename' with last
1863 ;; character removed, `filename' with last two characters
1864 ;; removed, ..., and finally the empty string - all
1865 ;; concatenated to the local directory name.
1868 tramp-completion-reread-directory-timeout)))
1870 ;; This is inefficient for very long file names, pity
1871 ;; `reduce' is not available...
1874 'append
1879 v
1881 "file-name-all-completions"
1882 nil)))
1884 ;; We cannot use a length of 0, because file properties
1885 ;; for "foo" and "foo/" are identical.
1888 ;; Cache expired or no matching cache entry found so we need
1889 ;; to perform a remote operation.
1891 ;; Get a list of directories and files, including reliably
1892 ;; tagging the directories with a trailing '/'. Because I
1893 ;; rock. --daniel@danann.net
1895 ;; Changed to perform `cd' in the same remote op and only
1896 ;; get entries starting with `filename'. Capture any `cd'
1897 ;; error messages. Ensure any `cd' and `echo' aliases are
1898 ;; ignored.
1900 v
1904 v tramp-perl-file-name-all-completions
1910 ;; `read-file-name-completion-ignore-case'
1911 ;; is introduced with Emacs 22.1.
1914 'read-file-name-completion-ignore-case
1919 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1920 ;; `ls' with wildcard might fail with `Argument
1921 ;; list too long' error in some corner cases; if
1922 ;; `ls' fails after `cd' succeeded, chances are
1923 ;; that's the case, so let's retry without
1924 ;; wildcard. This will return "too many" entries
1925 ;; but that isn't harmful.
1926 " || %s -a 2>/dev/null)"
1927 " | while IFS= read f; do"
1933 ;; When `filename' is empty, just `ls' without
1934 ;; `filename' argument is more efficient than `ls *'
1935 ;; for very large directories and might avoid the
1936 ;; `Argument list too long' error.
1937 ;;
1938 ;; With and only with wildcard, we need to add
1939 ;; `-d' to prevent `ls' from descending into
1940 ;; sub-directories.
1942 "."
1947 ;; Now grab the output.
1951 ;; Check result code, found in last line of output.
1955 ;; Grab error message from line before last line
1956 ;; (it was put there by `cd 2>&1').
1959 v 'file-error
1960 "tramp-sh-handle-file-name-all-completions: %s"
1962 ;; For peace of mind, if buffer doesn't end in `fail'
1963 ;; then it should end in `ok'. If neither are in the
1964 ;; buffer something went seriously wrong on the remote
1965 ;; side.
1968 v 'file-error
1969 "\
1970 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1976 ;; Because the remote op went through OK we know the
1977 ;; directory we `cd'-ed to exists.
1980 ;; Because the remote op went through OK we know every
1981 ;; file listed by `ls' exists.
1985 result)
1987 ;; Store result in the cache.
1992 ;; cp, mv and ln
1996 "Like `add-name-to-file' for Tramp files."
2001 v 'file-error
2002 "add-name-to-file: %s"
2011 "File %s already exists; make it a new name anyway? "
2012 newname)))
2019 v1
2023 "error with add-name-to-file, see buffer `%s' for details"
2028 preserve-uid-gid preserve-extended-attributes)
2029 "Like `copy-file' for Tramp files."
2033 ;; At least one file a Tramp file?
2037 'copy filename newname ok-if-already-exists keep-date
2038 preserve-uid-gid preserve-extended-attributes))
2039 ;; Compat section.
2042 'copy-file
2044 preserve-uid-gid preserve-extended-attributes)))
2047 'copy-file
2055 "Like `copy-directory' for Tramp files."
2061 ;; When DIRNAME and NEWNAME are remote, they must have
2062 ;; the same method.
2068 ;; scp or rsync DTRT.
2082 ;; We must do it file-wise.
2084 'copy-directory
2089 ;; When newname did exist, we have wrong cached values.
2097 "Like `rename-file' for Tramp files."
2098 ;; Check if both files are local -- invoke normal rename-file.
2099 ;; Otherwise, use Tramp from local system.
2102 ;; At least one file a Tramp file?
2112 preserve-uid-gid preserve-extended-attributes)
2113 "Copy or rename a remote file.
2114 OP must be `copy' or `rename' and indicates the operation to perform.
2115 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2116 the new file (for copy) or the new name of the file (for rename).
2117 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2118 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2119 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2120 the uid and gid if both files are on the same host.
2121 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2123 This function is invoked by `tramp-sh-handle-copy-file' and
2124 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2125 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2126 file names."
2143 filename newname)
2146 ;; Both are Tramp files.
2151 ;; Shortcut: if method, host, user are the same for
2152 ;; both files, we invoke `cp' or `mv' on the remote
2153 ;; host directly.
2156 op filename newname
2157 ok-if-already-exists keep-date preserve-uid-gid))
2159 ;; Try out-of-band operation.
2164 op filename newname keep-date))
2166 ;; No shortcut was possible. So we copy the file
2167 ;; first. If the operation was `rename', we go back
2168 ;; and delete the original file (if the copy was
2169 ;; successful). The approach is simple-minded: we
2170 ;; create a new buffer, insert the contents of the
2171 ;; source file into it, then write out the buffer to
2172 ;; the target file. The advantage is that it doesn't
2173 ;; matter which file name handlers are used for the
2174 ;; source and target file.
2177 op filename newname keep-date))))))
2179 ;; One file is a Tramp file, the other one is local.
2182 ;; Fast track on local machine.
2185 op filename newname
2186 ok-if-already-exists keep-date preserve-uid-gid))
2188 ;; If the Tramp file has an out-of-band method, the
2189 ;; corresponding copy-program can be invoked.
2192 op filename newname keep-date))
2194 ;; Use the inline method via a Tramp buffer.
2196 op filename newname keep-date))))
2199 ;; One of them must be a Tramp file.
2202 ;; Handle `preserve-extended-attributes'. We ignore possible
2203 ;; errors, because ACL strings could be incompatible.
2208 ;; In case of `rename', we must flush the cache of the source file.
2214 ;; When newname did exist, we have wrong cached values.
2221 "Use an Emacs buffer to copy or rename a file.
2222 First arg OP is either `copy' or `rename' and indicates the operation.
2223 FILENAME is the source file, NEWNAME the target file.
2224 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2225 ;; We must disable multibyte, because binary data shall not be
2226 ;; converted. We don't want the target file to be compressed, so we
2227 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2228 ;; be called either. We remove `tramp-file-name-handler' from
2229 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2230 ;; `insert-file-contents' might be deactivated in some corner cases.
2241 ;; KEEP-DATE handling.
2243 ;; Set the mode.
2245 ;; If the operation was `rename', delete the original file.
2250 "Invokes `cp' or `mv' on the remote system.
2251 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2252 respectively. FILENAME specifies the file to copy or rename,
2253 NEWNAME is the name of the new file (for copy) or the new name of
2254 the file (for rename). Both files must reside on the same host.
2255 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2256 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2257 the uid and gid from FILENAME."
2267 v 'file-error
2268 "Unknown operation `%s', must be `copy' or `rename'"
2269 op))))
2273 filename))
2277 newname))
2279 cmd-result)
2282 ;; Both files are on a remote host, with same user.
2294 ;; Mask cp -f error.
2296 tramp-operation-not-permitted-regexp nil t))
2297 cmd-result)
2299 nil v 'file-error
2300 "Copying directly failed, see buffer `%s' for details."
2303 ;; We are on the local host.
2306 ;; We can do it directly.
2309 ;; No sticky bit when renaming.
2320 localname1 localname2 ok-if-already-exists
2321 keep-date preserve-uid-gid)
2325 ;; We can do it directly with `tramp-send-command'
2333 ok-if-already-exists keep-date t)
2334 ;; We must change the ownership to the local user.
2340 ;; We need a temporary file in between.
2342 ;; Create the temporary file.
2350 "%s %s %s" cmd
2353 "Copying directly failed, see buffer `%s' for details."
2355 ;; We must change the ownership as remote user.
2356 ;; Since this does not work reliable, we also
2357 ;; give read permissions.
2368 localname1 tmpfile t
2369 keep-date preserve-uid-gid)
2371 'rename-file
2373 ;; We must change the ownership as local user.
2374 ;; Since this does not work reliable, we also
2375 ;; give read permissions.
2379 tmpfile
2383 ;; Move the temporary file to its destination.
2388 "cp -f -p %s %s"
2391 "Copying directly failed, see buffer `%s' for details."
2395 'rename-file
2398 ;; Save exit.
2401 ;; Set the time and mode. Mask possible errors.
2408 "Invoke `scp' program to copy.
2409 The method used must be an out-of-band method."
2413 copy-program copy-args copy-env copy-keep-date port listener spec
2414 options source target remote-copy-program remote-copy-args)
2419 ;; Both are Tramp files. We shall optimize it when the
2420 ;; methods for FILENAME and NEWNAME are the same.
2430 op filename tmpfile keep-date)
2433 ;; Save exit.
2440 ;; Set variables for computing the prompt for reading
2441 ;; password.
2448 ;; Expand hops. Might be necessary for gateway methods.
2452 ;; Check which ones of source and target are Tramp files.
2461 'file-name-directory
2467 ;; Check for host and port number. We cannot use
2468 ;; `tramp-file-name-port', because this returns also
2469 ;; `tramp-default-port', which might clash with settings in
2470 ;; "~/.ssh/config".
2477 ;; Check for user. There might be an interactive setting.
2481 ;; Check for listener port.
2488 ;; Compose copy command.
2497 ?h host ?u user ?p port ?r listener ?c options
2503 copy-args
2505 ;; " " has either been a replacement of "%k" (when
2506 ;; keep-date argument is non-nil), or a replacement
2507 ;; for the whole keep-date sublist.
2508 " "
2513 copy-args
2517 copy-env
2519 nil
2526 remote-copy-program
2532 remote-copy-args
2536 ;; Check for local copy program.
2541 ;; Install listener on the remote side. The prompt must be
2542 ;; consumed later on, when the process does not listen anymore.
2549 v 'file-error
2553 'identity
2561 v 'file-error
2562 "Listener process not running on remote host: `%s'"
2563 remote-copy-program))
2571 ;; The default directory must be remote.
2575 ;; Set the transfer process properties.
2585 copy-args
2587 copy-args
2592 ;; Use an asynchronous process. By this, password can
2593 ;; be handled. We don't set a timeout, because the
2594 ;; copying of large files can last longer than 60
2595 ;; secs.
2599 copy-program
2601 copy-args
2610 ;; We must adapt `tramp-local-end-of-line' for
2611 ;; sending the password.
2614 p v nil tramp-actions-copy-out-of-band))
2616 ;; Check the return code.
2621 orig-vec 'file-error
2622 "Couldn't find exit status of `%s'"
2628 orig-vec 'file-error
2629 "Error copying: `%s'"
2632 ;; Reset the transfer process properties.
2635 ;; Clear the remote prompt.
2638 ;; Houston, we have a problem! Likely, the listener is
2639 ;; still running, so let's clear everything (but the
2640 ;; cached password).
2643 ;; Handle KEEP-DATE argument.
2647 ;; Set the mode.
2652 ;; If the operation was `rename', delete the original file.
2659 "Like `make-directory' for Tramp files."
2671 "Like `delete-directory' for Tramp files."
2683 "Like `delete-file' for Tramp files."
2694 ;; Dired.
2696 ;; CCC: This does not seem to be enough. Something dies when
2697 ;; we try and delete two directories under Tramp :/
2699 "Recursively delete the directory given.
2700 This is like `dired-recursive-delete-directory' for Tramp files."
2702 ;; Run a shell command 'rm -r <localname>'.
2703 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2706 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2708 v
2710 ;; Don't read the output, do it explicitly.
2711 nil t)
2712 ;; Wait for the remote system to return to us...
2713 ;; This might take a while, allow it plenty of time.
2715 ;; Make sure that it worked...
2723 "Like `dired-compress-file' for Tramp files."
2724 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2725 ;; Code stolen mainly from dired-aux.el.
2731 ;; Emacs case
2733 ;; XEmacs has `dired-compression-method-alist', which is
2734 ;; transformed into `dired-compress-file-suffixes' structure.
2738 nil
2741 suffix)
2742 ;; See if any suffix rule matches this file name.
2750 nil)
2752 ;; We found an uncompression rule.
2758 ;; `dired-remove-file' is not defined in XEmacs.
2763 ;; We don't recognize the file as compressed, so compress it.
2764 ;; Try gzip.
2769 ;; `dired-remove-file' is not defined in XEmacs.
2779 "Like `insert-directory' for Tramp files."
2786 filename switches wildcard full-directory-p)
2806 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2807 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2810 v
2813 switches
2815 localname
2818 v
2822 "Couldn't `cd %s'"
2826 v
2829 switches
2834 ""
2842 ;; We cannot use `insert-buffer-substring' because the Tramp
2843 ;; buffer changes its contents before insertion due to calling
2844 ;; `expand-file' and alike.
2849 ;; Check for "--dired" output.
2856 ;; Now read the numeric positions of file names.
2862 ;; End is followed by \n or by " -> ".
2864 ;; Remove trailing lines.
2870 ;; Some busyboxes are reluctant to discard colors.
2877 ;; Decode the output, it could be multibyte.
2884 ;; The inserted file could be from somewhere else.
2891 "."
2898 ;; Canonicalization of file names.
2901 "Like `expand-file-name' for Tramp files.
2903 the result will be a local, non-Tramp, file name."
2904 ;; If DIR is not given, use `default-directory' or "/".
2906 ;; Unless NAME is absolute, concat DIR and NAME.
2909 ;; If NAME is not a Tramp file, run the real handler.
2912 ;; Dissect NAME.
2916 ;; Tilde expansion if necessary. This needs a shell which
2917 ;; groks tilde expansion! The function `tramp-find-shell' is
2918 ;; supposed to find such a shell on the remote host. Please
2919 ;; tell me about it when this doesn't work on your system.
2923 ;; We cannot simply apply "~/", because under sudo "~/" is
2924 ;; expanded to the local user home directory but to the
2925 ;; root home directory. On the other hand, using always
2926 ;; the default user name for tilde expansion is not
2927 ;; appropriate either, because ssh and companions might
2928 ;; use a user name from the config file.
2940 ;; There might be a double slash, for example when "~/"
2941 ;; expands to "/". Remove this.
2944 ;; No tilde characters in file name, do normal
2945 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2946 ;; `directory-sep-char' here for XEmacs on Windows, which would
2947 ;; otherwise use backslash. `default-directory' is bound,
2948 ;; because on Windows there would be problems with UNC shares or
2949 ;; Cygwin mounts.
2953 method user host
2957 hop)))))
2959 ;;; Remote commands:
2962 "Flush file caches."
2970 ;; We use BUFFER also as connection buffer during setup. Because of
2971 ;; this, its original contents must be saved, and restored once
2972 ;; connection has been setup.
2974 "Like `start-file-process' for Tramp files."
2977 ;; it might be that the arguments exceed the command line
2978 ;; length. Therefore, we modify the command.
2983 ;; When PROGRAM is nil, we just provide a tty.
2989 args
2993 ;; Use a human-friendly prompt, for example for `shell'.
2994 ;; We discard hops, if existing, that's why we cannot use
2995 ;; `file-remote-p'.
3002 tramp-initial-end-of-output))
3003 ;; We use as environment the difference to toplevel
3004 ;; `process-environment'.
3005 env
3010 env)
3029 ;; We do not want to raise an error when
3030 ;; `start-file-process' has been started several times in
3031 ;; `eshell' and friends.
3035 ;; BUFFER can be nil. We use a temporary buffer.
3038 ;; NAME must be unique as process name.
3042 ;; Set the new process properties.
3048 ;; We catch this event. Otherwise, `start-process' could
3049 ;; be called on the local host.
3052 ;; Activate narrowing in order to save BUFFER
3053 ;; contents. Clear also the modification time;
3054 ;; otherwise we might be interrupted by
3055 ;; `verify-visited-file-modtime'.
3061 ;; We call `tramp-maybe-open-connection', in order
3062 ;; to cleanup the prompt afterwards.
3068 ;; Now do it.
3070 ;; Send the command.
3072 ;; Check, whether a pty is associated.
3076 v 'file-error
3079 ;; Set query flag and process marker for this
3080 ;; process. We ignore errors, because the process
3081 ;; could have finished already.
3085 ;; Return process.
3086 p))))
3088 ;; Save exit.
3099 "Like `process-file' for Tramp files."
3100 ;; The implementation is not complete yet.
3106 ;; Compute command.
3109 ;; We use as environment the difference to toplevel `process-environment'.
3117 "env %s %s"
3119 ;; Determine input.
3124 ;; INFILE is on the same remote host.
3126 ;; INFILE must be copied to remote host.
3132 ;; Determine output.
3134 ;; Just a buffer.
3137 ;; A buffer name.
3140 ;; (REAL-DESTINATION ERROR-DESTINATION)
3142 ;; output.
3150 ;; stderr.
3155 ;; stderr is on the same remote host.
3158 ;; stderr must be copied to remote host. The temporary
3159 ;; file must be deleted after execution.
3162 method user host stderr))))
3163 ;; stderr to be discarded.
3166 ;; 't
3171 ;; Send the command. It might not return in time, so we protect
3172 ;; it. Call it in a subshell, in order to preserve working
3173 ;; directory.
3180 command)
3181 t t)
3183 ;; We should add the output anyway.
3190 ;; When the user did interrupt, we should do it also. We use
3191 ;; return code -1 as marker.
3195 ;; Handle errors.
3200 ;; Provide error file.
3203 ;; Cleanup. We remove all file cache values for the connection,
3204 ;; because the remote process could have changed them.
3207 ;; `process-file-side-effects' has been introduced with GNU
3208 ;; Emacs 23.2. If set to nil, no remote file will be changed
3209 ;; by `program'. If it doesn't exist, we assume its default
3210 ;; value t.
3215 ;; Return exit status.
3218 ret))))
3221 "Like `file-local-copy' for Tramp files."
3225 v 'file-error
3235 ;; `copy-file' handles direct copy and out-of-band methods.
3240 ;; Use inline encoding for file transfer.
3244 v 3
3246 filename rem-enc)
3253 tmpfile loc-dec)
3255 ;; If local decoding is a function, we call it.
3256 ;; We must disable multibyte, because
3257 ;; `uudecode-decode-region' doesn't handle it
3258 ;; correctly. Unset `file-name-handler-alist'.
3259 ;; Otherwise, epa-file gets confused.
3267 ;; If tramp-decoding-function is not defined for this
3268 ;; method, we invoke tramp-decoding-command instead.
3270 ;; Unset `file-name-handler-alist'. Otherwise,
3271 ;; epa-file gets confused.
3279 loc-dec tmpfile2 tmpfile)
3282 ;; Set proper permissions.
3284 ;; Set local user ownership.
3287 ;; Oops, I don't know what to do.
3291 ;; Error handling.
3297 tmpfile)))
3299 ;; This is needed for XEmacs only. Code stolen from files.el.
3302 "Like `insert-file-contents-literally' for Tramp files."
3310 nil))
3318 ;; Save exit.
3323 ;; CCC grok LOCKNAME
3326 "Like `write-region' for Tramp files."
3329 ;; Following part commented out because we don't know what to do about
3330 ;; file locking, and it does not appear to be a problem to ignore it.
3331 ;; Ange-ftp ignores it, too.
3332 ;; (when (and lockname (stringp lockname))
3333 ;; (setq lockname (expand-file-name lockname)))
3334 ;; (unless (or (eq lockname nil)
3335 ;; (string= lockname filename))
3336 ;; (error
3337 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3339 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3350 ;; `file-writable-p' calls `file-expand-file-name'. We
3351 ;; cannot use `tramp-run-real-handler' therefore.
3357 ;; Short track: if we are on the local host, we can run directly.
3359 'write-region
3363 ;; We use this to save the value of
3364 ;; `last-coding-system-used' after writing the tmp
3365 ;; file. At the end of the function, we set
3366 ;; `last-coding-system-used' to this saved value. This
3367 ;; way, any intermediary coding systems used while
3368 ;; talking to the remote shell or suchlike won't hose
3369 ;; this variable. This approach was snarfed from
3370 ;; ange-ftp.el.
3371 coding-system-used
3372 ;; Write region into a tmp file. This isn't really
3373 ;; needed if we use an encoding function, but currently
3374 ;; we use it always because this makes the logic
3375 ;; simpler. We must also set `temporary-file-directory',
3376 ;; because it could point to a remote directory.
3382 ;; If `append' is non-nil, we copy the file locally, and let
3383 ;; the native `write-region' implementation do the job.
3386 ;; We say `no-message' here because we don't want the
3387 ;; visited file modtime data to be clobbered from the temp
3388 ;; file. We call `set-visited-file-modtime' ourselves later
3389 ;; on. We must ensure that `file-coding-system-alist'
3390 ;; matches `tmpfile'.
3396 'write-region
3403 ;; Now, `last-coding-system-used' has the right value. Remember it.
3408 ;; The permissions of the temporary file should be set. If
3409 ;; FILENAME does not exist (eq modes nil) it has been
3410 ;; renamed to the backup file. This case `save-buffer'
3411 ;; handles permissions.
3412 ;; Ensure that it is still readable.
3415 tmpfile
3418 ;; This is a bit lengthy due to the different methods
3419 ;; possible for file transfer. First, we check whether the
3420 ;; method uses an scp program. If so, we call it.
3421 ;; Otherwise, both encoding and decoding command must be
3422 ;; specified. However, if the method _also_ specifies an
3423 ;; encoding function, then that is used for encoding the
3424 ;; contents of the tmp file.
3429 ;; `copy-file' handles direct copy and out-of-band methods.
3439 ;; We keep the local file for performance
3440 ;; reasons, useful for "rsync".
3447 ;; Don't rename, in order to keep context in SELinux.
3452 ;; Use inline file transfer.
3454 ;; Encode tmpfile.
3458 ;; Use encoding function or command.
3461 "Encoding local file `%s' using `%s'"
3462 tmpfile loc-enc)
3464 ;; The following `let' is a workaround for
3465 ;; the base64.el that comes with pgnus-0.84.
3466 ;; If both of the following conditions are
3467 ;; satisfied, it tries to write to a local
3468 ;; file in default-directory, but at this
3469 ;; point, default-directory is remote.
3470 ;; (`call-process-region' can't write to
3471 ;; remote files, it seems.) The file in
3472 ;; question is a tmp file anyway.
3480 loc-enc tmpfile t))
3482 v 'file-error
3485 filename loc-enc))))
3487 ;; Send buffer into remote decoding command which
3488 ;; writes to remote file. Because this happens on
3489 ;; the remote host, we cannot use the function.
3492 "Decoding remote file `%s' using `%s'"
3493 filename rem-dec)
3497 v
3501 tramp-end-of-heredoc
3503 tramp-end-of-heredoc))
3505 v nil
3506 "Couldn't write region to `%s', decode using `%s' failed"
3507 filename rem-dec)
3508 ;; When `file-precious-flag' is set, the region is
3509 ;; written to a temporary file. Check that the
3510 ;; checksum is equal to that from the local tmpfile.
3514 ;; cksum runs locally, if possible.
3516 ;; cksum runs remotely.
3518 v
3521 ;; ... they are different.
3528 v 'file-error
3531 filename rem-dec)))))
3533 ;; Save exit.
3536 ;; That's not expected.
3539 v 'file-error
3542 method))))
3544 ;; Make `last-coding-system-used' have the right value.
3551 ;; We must protect `last-coding-system-used', now we have set it
3552 ;; to its correct value.
3554 ;; Set file modification time.
3558 ;; We must pass modtime explicitly, because FILENAME can
3559 ;; be different from (buffer-file-name), f.e. if
3560 ;; `file-precious-flag' is set.
3566 ;; Set the ownership.
3576 ;; VC backends check for the existence of various different special
3577 ;; files. This is very time consuming, because every single check
3578 ;; requires a remote command (the file cache must be invalidated).
3579 ;; Therefore, we apply a kind of optimization. We install the file
3580 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3581 ;; remembers all file names for which `file-exists-p' or
3582 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3583 ;; is performed. Afterwards, a script is applied for all collected
3584 ;; file names, using just one remote command. The result of this
3585 ;; script is used to fill the file cache with actual values. Now we
3586 ;; can reset the file name handlers, and we make a second run of
3587 ;; `vc-registered', which returns the expected result without sending
3588 ;; any other remote command.
3590 "Like `vc-registered' for Tramp files."
3596 ;; There could be new files, created by the vc backend. We
3597 ;; cannot reuse the old cache entries, therefore. In
3598 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3599 ;; could also be a timestamp as `current-time' returns. This
3600 ;; means invalidate all cache entries with an older timestamp.
3606 ;; Here we collect only file names, which need an operation.
3610 ;; Send just one command, in order to fill the cache.
3613 v
3622 ;; We cannot use `tramp-send-command-and-read',
3623 ;; because this does not cooperate well with
3624 ;; heredoc documents.
3626 v
3629 tramp-end-of-heredoc
3631 tramp-vc-registered-file-names
3633 tramp-end-of-heredoc))
3635 ;; Read the expression.
3642 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3643 ;; calls shall be answered from the file cache. We unset
3644 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3645 ;; in order to keep the cache.
3647 remote-file-name-inhibit-cache process-file-side-effects)
3648 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3667 ;; Run.
3671 ;;;###tramp-autoload
3673 "Invoke remote-shell Tramp file name handler.
3674 Fall back to normal file name handler if no Tramp handler exists."
3692 "Invoke special file name handler, which collects files to be handled."
3700 ;; That's what we want: file names, for which checks are
3701 ;; applied. We assume that VC uses only `file-exists-p' and
3702 ;; `file-readable-p' checks; otherwise we must extend the
3703 ;; list. We do not perform any action, but return nil, in
3704 ;; order to keep `vc-registered' running.
3707 nil)
3708 ;; `process-file' and `start-file-process' shall be ignored.
3711 ;; Tramp file name handlers like `expand-file-name'. They
3712 ;; must still work.
3714 ;; Default file name handlers, we don't care.
3718 "Like `file-notify-add-watch' for Tramp files."
3722 command events filter p sequence)
3724 ;; gvfs-monitor-dir.
3728 ;; inotifywait.
3731 events
3738 ;; None.
3740 v 'file-notify-error
3741 "No file notification program found on %s"
3743 ;; Start process.
3745 'start-file-process
3749 sequence))
3750 ;; Return the process object as watch-descriptor.
3753 v 'file-notify-error
3754 "`%s' failed to start on remote host"
3760 p))))
3772 ;; Attribute change is returned in unused wording.
3782 string)
3785 proc
3789 ;; File names are returned as absolute paths. We must
3790 ;; add the remote prefix.
3795 ;; Usually, we would add an Emacs event now. Unfortunately,
3796 ;; `unread-command-events' does not accept several events at
3797 ;; once. Therefore, we apply the callback directly.
3800 ;; Save rest of the string.
3809 ;; Check, whether there is a problem.
3815 line)
3820 proc
3827 ;; Usually, we would add an Emacs event now. Unfortunately,
3828 ;; `unread-command-events' does not accept several events at
3829 ;; once. Therefore, we apply the callback directly.
3832 ;;; Internal Functions:
3835 "Define in remote shell function NAME implemented as SCRIPT.
3836 Only send the definition if it has not already been done."
3837 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3838 ;; might be nil.
3844 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3845 ;; could result in unwanted command expansion. Avoid this.
3848 ;; The script could contain a call of Perl. This is masked with `%s'.
3853 vec
3861 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3862 Returns the exit code of the `test' program."
3865 v
3867 "%s %s %s"
3869 switch
3873 "Run `test'-like program on the remote system, given FILE1, FILE2.
3874 FORMAT-STRING contains the program name, switches, and place holders.
3875 Returns the exit code of the `test' program. Barfs if the methods,
3876 hosts, or files, disagree."
3880 v 'file-error
3885 v1
3892 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3893 First arg VEC specifies the connection, PROGNAME is the program
3894 to search for, and DIRLIST gives the list of directories to
3895 search. If IGNORE-TILDE is non-nil, directory names starting
3896 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3897 only in DIRLIST.
3899 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3901 This function expects to be in the right *tramp* buffer."
3904 ;; Check whether the executable is in $PATH. "which(1)" does not
3905 ;; report always a correct error code; therefore we check the
3906 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3907 ;; 5.11") have problems with this command, we disable the call
3908 ;; therefore.
3919 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3920 ;; `remove' is in CL, and we want to avoid CL dependencies.
3929 vec
3931 "do if test -x $d/%s && test -f $d/%s; "
3932 "then echo tramp_executable $d/%s; "
3935 progname progname progname
3936 tramp-end-of-heredoc
3938 tramp-end-of-heredoc))
3944 result)))
3947 "Sets the remote environment PATH to existing directories.
3948 I.e., for each directory in `tramp-remote-path', it is tested
3949 whether it exists and if so, it is added to the environment
3950 variable PATH."
3956 ;; ------------------------------------------------------------
3957 ;; -- Communication with external shell --
3958 ;; ------------------------------------------------------------
3961 "Find a command on the remote host for checking if a file exists.
3962 Here, we are looking for a command which has zero exit status if the
3963 file exists and nonzero exit status otherwise."
3967 result)
3968 ;; The algorithm is as follows: we try a list of several commands.
3969 ;; For each command, we first run `$cmd /' -- this should return
3970 ;; true, as the root directory always exists. And then we run
3971 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3972 ;; does not exist. This should return false. We use the first
3973 ;; command we find that seems to work.
3974 ;; The list of commands to try is as follows:
3975 ;; `ls -d' This works on most systems, but NetBSD 1.4
3976 ;; has a bug: `ls' always returns zero exit
3977 ;; status, even for files which don't exist.
3978 ;; `test -e' Some Bourne shells have a `test' builtin
3979 ;; which does not know the `-e' option.
3980 ;; `/bin/test -e' For those, the `test' binary on disk normally
3981 ;; provides the option. Alas, the binary
3982 ;; is sometimes `/bin/test' and sometimes it's
3983 ;; `/usr/bin/test'.
3984 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
4012 result))
4015 "Opens shell SHELL."
4018 ;; Find arguments for this shell.
4020 item extra-args)
4025 ;; It is useful to set the prompt in the following command
4026 ;; because some people have a setting for $PS1 which /bin/sh
4027 ;; doesn't know about and thus /bin/sh will display a strange
4028 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
4029 ;; ksh will display the current working directory but /bin/sh
4030 ;; will display a dollar sign. The following command line sets
4031 ;; $PS1 to a sane value, and works under Bourne-ish shells as
4032 ;; well as csh-like shells. We also unset the variable $ENV
4033 ;; because that is read by some sh implementations (eg, bash
4034 ;; when called as sh) on startup; this way, we avoid the startup
4035 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
4036 ;; the prompt in /bin/bash, it must be discarded as well.
4037 ;; $HISTFILE is set according to `tramp-histfile-override'.
4040 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
4045 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
4049 t))
4054 "Opens a shell on the remote host which groks tilde expansion."
4057 shell)
4060 ;; CCC: "root" does not exist always, see QNAP 459.
4061 ;; Which check could we apply instead?
4064 ;; The default shell (ksh93) of OpenSolaris and
4065 ;; Solaris is buggy. We've got reports for
4066 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4075 ;; Maybe it works at least for some other commands.
4077 default-shell
4079 vec 2
4081 "Couldn't find a remote shell which groks tilde "
4083 default-shell)))
4085 default-shell)))
4087 ;; Open a new shell if needed.
4093 ;; Utility functions.
4096 "Wait for shell prompt and barf if none appears.
4097 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4098 seconds. If not, it produces an error message with the given ERROR-ARGS."
4102 proc timeout
4111 "Set up an interactive shell.
4112 Mainly sets the prompt and the echo correctly. PROC is the shell
4113 process to set up. VEC specifies the connection."
4117 ;; Disable tab and echo expansion.
4120 ;; Check whether the echo has really been disabled. Some
4121 ;; implementations, like busybox of embedded GNU/Linux, don't
4122 ;; support disabling.
4129 ;; Make sure backspaces and their echo are enabled and no line
4130 ;; width magic interferes with them.
4138 ;; Try to set up the coding system correctly.
4139 ;; CCC this can't be the right way to do it. Hm.
4143 ;; Use MULE to select the right EOL convention for communicating
4144 ;; with the process.
4150 cs-decode cs-encode)
4167 ;; Look for ^M and do something useful if found.
4169 ;; We have found a ^M but cannot frob the process coding system
4170 ;; because we're running on a non-MULE Emacs. Let's try
4171 ;; stty, instead.
4176 ;; Check whether the output of "uname -sr" has been changed. If
4177 ;; yes, this is a strong indication that we must expire all
4178 ;; connection properties. We start again with
4179 ;; `tramp-maybe-open-connection', it will be caught there.
4184 vec "uname"
4188 vec 3
4189 "Connection reset, because remote host changed from `%s' to `%s'"
4190 old-uname new-uname)
4191 ;; We want to keep the password.
4195 ;; Check whether the remote host suffers from buggy
4196 ;; `send-process-string'. This is known for FreeBSD (see comment in
4197 ;; `send_process', file process.c). I've tested sending 624 bytes
4198 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4199 ;; this host type is detected locally. It cannot handle remote
4200 ;; hosts, though.
4204 tramp-chunksize)
4212 ;; Set remote PATH variable.
4215 ;; Search for a good shell before searching for a command which
4216 ;; checks if a file exists. This is done because Tramp wants to use
4217 ;; "test foo; echo $?" to check if various conditions hold, and
4218 ;; there are buggy /bin/sh implementations which don't execute the
4219 ;; "echo $?" part if the "test" part has an error. In particular,
4220 ;; the OpenSolaris /bin/sh is a problem. There are also other
4221 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4222 ;; in function declarations, or changing HISTFILE in place.
4223 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4224 ;; detected.
4227 ;; Disable unexpected output.
4230 ;; IRIX64 bash expands "!" even when in single quotes. This
4231 ;; destroys our shell functions, we must disable it. See
4232 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4236 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4241 ;; Set `remote-tty' process property.
4246 ;; Dump stty settings in the traces.
4250 ;; Set the environment.
4255 unset vars item)
4265 vec
4267 tramp-end-of-heredoc
4269 tramp-end-of-heredoc)
4270 t))
4275 ;; Old text from documentation of tramp-methods:
4276 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4277 ;; of the base64 methods instead since base64 encoding is much more
4278 ;; reliable and the commands are more standardized between the different
4279 ;; Unix versions. But if you can't use base64 for some reason, please
4280 ;; note that the default uudecode command does not work well for some
4281 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4282 ;; the following command for uudecode:
4283 ;;
4284 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4285 ;;
4286 ;; For Irix, no solution is known yet.
4294 "List of local coding commands for inline transfer.
4295 Each item is a list that looks like this:
4297 \(FORMAT ENCODING DECODING\)
4299 FORMAT is symbol describing the encoding/decoding format. It can be
4300 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4302 ENCODING and DECODING can be strings, giving commands, or symbols,
4303 giving functions. If they are strings, then they can contain
4305 file name will be put into the command line at that spot. If the
4306 specifier is not present, the input should be read from standard
4307 input.
4309 If they are functions, they will be called with two arguments, start
4310 and end of region, and are expected to replace the region contents
4315 ;; "-i" is more robust with older base64 from GNU coreutils.
4316 ;; However, I don't know whether all base64 versions do supports
4317 ;; this option.
4324 ;; This is painful slow, so we put it on the end.
4331 "List of remote coding commands for inline transfer.
4332 Each item is a list that looks like this:
4334 \(FORMAT ENCODING DECODING [TEST]\)
4336 FORMAT is a symbol describing the encoding/decoding format. It can be
4337 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4339 ENCODING and DECODING can be strings, giving commands, or symbols,
4340 giving variables. If they are strings, then they can contain
4342 file name will be put into the command line at that spot. If the
4343 specifier is not present, the input should be read from standard
4344 input.
4346 If they are variables, this variable is a string containing a
4347 Perl or Shell implementation for this functionality. This
4348 program will be transferred to the remote host, and it is
4350 specifier in the variable value denotes a temporary file.
4352 The optional TEST command can be used for further tests, whether
4356 "Find an inline transfer encoding that works.
4357 Goes through the list `tramp-local-coding-commands' and
4358 `tramp-remote-coding-commands'."
4363 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4371 ;; If the local encoder or decoder is a string, the
4372 ;; corresponding command has to work locally.
4379 loc-enc nil nil))
4387 loc-dec nil nil))
4389 ;; Search for remote coding commands with the same format
4397 ;; Check the remote test command if exists.
4403 ;; Check if remote perl exists when necessary.
4408 ;; Check if remote encoding and decoding commands can be
4409 ;; called remotely with null input and output. This makes
4410 ;; sure there are no syntax errors and the command is really
4411 ;; found. Note that we do not redirect stdout to /dev/null,
4412 ;; for two reasons: when checking the decoding command, we
4413 ;; actually check the output it gives. And also, when
4414 ;; redirecting "mimencode" output to /dev/null, then as root
4415 ;; it might change the permissions of /dev/null!
4423 vec 5
4432 tmpfile)
4439 tramp-temp-name-prefix
4441 value
4443 value
4445 ?t
4451 vec 5
4454 vec
4456 t)
4464 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4470 ;; Set connection properties. Since the commands are risky
4471 ;; (due to output direction), we cache them in the process cache.
4482 "Call the local encoding or decoding command.
4484 Otherwise, INPUT is passed via standard input.
4485 INPUT can also be nil which means `/dev/null'.
4486 OUTPUT can be a string (which specifies a file name), or t (which
4487 means standard output and thus the current buffer), or nil (which
4488 means discard it)."
4490 nil tramp-encoding-shell
4493 nil
4494 tramp-encoding-command-switch
4504 "List of compress and decompress commands for inline transfer.
4505 Each item is a list that looks like this:
4507 \(COMPRESS DECOMPRESS\)
4512 "Find an inline transfer compress command that works.
4513 Goes through the list `tramp-inline-compress-commands'."
4518 item compress decompress found)
4525 vec 5
4526 "Checking local compress commands `%s', `%s' for sanity"
4527 compress decompress)
4532 ;; Windows shells need the program file name after
4533 ;; the pipe symbol be quoted if they use forward
4534 ;; slashes as directory separators.
4541 vec 5
4542 "Checking remote compress commands `%s', `%s' for sanity"
4543 compress decompress)
4549 ;; Did we find something?
4552 ;; Set connection properties. Since the commands are
4553 ;; risky (due to output direction), we cache them in the
4554 ;; process cache.
4568 "Expands VEC according to `tramp-default-proxies-alist'.
4569 Gateway hops are already opened."
4573 choices proxy)
4575 ;; Ad-hoc proxy definitions.
4580 tramp-prefix-format proxy tramp-postfix-host-format)))
4585 proxy)
4586 ;; Add the hop.
4588 'tramp-default-proxies-alist
4591 proxy))
4593 ;; Save the new value.
4598 ;; Look for proxy hosts to be passed.
4604 ;; Host.
4607 ;; User.
4611 ;; No more hops needed.
4613 ;; Replace placeholders.
4616 proxy
4621 ;; Add the hop.
4623 ;; Start next search.
4626 ;; Handle gateways.
4634 ;; Is the method prepared for gateways?
4637 vec 'file-error
4639 ;; Open the gateway connection.
4644 target-alist)
4645 ;; For the password prompt, we need the correct values.
4646 ;; Therefore, we must remember the gateway vector. But we
4647 ;; cannot do it as connection property, because it shouldn't
4648 ;; be persistent. And we have no started process yet either.
4652 ;; Foreign and out-of-band methods are not supported for multi-hops.
4659 vec 'file-error
4660 "Method `%s' is not supported for multi-hops."
4663 ;; In case the host name is not used for the remote shell
4664 ;; command, the user could be misguided by applying a random
4665 ;; host name.
4671 ;; There are multi-hops.
4673 ;; The host name is used for the remote shell command.
4675 ;; The host is local. We cannot use `tramp-local-host-p'
4676 ;; here, because it opens a connection as well.
4679 v 'file-error
4680 "Host `%s' looks like a remote host, `%s' can only use the local host"
4681 host method)))
4683 ;; Result.
4684 target-alist))
4687 "Return the Control* arguments of the local ssh."
4689 ;; No options to be computed.
4694 ;; There is already a value to be used.
4697 ;; Determine the options.
4709 ;; We use a non-existing IP address, in order to avoid
4710 ;; useless connections, and DNS timeouts.
4717 " -o ControlPath='tramp.%%r@%%h:%%p'"
4726 tramp-ssh-controlmaster-options)))
4729 "Maybe open a connection VEC.
4730 Does not do anything if a connection is already open, but re-opens the
4731 connection if a previous connection has died for some reason."
4739 ;; If Tramp opens the same connection within a short time frame,
4740 ;; there is a problem. We shall signal this.
4749 ;; If too much time has passed since last command was sent, look
4750 ;; whether process is still alive. If it isn't, kill it. When
4751 ;; using ssh, it can sometimes happen that the remote end has hung
4752 ;; up but the local ssh client doesn't recognize this until it
4753 ;; tries to send some data to the remote end. So that's why we
4754 ;; try to send a command from time to time, then look again
4755 ;; whether the process is really alive.
4766 ;; The error will be caught locally.
4772 ;; New connection must be opened.
4776 ;; If `non-essential' is non-nil, don't reopen a new connection.
4781 vec 3
4792 ;; Start new process.
4807 ;; We will apply `tramp-ssh-controlmaster-options'
4808 ;; only for the first hop.
4813 ;; This must be done in order to avoid our file
4814 ;; name handler.
4818 'start-process
4823 tramp-encoding-command-interactive)
4826 ;; Set sentinel and query flag.
4837 ;; Check whether process is alive.
4839 p 10
4842 ;; Now do all the connections as specified.
4868 ;; We don't create the temporary file. In
4869 ;; fact, it is just a prefix for the
4870 ;; ControlPath option of ssh; the real
4871 ;; temporary file has another name, and it is
4872 ;; created and protected by ssh. It is also
4873 ;; removed by ssh when the connection is
4874 ;; closed. The temporary file name is cached
4875 ;; in the main connection process, therefore
4876 ;; we cannot use `tramp-get-connection-process'.
4882 tramp-temp-name-prefix
4884 spec r-shell)
4886 ;; Add arguments for asynchronous processes.
4890 ;; Add gateway arguments if necessary.
4896 ;; Check for port number. Until now, there's no
4897 ;; need for handling like method, user, host.
4902 ;; Check, whether there is a restricted shell.
4907 ;; Set variables for computing the prompt for
4908 ;; reading password. They can also be derived
4909 ;; from a gateway.
4914 ;; Add login environment.
4917 login-env
4922 login-env))
4926 "%s=%s %s"
4929 command)))
4932 ;; Replace `login-args' place holders.
4940 ?h l-host ?u l-user ?p l-port ?c options)
4941 command
4943 ;; We do not want to see the trailing local
4944 ;; prompt in `start-file-process'.
4946 command " "
4952 ;; Local shell could be a Windows COMSPEC. It
4953 ;; doesn't know the ";" syntax, but we must exit
4954 ;; always for `start-file-process'. It could
4955 ;; also be a restricted shell, which does not
4956 ;; allow "exec".
4959 ;; Send the command.
4963 p vec pos tramp-actions-before-shell
4967 ;; Next hop.
4971 ;; Make initial shell settings.
4974 ;; When the user did interrupt, we must cleanup.
4977 ;; Propagate the quit signal.
4981 "Send the COMMAND to connection VEC.
4982 Erases temporary buffer before sending the command. If optional
4983 arg NEVEROPEN is non-nil, never try to open the connection. This
4984 is meant to be used from `tramp-maybe-open-connection' only. The
4985 function waits for output unless NOOUTPUT is set."
4989 ;; We mark the command string that it can be erased in the output buffer.
4991 ;; If we put `tramp-echo-mark' after a trailing newline (which
4992 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4993 ;; that newline and adds `tramp-rsh-end-of-line' right after
4994 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4995 ;; trailing line endings and sends two prompts after executing
4996 ;; the command, which confuses `tramp-wait-for-output'.
5000 ;; No need to restore a trailing newline here since `tramp-send-string'
5001 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
5003 ;; Send the command.
5009 "Wait for output from remote command."
5015 ;; be leading escape sequences, which must be ignored.
5017 ;; Sometimes, the commands do not return a newline but a
5018 ;; null byte before the shell prompt, for example "git
5019 ;; ls-files -c -z ...".
5024 ;; A simple-minded busybox has sent " ^H" sequences.
5025 ;; Delete them.
5030 ;; Delete the prompt.
5036 proc 'file-error
5037 "[[Remote prompt `%s' not found in %d secs]]"
5038 tramp-end-of-output timeout)
5040 proc 'file-error
5042 ;; Return value is whether end-of-output sentinel was found.
5043 found)))
5047 "Run COMMAND and check its exit status.
5048 Sends `echo $?' along with the COMMAND for checking the exit status.
5049 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
5050 status is 0, and nil otherwise.
5052 If the optional argument SUBSHELL is non-nil, the command is
5053 executed in a subshell, ie surrounded by parentheses. If
5054 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
5056 vec
5058 command
5060 "echo tramp_exit_status $?"
5074 "Run COMMAND, check exit status, throw error if exit status not okay.
5075 Similar to `tramp-send-command-and-check' but accepts two more arguments
5076 FMT and ARGS which are passed to `error'."
5081 "Run COMMAND and return the output, which must be a Lisp expression.
5082 If MARKER is a regexp, read the output after that string.
5083 In case there is no valid Lisp expression and NOERROR is nil, it
5084 raises an error."
5091 ;; Read the marker.
5097 vec 'file-error
5098 "`%s' does not return the marker `%s': `%s'"
5100 ;; Read the expression.
5103 ;; Error handling.
5108 vec 'file-error
5109 "`%s' does not return a valid Lisp expression: `%s'"
5113 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5114 Convert file mode bits to string and set virtual device number.
5115 Return ATTR."
5117 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5123 ;; Remove color escape sequences and double slashes from symlink.
5129 ;; Convert uid and gid. Use -1 as indication of unusable value.
5140 ;; Convert last access time.
5145 ;; Convert last modification time.
5150 ;; Convert last status change time.
5155 ;; Convert file size.
5161 ;; Convert file mode bits to string.
5166 ;; Convert directory indication bit.
5169 ;; Set file's gid change bit.
5177 ;; Convert inode.
5183 ;; Inodes can be incredible huge. We must hide this.
5185 ;; Set virtual device number.
5188 attr))
5191 "Converts STRING to shell glob pattern which ignores case."
5197 string
5201 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5212 localname)
5218 "Return t if this is an out-of-band method, nil otherwise."
5220 ;; It shall be an out-of-band method.
5222 ;; There must be a size, otherwise the file doesn't exist.
5224 ;; Either the file size is large enough, or (in rare cases) there
5225 ;; does not exist a remote encoding.
5230 ;; Variables local to connection.
5234 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5235 ;; cache the result for the session only. Otherwise, the result
5236 ;; is cached persistently.
5239 vec)
5240 "remote-path"
5249 ;; Default if "getconf" is not available.
5252 vec 3
5257 ;; The login shell could return more than just the $PATH
5258 ;; string. So we use `tramp-end-of-heredoc' as marker.
5261 vec
5266 'identity
5270 'identity
5276 ;; Replace place holder `tramp-default-remote-path'.
5284 ;; Replace place holder `tramp-own-remote-path'.
5292 ;; Remove double entries.
5299 ;; Remove non-existing directories.
5301 nil
5311 x))
5312 x))
5313 remote-path)))))
5319 locale)
5326 candidates nil)
5328 ;; Return value.
5338 result)
5340 ;; Check parameters. On busybox, "ls" output coloring is
5341 ;; enabled by default sometimes. So we try to disable it
5342 ;; when possible. $LS_COLORING is not supported there.
5343 ;; Some "ls" versions are sensible wrt the order of
5344 ;; arguments, they fail when "-al" is after the
5345 ;; "--color=never" argument (for example on FreeBSD).
5360 ;; Some "ls" versions are sensible wrt the order of arguments,
5361 ;; they fail when "-al" is after the "--dired" argument (for
5362 ;; example on FreeBSD).
5370 ;; Some "ls" versions are sensible wrt the order of arguments,
5371 ;; they fail when "-al" is after the "--dired" argument (for
5372 ;; example on FreeBSD).
5381 "test"
5385 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5386 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5387 ;; for otherwise the shell crashes.
5399 vec
5422 ;; We must check also for some Perl modules.
5430 result)))
5437 tmp)
5438 ;; Check whether stat(1) returns usable syntax. "%s" does not
5439 ;; work on older AIX systems.
5448 result)))
5458 result))))
5474 ;; Busyboxes do support the "-t" option only when they have been
5475 ;; built with the DESKTOP config option. Let's check it.
5478 vec "touch-t"
5480 vec
5482 "%s -t %s %s"
5483 result
5487 result)))
5506 result)
5508 ;; Check POSIX parameter.
5515 vec
5524 vec
5528 "print $>"
5540 vec
5544 "import os; print (os.getuid())"
5558 ;; Ensure there is a valid result.
5566 vec
5575 vec
5584 vec
5588 "import os; print (os.getgid())"
5602 ;; Ensure there is a valid result.
5608 ;; Some predefined connection properties.
5610 "Return the compress command related to PROP.
5611 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5612 the length of the file to be compressed.
5614 If no corresponding command is found, nil is returned."
5623 "Return the coding command related to PROP.
5624 PROP is either `remote-encoding', `remote-decoding',
5625 `local-encoding' or `local-decoding'.
5627 SIZE is the length of the file to be coded. Depending on SIZE,
5628 compression might be applied.
5630 If no corresponding command is found, nil is returned.
5631 Otherwise, either a string is returned which contains a `%s' mark
5632 to be used for the respective input or output file; or a Lisp
5633 function cell is returned to be applied on a buffer."
5634 ;; We must catch the errors, because we want to return nil, when
5635 ;; no inline coding is found.
5645 compress)
5646 ;; The connection property might have been cached. So we must
5647 ;; send the script to the remote side - maybe.
5655 ;; Check for the `compress' command.
5657 ;; Return the value.
5682 coding)
5685 ;; Windows shells need the program file name after
5686 ;; the pipe symbol be quoted if they use forward
5687 ;; slashes as directory separators.
5694 coding compress))
5697 ;; Windows shells need the program file name after
5698 ;; the pipe symbol be quoted if they use forward
5699 ;; slashes as directory separators.
5704 compress coding))
5718 ;;; TODO:
5720 ;; * Don't use globbing for directories with many files, as this is
5721 ;; likely to produce long command lines, and some shells choke on
5722 ;; long command lines.
5723 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5724 ;; then look if it's the right version (with `perl -v').
5725 ;; * When editing a remote CVS controlled file as a different user, VC
5726 ;; gets confused about the file locking status. Try to find out why
5727 ;; the workaround doesn't work.
5728 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5729 ;; until the last but one hop via `start-file-process'. Apply it
5730 ;; also for ftp and smb.
5731 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5732 ;; some shell with root privileges, it would be nice if I could
5733 ;; just call
5734 ;; trampclient filename.c
5735 ;; as an editor, and the _current_ shell would connect to an Emacs
5736 ;; server and would be used in an existing non-privileged Emacs
5737 ;; session for doing the editing in question.
5738 ;; That way, I need not tell Emacs my password again and be afraid
5739 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5740 ;; once display a just typed password in the context of a keyboard
5741 ;; sequence prompt for a question immediately following in a shell
5742 ;; script run within Emacs -- nasty).
5743 ;; And if I have some ssh session running to a different computer,
5744 ;; having the possibility of passing a local file there to a local
5745 ;; Emacs session (in case I can arrange for a connection back) would
5746 ;; be nice.
5747 ;; Likely the corresponding Tramp server should not allow the
5748 ;; equivalent of the emacsclient -eval option in order to make this
5749 ;; reasonably unproblematic. And maybe trampclient should have some
5750 ;; way of passing credentials, like by using an SSL socket or
5751 ;; something. (David Kastrup)
5752 ;; * Reconnect directly to a compliant shell without first going
5753 ;; through the user's default shell. (Pete Forman)
5754 ;; * How can I interrupt the remote process with a signal
5755 ;; (interrupt-process seems not to work)? (Markus Triska)
5756 ;; * Avoid the local shell entirely for starting remote processes. If
5757 ;; so, I think even a signal, when delivered directly to the local
5758 ;; SSH instance, would correctly be propagated to the remote process
5759 ;; automatically; possibly SSH would have to be started with
5760 ;; "-t". (Markus Triska)
5761 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5762 ;; isn't on the remote host. (Mark A. Hershberger)
5763 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5764 ;; * Optimize out-of-band copying when both methods are scp-like (not
5765 ;; rsync).
5766 ;; * Keep a second connection open for out-of-band methods like scp or
5767 ;; rsync.
5769 ;;; tramp-sh.el ends here