| blob | 20e32e9df6be576294f0dcc01976bf48b324ad7f |
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.
44 "The minimum size of compressing where inline transfer.
45 When inline transfer, compress transferred data of file
46 whose size is this value or above (up to `tramp-copy-size-limit').
47 If it is nil, no compression at all will be applied."
52 "The maximum file size where inline copying is preferred over an \
53 out-of-the-band copy.
54 If it is nil, out-of-the-band copy will be used without a check."
58 ;;;###tramp-autoload
60 "Value of TERM environment variable for logging in to remote host.
61 Because Tramp wants to parse the output of the remote shell, it is easily
62 confused by ANSI color escape sequences and suchlike. Often, shell init
63 files conditionalize this setup based on the TERM environment variable."
67 ;;;###tramp-autoload
69 "When invoking a shell, override the HISTFILE with this value.
70 By default, it is set to the symbol `unset', which unsets any
71 setting of HISTFILE. When setting to a string, it redirects the
72 shell history to that file. Be careful when setting to
76 If you set this variable to nil, however, the *override* is
77 disabled, so the history will go to the default storage
85 ;;;###tramp-autoload
89 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
90 ;; root users. It uses the `$' character for other users. In order
91 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
95 "///%s#$"
97 "String used to recognize end of output.
98 The '$' character at the end is quoted; the string cannot be
101 ;;;###tramp-autoload
108 ;; Initialize `tramp-methods' with the supported methods.
109 ;;;###tramp-autoload
120 ;;;###tramp-autoload
130 ;;;###tramp-autoload
147 ;;;###tramp-autoload
165 ;;;###tramp-autoload
180 ;;;###tramp-autoload
187 ;;;###tramp-autoload
194 ;;;###tramp-autoload
207 ;;;###tramp-autoload
220 ;;;###tramp-autoload
228 ;;;###tramp-autoload
236 ;; We use "-v" for better error tracking.
239 ;; We use "-p" as required for newer busyboxes. For older
240 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
241 ;; can be achieved by tweaking `tramp-connection-properties'.
244 ;;;###tramp-autoload
252 ;;;###tramp-autoload
257 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
262 ;;;###tramp-autoload
270 ;;;###tramp-autoload
277 ;;;###tramp-autoload
281 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
285 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
286 tramp-terminal-type
287 tramp-initial-end-of-output))
292 ;;;###tramp-autoload
298 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
299 tramp-terminal-type
300 tramp-initial-end-of-output))
304 ;;;###tramp-autoload
311 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
312 tramp-terminal-type
313 tramp-initial-end-of-output))
323 ;;;###tramp-autoload
330 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
331 tramp-terminal-type
332 tramp-initial-end-of-output))
341 ;;;###tramp-autoload
352 ;;;###tramp-autoload
356 ;;;###tramp-autoload
360 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
361 ;; Do not add "plink" based methods, they ask interactively for the user.
362 ;;;###tramp-autoload
371 ;;;###tramp-autoload
377 ;;;###tramp-autoload
393 ;;;###tramp-autoload
398 ;;;###tramp-autoload
403 ;;;###tramp-autoload
411 ;;;###tramp-autoload
438 ;; "getconf PATH" yields:
439 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
440 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
441 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
442 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
443 ;; IRIX64: /usr/bin
444 ;;;###tramp-autoload
450 "List of directories to search for executables on remote host.
451 For every remote host, this variable will be set buffer local,
452 keeping the list of existing directories on that host.
454 You can use `~' in this list, but when searching for a shell which groks
455 tilde expansion, all directory names starting with `~' will be ignored.
457 `Default Directories' represent the list of directories given by
459 entry on top of this list, because these are the default
460 directories for POSIX compatible commands. On remote hosts which
461 do not offer the getconf command (like cygwin), the value
464 `Private Directories' are the settings of the $PATH environment,
465 as given in your `~/.profile'."
472 ;;;###tramp-autoload
480 "List of environment variables to be set on the remote host.
482 Each element should be a string of the form ENVVARNAME=VALUE. An
483 entry ENVVARNAME= disables the corresponding environment variable,
484 which might have been set in the init files like ~/.profile.
486 Special handling is applied to the PATH environment, which should
487 not be set here. Instead, it should be set via `tramp-remote-path'."
493 "Alist specifying extra arguments to pass to the remote shell.
494 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
495 matching the shell file name and ARGS is a string specifying the
496 arguments.
498 This variable is only used when Tramp needs to start up another shell
499 for tilde expansion. The extra arguments should typically prevent the
500 shell from reading its init file."
502 ;; This might be the wrong way to test whether the widget type
503 ;; `alist' is available. Who knows the right way to test it?
518 "List of pattern/action pairs.
519 Whenever a pattern matches, the corresponding action is performed.
520 Each item looks like (PATTERN ACTION).
522 The PATTERN should be a symbol, a variable. The value of this
523 variable gives the regular expression to search for. Note that the
525 appended to it.
527 The ACTION should also be a symbol, but a function. When the
535 "List of pattern/action pairs.
536 This list is used for copying/renaming with out-of-band methods.
541 "(echo begin 600 %t; tail -n +2) | uudecode
542 cat %t
543 rm -f %t"
544 "Shell function to implement `uudecode' to standard output.
545 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
546 for this or `uudecode -p', but some systems don't, and for them
550 "%s -e '
551 use File::Spec;
554 sub recursive {
555 my ($volume, @dirs) = @_;
556 my $real = realpath(File::Spec->catpath(
558 if ($real) {
559 my ($vol, $dir) = File::Spec->splitpath($real, 1);
560 return ($vol, File::Spec->splitdir($dir));
561 }
562 else {
563 my $last = pop(@dirs);
564 ($volume, @dirs) = recursive($volume, @dirs);
565 push(@dirs, $last);
566 return ($volume, @dirs);
567 }
568 }
570 $result = realpath($ARGV[0]);
571 if (!$result) {
572 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
573 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
576 }
580 }
584 "Perl script to produce output suitable for use with `file-truename'
585 on the remote file system.
586 Escape sequence %s is replaced with name of Perl binary.
590 "%s -e 'sub case {
591 my $str = shift;
592 if ($ARGV[2]) {
593 return lc($str);
594 }
595 else {
596 return $str;
597 }
598 }
600 @files = readdir(d); closedir(d);
601 foreach $f (@files) {
602 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
605 }
606 else {
608 }
609 }
610 }
613 "Perl script to produce output suitable for use with
614 `file-name-all-completions' on the remote file system. Escape
615 sequence %s is replaced with name of Perl binary. This string is
618 ;; Perl script to implement `file-attributes' in a Lisp `read'able
619 ;; output. If you are hacking on this, note that you get *no* output
620 ;; unless this spits out a complete line, including the '\n' at the
621 ;; end.
622 ;; The device number is returned as "-1", because there will be a virtual
623 ;; device number set in `tramp-sh-handle-file-attributes'.
625 "%s -e '
626 @stat = lstat($ARGV[0]);
627 if (!@stat) {
629 exit 0;
630 }
631 if (($stat[2] & 0170000) == 0120000)
632 {
633 $type = readlink($ARGV[0]);
635 }
636 elsif (($stat[2] & 0170000) == 040000)
637 {
639 }
640 else
641 {
643 };
646 printf(
648 $type,
649 $stat[3],
650 $uid,
651 $gid,
652 $stat[8] >> 16 & 0xffff,
653 $stat[8] & 0xffff,
654 $stat[9] >> 16 & 0xffff,
655 $stat[9] & 0xffff,
656 $stat[10] >> 16 & 0xffff,
657 $stat[10] & 0xffff,
658 $stat[7],
659 $stat[2],
660 $stat[1] >> 16 & 0xffff,
661 $stat[1] & 0xffff
663 "Perl script to produce output suitable for use with `file-attributes'
664 on the remote file system.
665 Escape sequence %s is replaced with name of Perl binary.
669 "%s -e '
672 @list = readdir(DIR);
673 closedir(DIR);
674 $n = scalar(@list);
676 for($i = 0; $i < $n; $i++)
677 {
678 $filename = $list[$i];
679 @stat = lstat($filename);
680 if (($stat[2] & 0170000) == 0120000)
681 {
682 $type = readlink($filename);
684 }
685 elsif (($stat[2] & 0170000) == 040000)
686 {
688 }
689 else
690 {
692 };
695 printf(
696 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
697 $filename,
698 $type,
699 $stat[3],
700 $uid,
701 $gid,
702 $stat[8] >> 16 & 0xffff,
703 $stat[8] & 0xffff,
704 $stat[9] >> 16 & 0xffff,
705 $stat[9] & 0xffff,
706 $stat[10] >> 16 & 0xffff,
707 $stat[10] & 0xffff,
708 $stat[7],
709 $stat[2],
710 $stat[1] >> 16 & 0xffff,
711 $stat[1] & 0xffff,
712 $stat[0] >> 16 & 0xffff,
713 $stat[0] & 0xffff);
714 }
716 "Perl script implementing `directory-files-attributes' as Lisp `read'able
717 output.
718 Escape sequence %s is replaced with name of Perl binary.
721 ;; These two use base64 encoding.
723 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
724 "Perl program to use for encoding a file.
725 Escape sequence %s is replaced with name of Perl binary.
726 This string is passed to `format', so percent characters need to be doubled.
727 This implementation requires the MIME::Base64 Perl module to be installed
731 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
732 "Perl program to use for decoding a file.
733 Escape sequence %s is replaced with name of Perl binary.
734 This string is passed to `format', so percent characters need to be doubled.
735 This implementation requires the MIME::Base64 Perl module to be installed
739 "%s -e '
740 # This script contributed by Juanma Barranquero <lektu@terra.es>.
741 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
742 use strict;
744 my %%trans = do {
745 my $i = 0;
746 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
747 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
748 };
749 my $data;
751 # We read in chunks of 54 bytes, to generate output lines
752 # of 72 chars (plus end of line)
753 while (read STDIN, $data, 54) {
754 my $pad = q();
756 # Only for the last chunk, and only if did not fill the last three-byte packet
757 if (eof) {
758 my $mod = length($data) %% 3;
759 $pad = q(=) x (3 - $mod) if $mod;
760 }
762 # Not the fastest method, but it is simple: unpack to binary string, split
763 # by groups of 6 bits and convert back from binary to byte; then map into
764 # the translation table
765 print
766 join q(),
767 map($trans{$_},
768 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
769 $pad,
771 }' 2>/dev/null"
772 "Perl program to use for encoding a file.
773 Escape sequence %s is replaced with name of Perl binary.
777 "%s -e '
778 # This script contributed by Juanma Barranquero <lektu@terra.es>.
779 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
780 use strict;
782 my %%trans = do {
783 my $i = 0;
784 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
785 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
786 };
788 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
792 # We are going to accumulate into $pending to accept any line length
793 # (we do not check they are <= 76 chars as the RFC says)
794 my $pending = q();
796 while (my $data = <STDIN>) {
797 chomp $data;
799 # If we find one or two =, we have reached the end and
800 # any following data is to be discarded
801 my $finished = $data =~ s/(==?).*/$1/;
802 $pending .= $data;
804 my $len = length($pending);
805 my $chunk = substr($pending, 0, $len & ~3);
806 $pending = substr($pending, $len & ~3 + 1);
808 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
809 # split in 8-bit chunks and convert back to char.
810 print join q(),
811 map $bytes{$_},
812 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
814 last if $finished;
815 }' 2>/dev/null"
816 "Perl program to use for decoding a file.
817 Escape sequence %s is replaced with name of Perl binary.
821 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
822 "Perl program to use for encoding a file.
826 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
827 "Perl program to use for decoding a file.
832 while read file; do
835 else
837 fi
840 else
842 fi
843 done
845 "Script to check existence of VC related files.
846 It must be send formatted with two strings; the tests for file
847 existence, and file readability. Input shall be read via
848 here-document, otherwise the command could exceed maximum length
851 ;; New handlers should be added here.
855 ;; `byte-compiler-base-file-name' performed by default handler.
860 ;; `diff-latest-backup-file' performed by default handler.
864 . tramp-sh-handle-directory-files-and-attributes)
865 ;; `dired-call-process' performed by default handler.
868 . tramp-sh-handle-dired-recursive-delete-directory)
875 ;; `file-equal-p' performed by default handler.
878 ;; `file-in-directory-p' performed by default handler.
886 ;; `file-name-sans-versions' performed by default handler.
899 ;; `find-file-noselect' performed by default handler.
900 ;; `get-file-buffer' performed by default handler.
904 . tramp-sh-handle-insert-file-contents-literally)
923 "Alist of handler functions.
926 ;; This must be the last entry, because `identity' always matches.
927 ;;;###tramp-autoload
931 ;;; File Name Handler Functions:
935 "Like `make-symbolic-link' for Tramp files.
936 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
937 the symlink. If LINKNAME is a Tramp file, only the localname component is
938 used as the target of the symlink.
940 If LINKNAME is a Tramp file and the localname component is relative, then
941 it is expanded first, before the localname component is taken. Note that
942 this can give surprising results if the user/host for the source and
943 target of the symlink differ."
950 l 'file-error
953 ;; Do the 'confirm if exists' thing.
955 ;; What to do?
960 "File %s already exists; make it a link anyway? "
961 l-localname)))))
966 ;; If FILENAME is a Tramp name, use just the localname component.
975 ;; Right, they are on the same host, regardless of user, method,
976 ;; etc. We now make the link on the remote machine. This will
977 ;; occur as the user that FILENAME belongs to.
979 l
981 "cd %s && %s -sf %s %s"
983 ln
986 t))))
989 "Like `file-truename' for Tramp files."
991 "%s%s"
994 method user host
999 ;; Use GNU readlink --canonicalize-missing where available.
1002 v
1010 ;; Use Perl implementation.
1018 v
1022 ;; Do it yourself. We bind `directory-sep-char' here for
1023 ;; XEmacs on Windows, which would otherwise use backslash.
1031 ;; Don't make the following value larger than
1032 ;; necessary. People expect an error message in
1033 ;; a timely fashion when something is wrong;
1034 ;; otherwise they might think that Emacs is hung.
1035 ;; Of course, correctness has to come first.
1037 symlink-target)
1048 method user host
1060 ;; It's a symlink, follow it.
1066 ;; If the symlink was absolute, we'll get a
1067 ;; string like "/user@host:/some/target";
1068 ;; extract the "/some/target" part from it.
1072 v 'file-error
1073 "Symlink target `%s' on wrong host"
1074 symlink-target))
1079 steps)))
1081 ;; It's a file.
1085 v 'file-error
1088 ;; Combine list to form string.
1099 result))))
1101 ;; Preserve trailing "/".
1104 ;; Basic functions.
1107 "Like `file-exists-p' for Tramp files."
1115 v
1117 "%s %s"
1122 "Like `file-attributes' for Tramp files."
1125 ;; Don't modify `last-coding-system-used' by accident.
1132 v
1140 ;; The scripts could fail, for example with huge file size.
1144 "Implement `file-attributes' for Tramp files using the ls(1) command."
1146 res-inode res-filemodes res-numlinks
1147 res-uid res-gid res-size res-symlink-target)
1150 vec
1159 ;; parse `ls -l' output ...
1163 ;; ... inode
1179 ;; ... file mode flags
1181 ;; ... number links
1183 ;; ... uid and gid
1193 ;; ... size
1195 ;; From the file modes, figure out other stuff.
1198 ;; if symlink, find out file name pointed to
1202 ;; return data gathered
1204 ;; 0. t for directory, string (name linked to) for symbolic
1205 ;; link, or nil.
1207 ;; 1. Number of links to file.
1208 res-numlinks
1209 ;; 2. File uid.
1210 res-uid
1211 ;; 3. File gid.
1212 res-gid
1213 ;; 4. Last access time, as a list of integers. Normally this
1214 ;; would be in the same format as `current-time', but the
1215 ;; subseconds part is not currently implemented, and (0 0)
1216 ;; denotes an unknown time.
1217 ;; 5. Last modification time, likewise.
1218 ;; 6. Last status change time, likewise.
1220 ;; 7. Size in bytes (-1, if number is out of range).
1221 res-size
1222 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1223 res-filemodes
1224 ;; 9. t if file's gid would change if file were deleted and
1225 ;; recreated. Will be set in `tramp-convert-file-attributes'
1226 t
1227 ;; 10. inode number.
1228 res-inode
1229 ;; 11. Device number. Will be replaced by a virtual device number.
1230 -1
1231 )))))
1235 "Implement `file-attributes' for Tramp files using a Perl script."
1240 vec
1246 "Implement `file-attributes' for Tramp files using stat(1) command."
1249 vec
1251 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1252 ;; parse correctly the sequence "((". Therefore, we add a space.
1253 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1264 "Like `set-visited-file-modtime' for Tramp files."
1271 coding-system-used)
1275 ;; '(-1 65535) means file doesn't exists yet.
1279 ;; We use '(0 0) as a don't-know value. See also
1280 ;; `tramp-do-file-attributes-with-ls'.
1285 v
1294 nil)))))
1296 ;; This function makes the same assumption as
1297 ;; `tramp-sh-handle-set-visited-file-modtime'.
1299 "Like `verify-visited-file-modtime' for Tramp files.
1300 At the time `verify-visited-file-modtime' calls this function, we
1301 already know that the buffer is visiting a file and that
1302 `visited-file-modtime' does not return 0. Do not call this
1303 function directly, unless those two cases are already taken care
1304 of."
1307 ;; There is no file visiting the buffer, or the buffer has no
1308 ;; recorded last modification time, or there is no established
1309 ;; connection.
1313 t
1321 ;; File exists, and has a known modtime.
1324 modtime
1325 ;; For compatibility, deal with both the old
1326 ;; (HIGH . LOW) and the new (HIGH LOW) return
1327 ;; values of `visited-file-modtime'.
1330 mt)))
1332 ;; Modtime has the don't know value.
1335 v
1342 attr
1345 ;; If file does not exist, say it is not modified if and
1346 ;; only if that agrees with the buffer's record.
1350 "Like `set-file-modes' for Tramp files."
1353 ;; FIXME: extract the proper text from chmod's stderr.
1355 v
1362 "Like `set-file-times' for Tramp files."
1369 time))
1370 ;; With GNU Emacs, `format-time-string' has an
1371 ;; optional parameter UNIVERSAL. This is preferred,
1372 ;; because we could handle the case when the remote
1373 ;; host is located in a different time zone as the
1374 ;; local host.
1378 "%s %s %s %s"
1389 ;; We handle also the local part, because in older Emacsen,
1390 ;; without `set-file-times', this function is an alias for this.
1391 ;; We are local, so we don't need the UTC settings.
1399 "Set the ownership for FILENAME.
1400 If UID and GID are provided, these values are used; otherwise uid
1401 and gid of the corresponding user is taken. Both parameters must
1402 be non-negative integers."
1403 ;; Modern Unices allow chown only for root. So we might need
1404 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1405 ;; working with su(do)? when it is needed, so it shall succeed in
1406 ;; the majority of cases.
1407 ;; Don't modify `last-coding-system-used' by accident.
1412 ;; If we are root on the local host, we can do it directly.
1420 "chown %d:%d %s" uid gid
1423 ;; We handle also the local part, because there doesn't exist
1424 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1428 nil "chown" nil nil nil
1432 "Check, whether SELINUX is enabled on the remote host."
1444 "Like `file-selinux-context' for Tramp files."
1453 "%s -d -Z %s"
1461 ;; Return the context.
1462 context))))
1465 "Like `set-file-selinux-context' for Tramp files."
1482 t)
1484 nil)))
1487 "Check, whether ACL is enabled on the remote host."
1492 "Like `file-acl' for Tramp files."
1498 "getfacl -ac %s 2>/dev/null"
1508 "Like `set-file-acl' for Tramp files."
1515 tramp-end-of-heredoc
1516 acl-string
1517 tramp-end-of-heredoc))
1519 ;; Success.
1522 t)
1523 ;; In case of errors, we return `nil'.
1525 nil)))
1527 ;; Simple functions using the `test' command.
1530 "Like `file-executable-p' for Tramp files."
1533 ;; Examine `file-attributes' cache to see if request can be
1534 ;; satisfied without remote operation.
1539 "Like `file-readable-p' for Tramp files."
1542 ;; Examine `file-attributes' cache to see if request can be
1543 ;; satisfied without remote operation.
1547 ;; When the remote shell is started, it looks for a shell which groks
1548 ;; tilde expansion. Here, we assume that all shells which grok tilde
1549 ;; expansion will also provide a `test' command which groks `-nt' (for
1550 ;; newer than). If this breaks, tell me about it and I'll try to do
1551 ;; something smarter about it.
1553 "Like `file-newer-than-file-p' for Tramp files."
1555 nil)
1557 t)
1558 ;; We are sure both files exist at this point.
1561 ;; We try to get the mtime of both files. If they are not
1562 ;; equal to the "dont-know" value, then we subtract the times
1563 ;; and obtain the result.
1569 ;; If one of them is the dont-know value, then we can
1570 ;; still try to run a shell command on the remote host.
1571 ;; However, this only works if both files are Tramp
1572 ;; files and both have the same method, same user, same
1573 ;; host.
1578 v 'file-error
1579 "Files %s and %s must have same method, user, host"
1580 file1 file2)))
1585 ;; Functions implemented using the basic functions above.
1588 "Like `file-directory-p' for Tramp files."
1590 ;; `file-directory-p' is used as predicate for file name completion.
1591 ;; Sometimes, when a connection is not established yet, it is
1592 ;; desirable to return t immediately for "/method:foo:". It can
1593 ;; be expected that this is always a directory.
1599 "Like `file-writable-p' for Tramp files."
1603 ;; Examine `file-attributes' cache to see if request can be
1604 ;; satisfied without remote operation.
1607 ;; If file doesn't exist, check if directory is writable.
1612 "Like `file-ownership-preserved-p' for Tramp files."
1616 ;; Return t if the file doesn't exist, since it's true that no
1617 ;; information would be lost by an (attempted) delete and create.
1624 ;; Directory listings.
1628 "Like `directory-files-and-attributes' for Tramp files."
1632 directory full match nosort id-format)
1634 ;; Do it directly.
1642 v localname
1652 v localname id-format))
1655 v localname id-format)))))))))
1656 result item)
1666 result
1671 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1674 vec tramp-perl-directory-files-and-attributes
1678 vec
1682 object))
1686 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1689 vec
1692 ;; We must care about file names with spaces, or starting with
1693 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1694 ;; but it does not work on all remote systems. Therefore, we
1695 ;; quote the file names via sed.
1697 "xargs %s -c "
1706 ;; This function should return "foo/" for directories and "bar" for
1707 ;; files.
1709 "Like `file-name-all-completions' for Tramp files."
1714 filename
1716 'list
1718 ;; Try cache entries for `filename', `filename' with last
1719 ;; character removed, `filename' with last two characters
1720 ;; removed, ..., and finally the empty string - all
1721 ;; concatenated to the local directory name.
1724 tramp-completion-reread-directory-timeout)))
1726 ;; This is inefficient for very long file names, pity
1727 ;; `reduce' is not available...
1730 'append
1735 v
1737 "file-name-all-completions"
1738 nil)))
1740 ;; We cannot use a length of 0, because file properties
1741 ;; for "foo" and "foo/" are identical.
1744 ;; Cache expired or no matching cache entry found so we need
1745 ;; to perform a remote operation.
1747 ;; Get a list of directories and files, including reliably
1748 ;; tagging the directories with a trailing '/'. Because I
1749 ;; rock. --daniel@danann.net
1751 ;; Changed to perform `cd' in the same remote op and only
1752 ;; get entries starting with `filename'. Capture any `cd'
1753 ;; error messages. Ensure any `cd' and `echo' aliases are
1754 ;; ignored.
1756 v
1760 v tramp-perl-file-name-all-completions
1766 ;; `read-file-name-completion-ignore-case'
1767 ;; is introduced with Emacs 22.1.
1770 'read-file-name-completion-ignore-case
1776 ;; `ls' with wildcard might fail with `Argument
1777 ;; list too long' error in some corner cases; if
1778 ;; `ls' fails after `cd' succeeded, chances are
1779 ;; that's the case, so let's retry without
1780 ;; wildcard. This will return "too many" entries
1781 ;; but that isn't harmful.
1782 " || %s -a 2>/dev/null)"
1783 " | while IFS= read f; do"
1789 ;; When `filename' is empty, just `ls' without
1790 ;; `filename' argument is more efficient than `ls *'
1791 ;; for very large directories and might avoid the
1792 ;; `Argument list too long' error.
1793 ;;
1794 ;; With and only with wildcard, we need to add
1795 ;; `-d' to prevent `ls' from descending into
1796 ;; sub-directories.
1798 "."
1803 ;; Now grab the output.
1807 ;; Check result code, found in last line of output.
1811 ;; Grab error message from line before last line
1812 ;; (it was put there by `cd 2>&1').
1815 v 'file-error
1816 "tramp-sh-handle-file-name-all-completions: %s"
1818 ;; For peace of mind, if buffer doesn't end in `fail'
1819 ;; then it should end in `ok'. If neither are in the
1820 ;; buffer something went seriously wrong on the remote
1821 ;; side.
1824 v 'file-error
1825 "\
1826 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1832 ;; Because the remote op went through OK we know the
1833 ;; directory we `cd'-ed to exists.
1836 ;; Because the remote op went through OK we know every
1837 ;; file listed by `ls' exists.
1841 result)
1843 ;; Store result in the cache.
1848 ;; cp, mv and ln
1852 "Like `add-name-to-file' for Tramp files."
1857 v 'file-error
1858 "add-name-to-file: %s"
1867 "File %s already exists; make it a new name anyway? "
1868 newname)))
1875 v1
1879 "error with add-name-to-file, see buffer `%s' for details"
1884 preserve-uid-gid preserve-extended-attributes)
1885 "Like `copy-file' for Tramp files."
1889 ;; At least one file a Tramp file?
1893 'copy filename newname ok-if-already-exists keep-date
1894 preserve-uid-gid preserve-extended-attributes))
1895 ;; Compat section.
1898 'copy-file
1900 preserve-uid-gid preserve-extended-attributes)))
1903 'copy-file
1911 "Like `copy-directory' for Tramp files."
1917 ;; When DIRNAME and NEWNAME are remote, they must have
1918 ;; the same method.
1924 ;; scp or rsync DTRT.
1938 ;; We must do it file-wise.
1940 'copy-directory
1945 ;; When newname did exist, we have wrong cached values.
1953 "Like `rename-file' for Tramp files."
1954 ;; Check if both files are local -- invoke normal rename-file.
1955 ;; Otherwise, use Tramp from local system.
1958 ;; At least one file a Tramp file?
1968 preserve-uid-gid preserve-extended-attributes)
1969 "Copy or rename a remote file.
1970 OP must be `copy' or `rename' and indicates the operation to perform.
1971 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1972 the new file (for copy) or the new name of the file (for rename).
1973 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1974 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1975 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1976 the uid and gid if both files are on the same host.
1977 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1979 This function is invoked by `tramp-sh-handle-copy-file' and
1980 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1981 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1982 file names."
1999 filename newname)
2002 ;; Both are Tramp files.
2007 ;; Shortcut: if method, host, user are the same for
2008 ;; both files, we invoke `cp' or `mv' on the remote
2009 ;; host directly.
2012 op filename newname
2013 ok-if-already-exists keep-date preserve-uid-gid))
2015 ;; Try out-of-band operation.
2020 op filename newname keep-date))
2022 ;; No shortcut was possible. So we copy the file
2023 ;; first. If the operation was `rename', we go back
2024 ;; and delete the original file (if the copy was
2025 ;; successful). The approach is simple-minded: we
2026 ;; create a new buffer, insert the contents of the
2027 ;; source file into it, then write out the buffer to
2028 ;; the target file. The advantage is that it doesn't
2029 ;; matter which file name handlers are used for the
2030 ;; source and target file.
2033 op filename newname keep-date))))))
2035 ;; One file is a Tramp file, the other one is local.
2038 ;; Fast track on local machine.
2041 op filename newname
2042 ok-if-already-exists keep-date preserve-uid-gid))
2044 ;; If the Tramp file has an out-of-band method, the
2045 ;; corresponding copy-program can be invoked.
2048 op filename newname keep-date))
2050 ;; Use the inline method via a Tramp buffer.
2052 op filename newname keep-date))))
2055 ;; One of them must be a Tramp file.
2058 ;; Handle `preserve-extended-attributes'. We ignore possible
2059 ;; errors, because ACL strings could be incompatible.
2064 ;; In case of `rename', we must flush the cache of the source file.
2070 ;; When newname did exist, we have wrong cached values.
2077 "Use an Emacs buffer to copy or rename a file.
2078 First arg OP is either `copy' or `rename' and indicates the operation.
2079 FILENAME is the source file, NEWNAME the target file.
2080 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2082 ;; We must disable multibyte, because binary data shall not be
2083 ;; converted. We remove `tramp-file-name-handler' from
2084 ;; `inhibit-file-name-handlers'; otherwise the file name handler
2085 ;; for `insert-file-contents' might be deactivated in some corner
2086 ;; cases.
2093 ;; We don't want the target file to be compressed, so we let-bind
2094 ;; `jka-compr-inhibit' to t.
2098 ;; KEEP-DATE handling.
2100 ;; Set the mode.
2102 ;; If the operation was `rename', delete the original file.
2107 "Invokes `cp' or `mv' on the remote system.
2108 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2109 respectively. FILENAME specifies the file to copy or rename,
2110 NEWNAME is the name of the new file (for copy) or the new name of
2111 the file (for rename). Both files must reside on the same host.
2112 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2113 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2114 the uid and gid from FILENAME."
2124 v 'file-error
2125 "Unknown operation `%s', must be `copy' or `rename'"
2126 op))))
2130 filename))
2134 newname))
2136 cmd-result)
2139 ;; Both files are on a remote host, with same user.
2151 ;; Mask cp -f error.
2153 tramp-operation-not-permitted-regexp nil t))
2154 cmd-result)
2156 nil v 'file-error
2157 "Copying directly failed, see buffer `%s' for details."
2160 ;; We are on the local host.
2163 ;; We can do it directly.
2166 ;; No sticky bit when renaming.
2177 localname1 localname2 ok-if-already-exists
2178 keep-date preserve-uid-gid)
2182 ;; We can do it directly with `tramp-send-command'
2190 ok-if-already-exists keep-date t)
2191 ;; We must change the ownership to the local user.
2197 ;; We need a temporary file in between.
2199 ;; Create the temporary file.
2207 "%s %s %s" cmd
2210 "Copying directly failed, see buffer `%s' for details."
2212 ;; We must change the ownership as remote user.
2213 ;; Since this does not work reliable, we also
2214 ;; give read permissions.
2225 localname1 tmpfile t
2226 keep-date preserve-uid-gid)
2228 'rename-file
2230 ;; We must change the ownership as local user.
2231 ;; Since this does not work reliable, we also
2232 ;; give read permissions.
2236 tmpfile
2240 ;; Move the temporary file to its destination.
2245 "cp -f -p %s %s"
2248 "Copying directly failed, see buffer `%s' for details."
2252 'rename-file
2255 ;; Save exit.
2258 ;; Set the time and mode. Mask possible errors.
2265 "Invoke `scp' program to copy.
2266 The method used must be an out-of-band method."
2270 copy-program copy-args copy-env copy-keep-date port listener spec
2271 options source target remote-copy-program remote-copy-args)
2276 ;; Both are Tramp files. We shall optimize it when the
2277 ;; methods for FILENAME and NEWNAME are the same.
2287 op filename tmpfile keep-date)
2290 ;; Save exit.
2297 ;; Set variables for computing the prompt for reading
2298 ;; password.
2305 ;; Expand hops. Might be necessary for gateway methods.
2309 ;; Check which ones of source and target are Tramp files.
2318 'file-name-directory
2324 ;; Check for host and port number. We cannot use
2325 ;; `tramp-file-name-port', because this returns also
2326 ;; `tramp-default-port', which might clash with settings in
2327 ;; "~/.ssh/config".
2334 ;; Check for user. There might be an interactive setting.
2338 ;; Check for listener port.
2345 ;; Compose copy command.
2355 spec)
2357 ?h host ?u user ?p port ?r listener ?c options
2364 copy-args
2366 ;; " " has either been a replacement of "%k" (when
2367 ;; keep-date argument is non-nil), or a replacement
2368 ;; for the whole keep-date sublist.
2369 " "
2373 copy-args)
2376 copy-args
2380 copy-env
2382 nil
2389 remote-copy-program
2399 remote-copy-args
2403 ;; Check for local copy program.
2408 ;; Install listener on the remote side. The prompt must be
2409 ;; consumed later on, when the process does not listen anymore.
2416 v 'file-error
2420 'identity
2428 v 'file-error
2429 "Listener process not running on remote host: `%s'"
2430 remote-copy-program))
2438 ;; The default directory must be remote.
2442 ;; Set the transfer process properties.
2452 copy-args
2454 copy-args
2459 ;; Use an asynchronous process. By this, password can
2460 ;; be handled. We don't set a timeout, because the
2461 ;; copying of large files can last longer than 60
2462 ;; secs.
2466 copy-program
2468 copy-args
2477 ;; We must adapt `tramp-local-end-of-line' for
2478 ;; sending the password.
2481 p v nil tramp-actions-copy-out-of-band))
2483 ;; Check the return code.
2488 orig-vec 'file-error
2489 "Couldn't find exit status of `%s'"
2495 orig-vec 'file-error
2496 "Error copying: `%s'"
2499 ;; Reset the transfer process properties.
2502 ;; Clear the remote prompt.
2505 ;; Houston, we have a problem! Likely, the listener is
2506 ;; still running, so let's clear everything (but the
2507 ;; cached password).
2510 ;; Handle KEEP-DATE argument.
2514 ;; Set the mode.
2519 ;; If the operation was `rename', delete the original file.
2526 "Like `make-directory' for Tramp files."
2538 "Like `delete-directory' for Tramp files."
2550 "Like `delete-file' for Tramp files."
2561 ;; Dired.
2563 ;; CCC: This does not seem to be enough. Something dies when
2564 ;; we try and delete two directories under Tramp :/
2566 "Recursively delete the directory given.
2567 This is like `dired-recursive-delete-directory' for Tramp files."
2569 ;; Run a shell command 'rm -r <localname>'.
2570 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2573 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2575 v
2577 ;; Don't read the output, do it explicitly.
2578 nil t)
2579 ;; Wait for the remote system to return to us...
2580 ;; This might take a while, allow it plenty of time.
2582 ;; Make sure that it worked...
2590 "Like `dired-compress-file' for Tramp files."
2591 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2592 ;; Code stolen mainly from dired-aux.el.
2598 ;; Emacs case
2600 ;; XEmacs has `dired-compression-method-alist', which is
2601 ;; transformed into `dired-compress-file-suffixes' structure.
2605 nil
2608 suffix)
2609 ;; See if any suffix rule matches this file name.
2617 nil)
2619 ;; We found an uncompression rule.
2625 ;; `dired-remove-file' is not defined in XEmacs.
2630 ;; We don't recognize the file as compressed, so compress it.
2631 ;; Try gzip.
2636 ;; `dired-remove-file' is not defined in XEmacs.
2646 "Like `insert-directory' for Tramp files."
2653 filename switches wildcard full-directory-p)
2673 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2674 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2677 v
2680 switches
2682 localname
2685 v
2689 "Couldn't `cd %s'"
2693 v
2696 switches
2701 ""
2709 ;; We cannot use `insert-buffer-substring' because the Tramp
2710 ;; buffer changes its contents before insertion due to calling
2711 ;; `expand-file' and alike.
2716 ;; Check for "--dired" output.
2723 ;; Now read the numeric positions of file names.
2729 ;; End is followed by \n or by " -> ".
2731 ;; Remove trailing lines.
2737 ;; Some busyboxes are reluctant to discard colors.
2744 ;; Decode the output, it could be multibyte.
2751 ;; The inserted file could be from somewhere else.
2758 "."
2765 ;; Canonicalization of file names.
2768 "Like `expand-file-name' for Tramp files.
2770 the result will be a local, non-Tramp, file name."
2771 ;; If DIR is not given, use `default-directory' or "/".
2773 ;; Unless NAME is absolute, concat DIR and NAME.
2776 ;; If NAME is not a Tramp file, run the real handler.
2779 ;; Dissect NAME.
2783 ;; Tilde expansion if necessary. This needs a shell which
2784 ;; groks tilde expansion! The function `tramp-find-shell' is
2785 ;; supposed to find such a shell on the remote host. Please
2786 ;; tell me about it when this doesn't work on your system.
2790 ;; We cannot simply apply "~/", because under sudo "~/" is
2791 ;; expanded to the local user home directory but to the
2792 ;; root home directory. On the other hand, using always
2793 ;; the default user name for tilde expansion is not
2794 ;; appropriate either, because ssh and companions might
2795 ;; use a user name from the config file.
2807 ;; There might be a double slash, for example when "~/"
2808 ;; expands to "/". Remove this.
2811 ;; No tilde characters in file name, do normal
2812 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2813 ;; `directory-sep-char' here for XEmacs on Windows, which would
2814 ;; otherwise use backslash. `default-directory' is bound,
2815 ;; because on Windows there would be problems with UNC shares or
2816 ;; Cygwin mounts.
2820 method user host
2824 hop)))))
2826 ;;; Remote commands:
2829 "Flush file caches."
2837 ;; We use BUFFER also as connection buffer during setup. Because of
2838 ;; this, its original contents must be saved, and restored once
2839 ;; connection has been setup.
2841 "Like `start-file-process' for Tramp files."
2844 ;; it might be that the arguments exceed the command line
2845 ;; length. Therefore, we modify the command.
2850 ;; When PROGRAM is nil, we just provide a tty.
2856 args
2860 ;; Use a human-friendly prompt, for example for `shell'.
2864 tramp-initial-end-of-output)))
2865 ;; We use as environment the difference to toplevel
2866 ;; `process-environment'.
2867 env
2872 env)
2891 ;; We do not want to raise an error when
2892 ;; `start-file-process' has been started several times in
2893 ;; `eshell' and friends.
2897 ;; BUFFER can be nil. We use a temporary buffer.
2900 ;; NAME must be unique as process name.
2904 ;; Set the new process properties.
2910 ;; We catch this event. Otherwise, `start-process' could
2911 ;; be called on the local host.
2914 ;; Activate narrowing in order to save BUFFER
2915 ;; contents. Clear also the modification time;
2916 ;; otherwise we might be interrupted by
2917 ;; `verify-visited-file-modtime'.
2923 ;; We call `tramp-maybe-open-connection', in order
2924 ;; to cleanup the prompt afterwards.
2930 ;; Now do it.
2932 ;; Send the command.
2934 ;; Check, whether a pty is associated.
2938 v 'file-error
2941 ;; Set query flag and process marker for this
2942 ;; process. We ignore errors, because the process
2943 ;; could have finished already.
2947 ;; Return process.
2948 p))))
2950 ;; Save exit.
2961 "Like `process-file' for Tramp files."
2962 ;; The implementation is not complete yet.
2968 ;; Compute command.
2971 ;; We use as environment the difference to toplevel `process-environment'.
2979 "env %s %s"
2981 ;; Determine input.
2986 ;; INFILE is on the same remote host.
2988 ;; INFILE must be copied to remote host.
2994 ;; Determine output.
2996 ;; Just a buffer.
2999 ;; A buffer name.
3002 ;; (REAL-DESTINATION ERROR-DESTINATION)
3004 ;; output.
3012 ;; stderr.
3017 ;; stderr is on the same remote host.
3020 ;; stderr must be copied to remote host. The temporary
3021 ;; file must be deleted after execution.
3024 method user host stderr))))
3025 ;; stderr to be discarded.
3028 ;; 't
3033 ;; Send the command. It might not return in time, so we protect
3034 ;; it. Call it in a subshell, in order to preserve working
3035 ;; directory.
3042 command)
3043 t t)
3045 ;; We should add the output anyway.
3052 ;; When the user did interrupt, we should do it also. We use
3053 ;; return code -1 as marker.
3057 ;; Handle errors.
3062 ;; Provide error file.
3065 ;; Cleanup. We remove all file cache values for the connection,
3066 ;; because the remote process could have changed them.
3069 ;; `process-file-side-effects' has been introduced with GNU
3070 ;; Emacs 23.2. If set to `nil', no remote file will be changed
3071 ;; by `program'. If it doesn't exist, we assume its default
3072 ;; value `t'.
3077 ;; Return exit status.
3080 ret))))
3083 "Like `file-local-copy' for Tramp files."
3087 v 'file-error
3097 ;; `copy-file' handles direct copy and out-of-band methods.
3102 ;; Use inline encoding for file transfer.
3106 v 3
3114 tmpfile loc-dec)
3116 ;; If local decoding is a function, we call it.
3117 ;; We must disable multibyte, because
3118 ;; `uudecode-decode-region' doesn't handle it
3119 ;; correctly.
3124 ;; Unset `file-name-handler-alist'. Otherwise,
3125 ;; epa-file gets confused.
3131 ;; If tramp-decoding-function is not defined for this
3132 ;; method, we invoke tramp-decoding-command instead.
3134 ;; Unset `file-name-handler-alist'. Otherwise,
3135 ;; epa-file gets confused.
3143 loc-dec tmpfile2 tmpfile)
3146 ;; Set proper permissions.
3148 ;; Set local user ownership.
3151 ;; Oops, I don't know what to do.
3155 ;; Error handling.
3161 tmpfile)))
3163 ;; This is needed for XEmacs only. Code stolen from files.el.
3166 "Like `insert-file-contents-literally' for Tramp files."
3174 nil))
3181 ;; Save exit.
3186 ;; CCC grok LOCKNAME
3189 "Like `write-region' for Tramp files."
3192 ;; Following part commented out because we don't know what to do about
3193 ;; file locking, and it does not appear to be a problem to ignore it.
3194 ;; Ange-ftp ignores it, too.
3195 ;; (when (and lockname (stringp lockname))
3196 ;; (setq lockname (expand-file-name lockname)))
3197 ;; (unless (or (eq lockname nil)
3198 ;; (string= lockname filename))
3199 ;; (error
3200 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3202 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3213 ;; `file-writable-p' calls `file-expand-file-name'. We
3214 ;; cannot use `tramp-run-real-handler' therefore.
3220 ;; Short track: if we are on the local host, we can run directly.
3222 'write-region
3226 ;; We use this to save the value of
3227 ;; `last-coding-system-used' after writing the tmp
3228 ;; file. At the end of the function, we set
3229 ;; `last-coding-system-used' to this saved value. This
3230 ;; way, any intermediary coding systems used while
3231 ;; talking to the remote shell or suchlike won't hose
3232 ;; this variable. This approach was snarfed from
3233 ;; ange-ftp.el.
3234 coding-system-used
3235 ;; Write region into a tmp file. This isn't really
3236 ;; needed if we use an encoding function, but currently
3237 ;; we use it always because this makes the logic
3238 ;; simpler. We must also set `temporary-file-directory',
3239 ;; because it could point to a remote directory.
3245 ;; If `append' is non-nil, we copy the file locally, and let
3246 ;; the native `write-region' implementation do the job.
3249 ;; We say `no-message' here because we don't want the
3250 ;; visited file modtime data to be clobbered from the temp
3251 ;; file. We call `set-visited-file-modtime' ourselves later
3252 ;; on. We must ensure that `file-coding-system-alist'
3253 ;; matches `tmpfile'.
3259 'write-region
3266 ;; Now, `last-coding-system-used' has the right value. Remember it.
3271 ;; The permissions of the temporary file should be set. If
3272 ;; FILENAME does not exist (eq modes nil) it has been
3273 ;; renamed to the backup file. This case `save-buffer'
3274 ;; handles permissions.
3275 ;; Ensure that it is still readable.
3278 tmpfile
3281 ;; This is a bit lengthy due to the different methods
3282 ;; possible for file transfer. First, we check whether the
3283 ;; method uses an scp program. If so, we call it.
3284 ;; Otherwise, both encoding and decoding command must be
3285 ;; specified. However, if the method _also_ specifies an
3286 ;; encoding function, then that is used for encoding the
3287 ;; contents of the tmp file.
3292 ;; `copy-file' handles direct copy and out-of-band methods.
3303 ;; We keep the local file for performance
3304 ;; reasons, useful for "rsync".
3311 ;; Don't rename, in order to keep context in SELinux.
3316 ;; Use inline file transfer.
3318 ;; Encode tmpfile.
3322 ;; Use encoding function or command.
3325 tmpfile loc-enc)
3327 ;; The following `let' is a workaround for
3328 ;; the base64.el that comes with pgnus-0.84.
3329 ;; If both of the following conditions are
3330 ;; satisfied, it tries to write to a local
3331 ;; file in default-directory, but at this
3332 ;; point, default-directory is remote.
3333 ;; (`call-process-region' can't write to
3334 ;; remote files, it seems.) The file in
3335 ;; question is a tmp file anyway.
3343 loc-enc tmpfile t))
3345 v 'file-error
3348 filename loc-enc))))
3350 ;; Send buffer into remote decoding command which
3351 ;; writes to remote file. Because this happens on
3352 ;; the remote host, we cannot use the function.
3355 filename rem-dec)
3359 v
3363 tramp-end-of-heredoc
3365 tramp-end-of-heredoc))
3367 v nil
3368 "Couldn't write region to `%s', decode using `%s' failed"
3369 filename rem-dec)
3370 ;; When `file-precious-flag' is set, the region is
3371 ;; written to a temporary file. Check that the
3372 ;; checksum is equal to that from the local tmpfile.
3376 ;; cksum runs locally, if possible.
3378 ;; cksum runs remotely.
3380 v
3383 ;; ... they are different.
3390 v 'file-error
3393 filename rem-dec)))))
3395 ;; Save exit.
3398 ;; That's not expected.
3401 v 'file-error
3404 method))))
3406 ;; Make `last-coding-system-used' have the right value.
3413 ;; We must protect `last-coding-system-used', now we have set it
3414 ;; to its correct value.
3416 ;; Set file modification time.
3420 ;; We must pass modtime explicitly, because FILENAME can
3421 ;; be different from (buffer-file-name), f.e. if
3422 ;; `file-precious-flag' is set.
3428 ;; Set the ownership.
3438 ;; VC backends check for the existence of various different special
3439 ;; files. This is very time consuming, because every single check
3440 ;; requires a remote command (the file cache must be invalidated).
3441 ;; Therefore, we apply a kind of optimization. We install the file
3442 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3443 ;; remembers all file names for which `file-exists-p' or
3444 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3445 ;; is performed. Afterwards, a script is applied for all collected
3446 ;; file names, using just one remote command. The result of this
3447 ;; script is used to fill the file cache with actual values. Now we
3448 ;; can reset the file name handlers, and we make a second run of
3449 ;; `vc-registered', which returns the expected result without sending
3450 ;; any other remote command.
3452 "Like `vc-registered' for Tramp files."
3458 ;; There could be new files, created by the vc backend. We
3459 ;; cannot reuse the old cache entries, therefore. In
3460 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3461 ;; could also be a timestamp as `current-time' returns. This
3462 ;; means invalidate all cache entries with an older timestamp.
3468 ;; Here we collect only file names, which need an operation.
3472 ;; Send just one command, in order to fill the cache.
3475 v
3484 ;; We cannot use `tramp-send-command-and-read',
3485 ;; because this does not cooperate well with
3486 ;; heredoc documents.
3488 v
3491 tramp-end-of-heredoc
3493 tramp-vc-registered-file-names
3495 tramp-end-of-heredoc))
3497 ;; Read the expression.
3504 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3505 ;; calls shall be answered from the file cache. We unset
3506 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3507 ;; in order to keep the cache.
3509 remote-file-name-inhibit-cache process-file-side-effects)
3510 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3529 ;; Run.
3533 ;;;###tramp-autoload
3535 "Invoke remote-shell Tramp file name handler.
3536 Fall back to normal file name handler if no Tramp handler exists."
3554 "Invoke special file name handler, which collects files to be handled."
3562 ;; That's what we want: file names, for which checks are
3563 ;; applied. We assume that VC uses only `file-exists-p' and
3564 ;; `file-readable-p' checks; otherwise we must extend the
3565 ;; list. We do not perform any action, but return nil, in
3566 ;; order to keep `vc-registered' running.
3569 nil)
3570 ;; `process-file' and `start-file-process' shall be ignored.
3573 ;; Tramp file name handlers like `expand-file-name'. They
3574 ;; must still work.
3576 ;; Default file name handlers, we don't care.
3580 "Like `file-notify-add-watch' for Tramp files."
3584 command events filter p sequence)
3586 ;; gvfs-monitor-dir.
3590 ;; inotifywait.
3593 events
3600 ;; None.
3602 v 'file-notify-error
3603 "No file notification program found on %s"
3605 ;; Start process.
3607 'start-file-process
3611 sequence))
3612 ;; Return the process object as watch-descriptor.
3615 v 'file-notify-error
3616 "`%s' failed to start on remote host"
3622 p))))
3634 ;; Attribute change is returned in unused wording.
3644 string)
3647 proc
3651 ;; File names are returned as absolute paths. We must
3652 ;; add the remote prefix.
3657 ;; Usually, we would add an Emacs event now. Unfortunately,
3658 ;; `unread-command-events' does not accept several events at
3659 ;; once. Therefore, we apply the callback directly.
3662 ;; Save rest of the string.
3671 ;; Check, whether there is a problem.
3677 line)
3682 proc
3689 ;; Usually, we would add an Emacs event now. Unfortunately,
3690 ;; `unread-command-events' does not accept several events at
3691 ;; once. Therefore, we apply the callback directly.
3694 ;;; Internal Functions:
3697 "Define in remote shell function NAME implemented as SCRIPT.
3698 Only send the definition if it has not already been done."
3699 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3700 ;; might be nil.
3705 ;; The script could contain a call of Perl. This is masked with `%s'.
3710 vec
3721 auto-save-default)
3729 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3730 Returns the exit code of the `test' program."
3733 v
3735 "%s %s %s"
3737 switch
3741 "Run `test'-like program on the remote system, given FILE1, FILE2.
3742 FORMAT-STRING contains the program name, switches, and place holders.
3743 Returns the exit code of the `test' program. Barfs if the methods,
3744 hosts, or files, disagree."
3748 v 'file-error
3753 v1
3760 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3761 First arg VEC specifies the connection, PROGNAME is the program
3762 to search for, and DIRLIST gives the list of directories to
3763 search. If IGNORE-TILDE is non-nil, directory names starting
3764 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3765 only in DIRLIST.
3767 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3769 This function expects to be in the right *tramp* buffer."
3772 ;; Check whether the executable is in $PATH. "which(1)" does not
3773 ;; report always a correct error code; therefore we check the
3774 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3775 ;; 5.11") have problems with this command, we disable the call
3776 ;; therefore.
3787 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3788 ;; `remove' is in CL, and we want to avoid CL dependencies.
3797 vec
3799 "do if test -x $d/%s -a -f $d/%s; "
3800 "then echo tramp_executable $d/%s; "
3803 progname progname progname
3804 tramp-end-of-heredoc
3806 tramp-end-of-heredoc))
3812 result)))
3815 "Sets the remote environment PATH to existing directories.
3816 I.e., for each directory in `tramp-remote-path', it is tested
3817 whether it exists and if so, it is added to the environment
3818 variable PATH."
3824 ;; ------------------------------------------------------------
3825 ;; -- Communication with external shell --
3826 ;; ------------------------------------------------------------
3829 "Find a command on the remote host for checking if a file exists.
3830 Here, we are looking for a command which has zero exit status if the
3831 file exists and nonzero exit status otherwise."
3835 result)
3836 ;; The algorithm is as follows: we try a list of several commands.
3837 ;; For each command, we first run `$cmd /' -- this should return
3838 ;; true, as the root directory always exists. And then we run
3839 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3840 ;; does not exist. This should return false. We use the first
3841 ;; command we find that seems to work.
3842 ;; The list of commands to try is as follows:
3843 ;; `ls -d' This works on most systems, but NetBSD 1.4
3844 ;; has a bug: `ls' always returns zero exit
3845 ;; status, even for files which don't exist.
3846 ;; `test -e' Some Bourne shells have a `test' builtin
3847 ;; which does not know the `-e' option.
3848 ;; `/bin/test -e' For those, the `test' binary on disk normally
3849 ;; provides the option. Alas, the binary
3850 ;; is sometimes `/bin/test' and sometimes it's
3851 ;; `/usr/bin/test'.
3852 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3880 result))
3883 "Opens shell SHELL."
3886 ;; Find arguments for this shell.
3888 item extra-args)
3893 ;; It is useful to set the prompt in the following command
3894 ;; because some people have a setting for $PS1 which /bin/sh
3895 ;; doesn't know about and thus /bin/sh will display a strange
3896 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3897 ;; ksh will display the current working directory but /bin/sh
3898 ;; will display a dollar sign. The following command line sets
3899 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3900 ;; well as csh-like shells. We also unset the variable $ENV
3901 ;; because that is read by some sh implementations (eg, bash
3902 ;; when called as sh) on startup; this way, we avoid the startup
3903 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3904 ;; the prompt in /bin/bash, it must be discarded as well.
3907 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3910 "HISTFILE="
3912 ""
3917 t))
3922 "Opens a shell on the remote host which groks tilde expansion."
3930 shell)
3933 ;; CCC: "root" does not exist always, see QNAP 459.
3934 ;; Which check could we apply instead?
3937 ;; The default shell (ksh93) of OpenSolaris and
3938 ;; Solaris is buggy. We've got reports for
3939 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3948 ;; Maybe it works at least for some other commands.
3950 default-shell
3952 vec 2
3954 "Couldn't find a remote shell which groks tilde "
3956 default-shell)))
3958 default-shell)))
3960 ;; Open a new shell if needed.
3966 ;; Utility functions.
3969 "Wait for shell prompt and barf if none appears.
3970 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3971 seconds. If not, it produces an error message with the given ERROR-ARGS."
3975 proc timeout
3984 "Set up an interactive shell.
3985 Mainly sets the prompt and the echo correctly. PROC is the shell
3986 process to set up. VEC specifies the connection."
3989 vec
3994 ;; Disable echo.
3997 ;; Check whether the echo has really been disabled. Some
3998 ;; implementations, like busybox of embedded GNU/Linux, don't
3999 ;; support disabling.
4006 ;; Make sure backspaces and their echo are enabled and no line
4007 ;; width magic interferes with them.
4015 ;; Try to set up the coding system correctly.
4016 ;; CCC this can't be the right way to do it. Hm.
4020 ;; Use MULE to select the right EOL convention for communicating
4021 ;; with the process.
4027 cs-decode cs-encode)
4044 ;; Look for ^M and do something useful if found.
4046 ;; We have found a ^M but cannot frob the process coding system
4047 ;; because we're running on a non-MULE Emacs. Let's try
4048 ;; stty, instead.
4053 ;; Check whether the output of "uname -sr" has been changed. If
4054 ;; yes, this is a strong indication that we must expire all
4055 ;; connection properties. We start again with
4056 ;; `tramp-maybe-open-connection', it will be caught there.
4061 vec "uname"
4065 vec 3
4066 "Connection reset, because remote host changed from `%s' to `%s'"
4067 old-uname new-uname)
4068 ;; We want to keep the password.
4072 ;; Check whether the remote host suffers from buggy
4073 ;; `send-process-string'. This is known for FreeBSD (see comment in
4074 ;; `send_process', file process.c). I've tested sending 624 bytes
4075 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4076 ;; this host type is detected locally. It cannot handle remote
4077 ;; hosts, though.
4081 tramp-chunksize)
4089 ;; Set remote PATH variable.
4092 ;; Search for a good shell before searching for a command which
4093 ;; checks if a file exists. This is done because Tramp wants to use
4094 ;; "test foo; echo $?" to check if various conditions hold, and
4095 ;; there are buggy /bin/sh implementations which don't execute the
4096 ;; "echo $?" part if the "test" part has an error. In particular,
4097 ;; the OpenSolaris /bin/sh is a problem. There are also other
4098 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4099 ;; in function declarations, or changing HISTFILE in place.
4100 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4101 ;; detected.
4104 ;; Disable unexpected output.
4107 ;; IRIX64 bash expands "!" even when in single quotes. This
4108 ;; destroys our shell functions, we must disable it. See
4109 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4113 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4118 ;; Set `remote-tty' process property.
4123 ;; Dump stty settings in the traces.
4127 ;; Set the environment.
4132 unset vars item)
4142 vec
4144 tramp-end-of-heredoc
4146 tramp-end-of-heredoc)
4147 t))
4152 ;; Old text from documentation of tramp-methods:
4153 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4154 ;; of the base64 methods instead since base64 encoding is much more
4155 ;; reliable and the commands are more standardized between the different
4156 ;; Unix versions. But if you can't use base64 for some reason, please
4157 ;; note that the default uudecode command does not work well for some
4158 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4159 ;; the following command for uudecode:
4160 ;;
4161 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4162 ;;
4163 ;; For Irix, no solution is known yet.
4171 "List of local coding commands for inline transfer.
4172 Each item is a list that looks like this:
4174 \(FORMAT ENCODING DECODING\)
4176 FORMAT is symbol describing the encoding/decoding format. It can be
4177 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4179 ENCODING and DECODING can be strings, giving commands, or symbols,
4180 giving functions. If they are strings, then they can contain
4182 file name will be put into the command line at that spot. If the
4183 specifier is not present, the input should be read from standard
4184 input.
4186 If they are functions, they will be called with two arguments, start
4187 and end of region, and are expected to replace the region contents
4192 ;; "-i" is more robust with older base64 from GNU coreutils.
4193 ;; However, I don't know whether all base64 versions do supports
4194 ;; this option.
4206 "List of remote coding commands for inline transfer.
4207 Each item is a list that looks like this:
4209 \(FORMAT ENCODING DECODING [TEST]\)
4211 FORMAT is a symbol describing the encoding/decoding format. It can be
4212 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4214 ENCODING and DECODING can be strings, giving commands, or symbols,
4215 giving variables. If they are strings, then they can contain
4217 file name will be put into the command line at that spot. If the
4218 specifier is not present, the input should be read from standard
4219 input.
4221 If they are variables, this variable is a string containing a
4222 Perl or Shell implementation for this functionality. This
4223 program will be transferred to the remote host, and it is
4225 specifier in the variable value denotes a temporary file.
4227 The optional TEST command can be used for further tests, whether
4231 "Find an inline transfer encoding that works.
4232 Goes through the list `tramp-local-coding-commands' and
4233 `tramp-remote-coding-commands'."
4238 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4246 ;; If the local encoder or decoder is a string, the
4247 ;; corresponding command has to work locally.
4254 loc-enc nil nil))
4262 loc-dec nil nil))
4264 ;; Search for remote coding commands with the same format
4272 ;; Check the remote test command if exists.
4278 ;; Check if remote perl exists when necessary.
4282 ;; Check if remote encoding and decoding commands can be
4283 ;; called remotely with null input and output. This makes
4284 ;; sure there are no syntax errors and the command is really
4285 ;; found. Note that we do not redirect stdout to /dev/null,
4286 ;; for two reasons: when checking the decoding command, we
4287 ;; actually check the output it gives. And also, when
4288 ;; redirecting "mimencode" output to /dev/null, then as root
4289 ;; it might change the permissions of /dev/null!
4297 vec 5
4306 tmpfile)
4313 tramp-temp-name-prefix
4315 value
4317 value
4319 ?t
4325 vec 5
4328 vec
4330 t)
4338 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4344 ;; Set connection properties. Since the commands are risky
4345 ;; (due to output direction), we cache them in the process cache.
4356 "Call the local encoding or decoding command.
4358 Otherwise, INPUT is passed via standard input.
4359 INPUT can also be nil which means `/dev/null'.
4360 OUTPUT can be a string (which specifies a file name), or t (which
4361 means standard output and thus the current buffer), or nil (which
4362 means discard it)."
4364 nil tramp-encoding-shell
4367 nil
4368 tramp-encoding-command-switch
4378 "List of compress and decompress commands for inline transfer.
4379 Each item is a list that looks like this:
4381 \(COMPRESS DECOMPRESS\)
4386 "Find an inline transfer compress command that works.
4387 Goes through the list `tramp-inline-compress-commands'."
4392 item compress decompress found)
4399 vec 5
4400 "Checking local compress commands `%s', `%s' for sanity"
4401 compress decompress)
4406 ;; Windows shells need the program file name after
4407 ;; the pipe symbol be quoted if they use forward
4408 ;; slashes as directory separators.
4415 vec 5
4416 "Checking remote compress commands `%s', `%s' for sanity"
4417 compress decompress)
4423 ;; Did we find something?
4426 ;; Set connection properties. Since the commands are
4427 ;; risky (due to output direction), we cache them in the
4428 ;; process cache.
4442 "Expands VEC according to `tramp-default-proxies-alist'.
4443 Gateway hops are already opened."
4447 choices proxy)
4449 ;; Ad-hoc proxy definitions.
4454 tramp-prefix-format proxy tramp-postfix-host-format)))
4459 proxy)
4460 ;; Add the hop.
4462 'tramp-default-proxies-alist
4465 proxy))
4467 ;; Save the new value.
4472 ;; Look for proxy hosts to be passed.
4478 ;; Host.
4481 ;; User.
4485 ;; No more hops needed.
4487 ;; Replace placeholders.
4490 proxy
4495 ;; Add the hop.
4497 ;; Start next search.
4500 ;; Handle gateways.
4508 ;; Is the method prepared for gateways?
4511 vec 'file-error
4513 ;; Open the gateway connection.
4518 target-alist)
4519 ;; For the password prompt, we need the correct values.
4520 ;; Therefore, we must remember the gateway vector. But we
4521 ;; cannot do it as connection property, because it shouldn't
4522 ;; be persistent. And we have no started process yet either.
4526 ;; Foreign and out-of-band methods are not supported for multi-hops.
4539 vec 'file-error
4540 "Method `%s' is not supported for multi-hops."
4543 ;; In case the host name is not used for the remote shell
4544 ;; command, the user could be misguided by applying a random
4545 ;; hostname.
4551 ;; There are multi-hops.
4553 ;; The host name is used for the remote shell command.
4556 ;; The host is local. We cannot use `tramp-local-host-p'
4557 ;; here, because it opens a connection as well.
4560 v 'file-error
4561 "Host `%s' looks like a remote host, `%s' can only use the local host"
4562 host method)))
4564 ;; Result.
4565 target-alist))
4568 "Maybe open a connection VEC.
4569 Does not do anything if a connection is already open, but re-opens the
4570 connection if a previous connection has died for some reason."
4578 ;; If Tramp opens the same connection within a short time frame,
4579 ;; there is a problem. We shall signal this.
4588 ;; If too much time has passed since last command was sent, look
4589 ;; whether process is still alive. If it isn't, kill it. When
4590 ;; using ssh, it can sometimes happen that the remote end has hung
4591 ;; up but the local ssh client doesn't recognize this until it
4592 ;; tries to send some data to the remote end. So that's why we
4593 ;; try to send a command from time to time, then look again
4594 ;; whether the process is really alive.
4605 ;; The error will be caught locally.
4611 ;; New connection must be opened.
4615 ;; If `non-essential' is non-nil, don't reopen a new connection.
4620 vec 3
4631 ;; Start new process.
4639 tramp-histfile-override)))
4643 ;; We will apply `tramp-ssh-controlmaster-options'
4644 ;; only for the first hop.
4650 ;; This must be done in order to avoid our file
4651 ;; name handler.
4655 'start-process
4660 tramp-encoding-command-interactive)
4663 ;; Set sentinel and query flag.
4674 ;; Check whether process is alive.
4676 p 10
4679 ;; Now do all the connections as specified.
4709 ;; We don't create the temporary file. In
4710 ;; fact, it is just a prefix for the
4711 ;; ControlPath option of ssh; the real
4712 ;; temporary file has another name, and it is
4713 ;; created and protected by ssh. It is also
4714 ;; removed by ssh when the connection is
4715 ;; closed. The temporary file name is cached
4716 ;; in the main connection process, therefore
4717 ;; we cannot use `tramp-get-connection-process'.
4723 tramp-temp-name-prefix
4725 spec r-shell)
4727 ;; Add arguments for asynchronous processes.
4731 ;; Add gateway arguments if necessary.
4737 ;; Check for port number. Until now, there's no
4738 ;; need for handling like method, user, host.
4743 ;; Check, whether there is a restricted shell.
4748 ;; Set variables for computing the prompt for
4749 ;; reading password. They can also be derived
4750 ;; from a gateway.
4755 ;; Add login environment.
4758 login-env
4763 login-env))
4767 "%s=%s %s"
4770 command)))
4773 ;; Replace `login-args' place holders.
4781 ?h l-host ?u l-user ?p l-port ?c options)
4782 command
4784 ;; We do not want to see the trailing local
4785 ;; prompt in `start-file-process'.
4787 command " "
4793 ;; Local shell could be a Windows COMSPEC. It
4794 ;; doesn't know the ";" syntax, but we must exit
4795 ;; always for `start-file-process'. It could
4796 ;; also be a restricted shell, which does not
4797 ;; allow "exec".
4800 ;; Send the command.
4804 p vec pos tramp-actions-before-shell
4808 ;; Next hop.
4812 ;; Make initial shell settings.
4815 ;; When the user did interrupt, we must cleanup.
4818 ;; Propagate the quit signal.
4822 "Send the COMMAND to connection VEC.
4823 Erases temporary buffer before sending the command. If optional
4824 arg NEVEROPEN is non-nil, never try to open the connection. This
4825 is meant to be used from `tramp-maybe-open-connection' only. The
4826 function waits for output unless NOOUTPUT is set."
4830 ;; We mark the command string that it can be erased in the output buffer.
4832 ;; If we put `tramp-echo-mark' after a trailing newline (which
4833 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4834 ;; that newline and adds `tramp-rsh-end-of-line' right after
4835 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4836 ;; trailing line endings and sends two prompts after executing
4837 ;; the command, which confuses `tramp-wait-for-output'.
4841 ;; No need to restore a trailing newline here since `tramp-send-string'
4842 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4844 ;; Send the command.
4850 "Wait for output from remote command."
4856 ;; be leading escape sequences, which must be ignored.
4858 ;; Sometimes, the commands do not return a newline but a
4859 ;; null byte before the shell prompt, for example "git
4860 ;; ls-files -c -z ...".
4865 ;; A simple-minded busybox has sent " ^H" sequences.
4866 ;; Delete them.
4871 ;; Delete the prompt.
4877 proc 'file-error
4878 "[[Remote prompt `%s' not found in %d secs]]"
4879 tramp-end-of-output timeout)
4881 proc 'file-error
4883 ;; Return value is whether end-of-output sentinel was found.
4884 found)))
4888 "Run COMMAND and check its exit status.
4889 Sends `echo $?' along with the COMMAND for checking the exit status.
4890 If COMMAND is nil, just sends `echo $?'. Returns `t' if the exit
4891 status is 0, and `nil' otherwise.
4893 If the optional argument SUBSHELL is non-nil, the command is
4894 executed in a subshell, ie surrounded by parentheses. If
4895 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4897 vec
4899 command
4901 "echo tramp_exit_status $?"
4915 "Run COMMAND, check exit status, throw error if exit status not okay.
4916 Similar to `tramp-send-command-and-check' but accepts two more arguments
4917 FMT and ARGS which are passed to `error'."
4922 "Run COMMAND and return the output, which must be a Lisp expression.
4923 If MARKER is a regexp, read the output after that string.
4924 In case there is no valid Lisp expression and NOERROR is nil, it
4925 raises an error."
4932 ;; Read the marker.
4938 vec 'file-error
4939 "`%s' does not return the marker `%s': `%s'"
4941 ;; Read the expression.
4944 ;; Error handling.
4949 vec 'file-error
4950 "`%s' does not return a valid Lisp expression: `%s'"
4954 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4955 Convert file mode bits to string and set virtual device number.
4956 Return ATTR."
4958 ;; Remove color escape sequences from symlink.
4962 ;; Convert uid and gid. Use -1 as indication of unusable value.
4973 ;; Convert last access time.
4978 ;; Convert last modification time.
4983 ;; Convert last status change time.
4988 ;; Convert file size.
4994 ;; Convert file mode bits to string.
4999 ;; Convert directory indication bit.
5002 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5008 ;; Set file's gid change bit.
5016 ;; Convert inode.
5022 ;; Inodes can be incredible huge. We must hide this.
5024 ;; Set virtual device number.
5027 attr))
5030 "Converts STRING to shell glob pattern which ignores case."
5036 string
5040 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
5048 localname)
5054 "Return t if this is an out-of-band method, nil otherwise."
5056 ;; It shall be an out-of-band method.
5058 ;; There must be a size, otherwise the file doesn't exist.
5060 ;; Either the file size is large enough, or (in rare cases) there
5061 ;; does not exist a remote encoding.
5066 ;; Variables local to connection.
5070 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5071 ;; cache the result for the session only. Otherwise, the result
5072 ;; is cached persistently.
5075 vec)
5076 "remote-path"
5085 ;; Default if "getconf" is not available.
5088 vec 3
5093 ;; The login shell could return more than just the $PATH
5094 ;; string. So we use `tramp-end-of-heredoc' as marker.
5097 vec
5103 'identity
5110 ;; Replace place holder `tramp-default-remote-path'.
5118 ;; Replace place holder `tramp-own-remote-path'.
5126 ;; Remove double entries.
5133 ;; Remove non-existing directories.
5135 nil
5145 x))
5146 x))
5147 remote-path)))))
5153 locale)
5159 candidates nil)
5161 ;; Return value.
5171 result)
5173 ;; Check parameters. On busybox, "ls" output coloring is
5174 ;; enabled by default sometimes. So we try to disable it
5175 ;; when possible. $LS_COLORING is not supported there.
5176 ;; Some "ls" versions are sensible wrt the order of
5177 ;; arguments, they fail when "-al" is after the
5178 ;; "--color=never" argument (for example on FreeBSD).
5193 ;; Some "ls" versions are sensible wrt the order of arguments,
5194 ;; they fail when "-al" is after the "--dired" argument (for
5195 ;; example on FreeBSD).
5203 "test"
5207 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5208 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5209 ;; for otherwise the shell crashes.
5221 vec
5244 ;; We must check also for some Perl modules.
5252 result)))
5259 tmp)
5260 ;; Check whether stat(1) returns usable syntax. "%s" does not
5261 ;; work on older AIX systems.
5270 result)))
5280 result))))
5296 ;; Busyboxes do support the "-t" option only when they have been
5297 ;; built with the DESKTOP config option. Let's check it.
5300 vec "touch-t"
5302 vec
5304 "%s -t %s %s"
5305 result
5309 result)))
5328 result)
5330 ;; Check POSIX parameter.
5337 vec
5346 vec
5350 "print $>"
5362 vec
5366 "import os; print (os.getuid())"
5380 ;; Ensure there is a valid result.
5388 vec
5397 vec
5406 vec
5410 "import os; print (os.getgid())"
5424 ;; Ensure there is a valid result.
5430 ;; Some predefined connection properties.
5432 "Return the compress command related to PROP.
5433 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5434 the length of the file to be compressed.
5436 If no corresponding command is found, nil is returned."
5445 "Return the coding command related to PROP.
5446 PROP is either `remote-encoding', `remote-decoding',
5447 `local-encoding' or `local-decoding'.
5449 SIZE is the length of the file to be coded. Depending on SIZE,
5450 compression might be applied.
5452 If no corresponding command is found, nil is returned.
5453 Otherwise, either a string is returned which contains a `%s' mark
5454 to be used for the respective input or output file; or a Lisp
5455 function cell is returned to be applied on a buffer."
5456 ;; We must catch the errors, because we want to return `nil', when
5457 ;; no inline coding is found.
5467 compress)
5468 ;; The connection property might have been cached. So we must
5469 ;; send the script to the remote side - maybe.
5477 ;; Check for the `compress' command.
5479 ;; Return the value.
5495 'call-process-region beg end
5500 coding)
5503 ;; Windows shells need the program file name after
5504 ;; the pipe symbol be quoted if they use forward
5505 ;; slashes as directory separators.
5512 coding compress))
5515 ;; Windows shells need the program file name after
5516 ;; the pipe symbol be quoted if they use forward
5517 ;; slashes as directory separators.
5522 compress coding))
5536 ;;; TODO:
5538 ;; * Don't use globbing for directories with many files, as this is
5539 ;; likely to produce long command lines, and some shells choke on
5540 ;; long command lines.
5541 ;; * Make it work for different encodings, and for different file name
5542 ;; encodings, too. (Daniel Pittman)
5543 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5544 ;; then look if it's the right version (with `perl -v').
5545 ;; * When editing a remote CVS controlled file as a different user, VC
5546 ;; gets confused about the file locking status. Try to find out why
5547 ;; the workaround doesn't work.
5548 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5549 ;; until the last but one hop via `start-file-process'. Apply it
5550 ;; also for ftp and smb.
5551 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5552 ;; some shell with root privileges, it would be nice if I could
5553 ;; just call
5554 ;; trampclient filename.c
5555 ;; as an editor, and the _current_ shell would connect to an Emacs
5556 ;; server and would be used in an existing non-privileged Emacs
5557 ;; session for doing the editing in question.
5558 ;; That way, I need not tell Emacs my password again and be afraid
5559 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5560 ;; once display a just typed password in the context of a keyboard
5561 ;; sequence prompt for a question immediately following in a shell
5562 ;; script run within Emacs -- nasty).
5563 ;; And if I have some ssh session running to a different computer,
5564 ;; having the possibility of passing a local file there to a local
5565 ;; Emacs session (in case I can arrange for a connection back) would
5566 ;; be nice.
5567 ;; Likely the corresponding Tramp server should not allow the
5568 ;; equivalent of the emacsclient -eval option in order to make this
5569 ;; reasonably unproblematic. And maybe trampclient should have some
5570 ;; way of passing credentials, like by using an SSL socket or
5571 ;; something. (David Kastrup)
5572 ;; * Reconnect directly to a compliant shell without first going
5573 ;; through the user's default shell. (Pete Forman)
5574 ;; * How can I interrupt the remote process with a signal
5575 ;; (interrupt-process seems not to work)? (Markus Triska)
5576 ;; * Avoid the local shell entirely for starting remote processes. If
5577 ;; so, I think even a signal, when delivered directly to the local
5578 ;; SSH instance, would correctly be propagated to the remote process
5579 ;; automatically; possibly SSH would have to be started with
5580 ;; "-t". (Markus Triska)
5581 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5582 ;; isn't on the remote host. (Mark A. Hershberger)
5583 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5584 ;; * Optimize out-of-band copying when both methods are scp-like (not
5585 ;; rsync).
5586 ;; * Keep a second connection open for out-of-band methods like scp or
5587 ;; rsync.
5589 ;;; tramp-sh.el ends here