| blob | e120aedfc015c777a64f5a53b25cfcf3a1ab720f |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2014 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
71 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
72 ;; root users. It uses the `$' character for other users. In order
73 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
77 "///%s#$"
79 "String used to recognize end of output.
80 The '$' character at the end is quoted; the string cannot be
83 ;;;###tramp-autoload
90 ;; Initialize `tramp-methods' with the supported methods.
91 ;;;###tramp-autoload
102 ;;;###tramp-autoload
112 ;;;###tramp-autoload
129 ;;;###tramp-autoload
147 ;;;###tramp-autoload
162 ;;;###tramp-autoload
169 ;;;###tramp-autoload
176 ;;;###tramp-autoload
189 ;;;###tramp-autoload
202 ;;;###tramp-autoload
210 ;;;###tramp-autoload
218 ;; We use "-v" for better error tracking.
221 ;; We use "-p" as required for newer busyboxes. For older
222 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
223 ;; can be achieved by tweaking `tramp-connection-properties'.
226 ;;;###tramp-autoload
234 ;;;###tramp-autoload
239 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
244 ;;;###tramp-autoload
252 ;;;###tramp-autoload
259 ;;;###tramp-autoload
263 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
267 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
268 tramp-terminal-type
269 tramp-initial-end-of-output))
274 ;;;###tramp-autoload
280 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
281 tramp-terminal-type
282 tramp-initial-end-of-output))
286 ;;;###tramp-autoload
293 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
294 tramp-terminal-type
295 tramp-initial-end-of-output))
305 ;;;###tramp-autoload
312 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
313 tramp-terminal-type
314 tramp-initial-end-of-output))
323 ;;;###tramp-autoload
334 ;;;###tramp-autoload
338 ;;;###tramp-autoload
342 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
343 ;; Do not add "plink" based methods, they ask interactively for the user.
344 ;;;###tramp-autoload
353 ;;;###tramp-autoload
359 ;;;###tramp-autoload
375 ;;;###tramp-autoload
380 ;;;###tramp-autoload
385 ;;;###tramp-autoload
393 ;;;###tramp-autoload
420 ;; "getconf PATH" yields:
421 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
422 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
423 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
424 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
425 ;; IRIX64: /usr/bin
426 ;;;###tramp-autoload
432 "List of directories to search for executables on remote host.
433 For every remote host, this variable will be set buffer local,
434 keeping the list of existing directories on that host.
436 You can use `~' in this list, but when searching for a shell which groks
437 tilde expansion, all directory names starting with `~' will be ignored.
439 `Default Directories' represent the list of directories given by
441 entry on top of this list, because these are the default
442 directories for POSIX compatible commands. On remote hosts which
443 do not offer the getconf command (like cygwin), the value
446 `Private Directories' are the settings of the $PATH environment,
447 as given in your `~/.profile'."
454 ;;;###tramp-autoload
462 "List of environment variables to be set on the remote host.
464 Each element should be a string of the form ENVVARNAME=VALUE. An
465 entry ENVVARNAME= disables the corresponding environment variable,
466 which might have been set in the init files like ~/.profile.
468 Special handling is applied to the PATH environment, which should
469 not be set here. Instead, it should be set via `tramp-remote-path'."
475 "Alist specifying extra arguments to pass to the remote shell.
476 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
477 matching the shell file name and ARGS is a string specifying the
478 arguments.
480 This variable is only used when Tramp needs to start up another shell
481 for tilde expansion. The extra arguments should typically prevent the
482 shell from reading its init file."
484 ;; This might be the wrong way to test whether the widget type
485 ;; `alist' is available. Who knows the right way to test it?
500 "List of pattern/action pairs.
501 Whenever a pattern matches, the corresponding action is performed.
502 Each item looks like (PATTERN ACTION).
504 The PATTERN should be a symbol, a variable. The value of this
505 variable gives the regular expression to search for. Note that the
507 appended to it.
509 The ACTION should also be a symbol, but a function. When the
517 "List of pattern/action pairs.
518 This list is used for copying/renaming with out-of-band methods.
523 "(echo begin 600 %t; tail -n +2) | uudecode
524 cat %t
525 rm -f %t"
526 "Shell function to implement `uudecode' to standard output.
527 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
528 for this or `uudecode -p', but some systems don't, and for them
532 "%s -e '
533 use File::Spec;
536 sub recursive {
537 my ($volume, @dirs) = @_;
538 my $real = realpath(File::Spec->catpath(
540 if ($real) {
541 my ($vol, $dir) = File::Spec->splitpath($real, 1);
542 return ($vol, File::Spec->splitdir($dir));
543 }
544 else {
545 my $last = pop(@dirs);
546 ($volume, @dirs) = recursive($volume, @dirs);
547 push(@dirs, $last);
548 return ($volume, @dirs);
549 }
550 }
552 $result = realpath($ARGV[0]);
553 if (!$result) {
554 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
555 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
558 }
562 }
566 "Perl script to produce output suitable for use with `file-truename'
567 on the remote file system.
568 Escape sequence %s is replaced with name of Perl binary.
572 "%s -e 'sub case {
573 my $str = shift;
574 if ($ARGV[2]) {
575 return lc($str);
576 }
577 else {
578 return $str;
579 }
580 }
582 @files = readdir(d); closedir(d);
583 foreach $f (@files) {
584 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
587 }
588 else {
590 }
591 }
592 }
595 "Perl script to produce output suitable for use with
596 `file-name-all-completions' on the remote file system. Escape
597 sequence %s is replaced with name of Perl binary. This string is
600 ;; Perl script to implement `file-attributes' in a Lisp `read'able
601 ;; output. If you are hacking on this, note that you get *no* output
602 ;; unless this spits out a complete line, including the '\n' at the
603 ;; end.
604 ;; The device number is returned as "-1", because there will be a virtual
605 ;; device number set in `tramp-sh-handle-file-attributes'.
607 "%s -e '
608 @stat = lstat($ARGV[0]);
609 if (!@stat) {
611 exit 0;
612 }
613 if (($stat[2] & 0170000) == 0120000)
614 {
615 $type = readlink($ARGV[0]);
617 }
618 elsif (($stat[2] & 0170000) == 040000)
619 {
621 }
622 else
623 {
625 };
628 printf(
630 $type,
631 $stat[3],
632 $uid,
633 $gid,
634 $stat[8] >> 16 & 0xffff,
635 $stat[8] & 0xffff,
636 $stat[9] >> 16 & 0xffff,
637 $stat[9] & 0xffff,
638 $stat[10] >> 16 & 0xffff,
639 $stat[10] & 0xffff,
640 $stat[7],
641 $stat[2],
642 $stat[1] >> 16 & 0xffff,
643 $stat[1] & 0xffff
645 "Perl script to produce output suitable for use with `file-attributes'
646 on the remote file system.
647 Escape sequence %s is replaced with name of Perl binary.
651 "%s -e '
654 @list = readdir(DIR);
655 closedir(DIR);
656 $n = scalar(@list);
658 for($i = 0; $i < $n; $i++)
659 {
660 $filename = $list[$i];
661 @stat = lstat($filename);
662 if (($stat[2] & 0170000) == 0120000)
663 {
664 $type = readlink($filename);
666 }
667 elsif (($stat[2] & 0170000) == 040000)
668 {
670 }
671 else
672 {
674 };
677 printf(
678 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
679 $filename,
680 $type,
681 $stat[3],
682 $uid,
683 $gid,
684 $stat[8] >> 16 & 0xffff,
685 $stat[8] & 0xffff,
686 $stat[9] >> 16 & 0xffff,
687 $stat[9] & 0xffff,
688 $stat[10] >> 16 & 0xffff,
689 $stat[10] & 0xffff,
690 $stat[7],
691 $stat[2],
692 $stat[1] >> 16 & 0xffff,
693 $stat[1] & 0xffff,
694 $stat[0] >> 16 & 0xffff,
695 $stat[0] & 0xffff);
696 }
698 "Perl script implementing `directory-files-attributes' as Lisp `read'able
699 output.
700 Escape sequence %s is replaced with name of Perl binary.
703 ;; These two use base64 encoding.
705 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
706 "Perl program to use for encoding a file.
707 Escape sequence %s is replaced with name of Perl binary.
708 This string is passed to `format', so percent characters need to be doubled.
709 This implementation requires the MIME::Base64 Perl module to be installed
713 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
714 "Perl program to use for decoding a file.
715 Escape sequence %s is replaced with name of Perl binary.
716 This string is passed to `format', so percent characters need to be doubled.
717 This implementation requires the MIME::Base64 Perl module to be installed
721 "%s -e '
722 # This script contributed by Juanma Barranquero <lektu@terra.es>.
723 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
724 use strict;
726 my %%trans = do {
727 my $i = 0;
728 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
729 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
730 };
731 my $data;
733 # We read in chunks of 54 bytes, to generate output lines
734 # of 72 chars (plus end of line)
735 while (read STDIN, $data, 54) {
736 my $pad = q();
738 # Only for the last chunk, and only if did not fill the last three-byte packet
739 if (eof) {
740 my $mod = length($data) %% 3;
741 $pad = q(=) x (3 - $mod) if $mod;
742 }
744 # Not the fastest method, but it is simple: unpack to binary string, split
745 # by groups of 6 bits and convert back from binary to byte; then map into
746 # the translation table
747 print
748 join q(),
749 map($trans{$_},
750 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
751 $pad,
753 }' 2>/dev/null"
754 "Perl program to use for encoding a file.
755 Escape sequence %s is replaced with name of Perl binary.
759 "%s -e '
760 # This script contributed by Juanma Barranquero <lektu@terra.es>.
761 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
762 use strict;
764 my %%trans = do {
765 my $i = 0;
766 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
767 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
768 };
770 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
774 # We are going to accumulate into $pending to accept any line length
775 # (we do not check they are <= 76 chars as the RFC says)
776 my $pending = q();
778 while (my $data = <STDIN>) {
779 chomp $data;
781 # If we find one or two =, we have reached the end and
782 # any following data is to be discarded
783 my $finished = $data =~ s/(==?).*/$1/;
784 $pending .= $data;
786 my $len = length($pending);
787 my $chunk = substr($pending, 0, $len & ~3);
788 $pending = substr($pending, $len & ~3 + 1);
790 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
791 # split in 8-bit chunks and convert back to char.
792 print join q(),
793 map $bytes{$_},
794 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
796 last if $finished;
797 }' 2>/dev/null"
798 "Perl program to use for decoding a file.
799 Escape sequence %s is replaced with name of Perl binary.
803 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
804 "Perl program to use for encoding a file.
808 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
809 "Perl program to use for decoding a file.
814 while read file; do
817 else
819 fi
822 else
824 fi
825 done
827 "Script to check existence of VC related files.
828 It must be send formatted with two strings; the tests for file
829 existence, and file readability. Input shall be read via
830 here-document, otherwise the command could exceed maximum length
833 ;; New handlers should be added here.
837 ;; `byte-compiler-base-file-name' performed by default handler.
842 ;; `diff-latest-backup-file' performed by default handler.
846 . tramp-sh-handle-directory-files-and-attributes)
847 ;; `dired-call-process' performed by default handler.
850 . tramp-sh-handle-dired-recursive-delete-directory)
857 ;; `file-equal-p' performed by default handler.
860 ;; `file-in-directory-p' performed by default handler.
868 ;; `file-name-sans-versions' performed by default handler.
881 ;; `find-file-noselect' performed by default handler.
882 ;; `get-file-buffer' performed by default handler.
886 . tramp-sh-handle-insert-file-contents-literally)
905 "Alist of handler functions.
908 ;; This must be the last entry, because `identity' always matches.
909 ;;;###tramp-autoload
913 ;;; File Name Handler Functions:
917 "Like `make-symbolic-link' for Tramp files.
918 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
919 the symlink. If LINKNAME is a Tramp file, only the localname component is
920 used as the target of the symlink.
922 If LINKNAME is a Tramp file and the localname component is relative, then
923 it is expanded first, before the localname component is taken. Note that
924 this can give surprising results if the user/host for the source and
925 target of the symlink differ."
932 l 'file-error
935 ;; Do the 'confirm if exists' thing.
937 ;; What to do?
942 "File %s already exists; make it a link anyway? "
943 l-localname)))))
948 ;; If FILENAME is a Tramp name, use just the localname component.
957 ;; Right, they are on the same host, regardless of user, method,
958 ;; etc. We now make the link on the remote machine. This will
959 ;; occur as the user that FILENAME belongs to.
961 l
963 "cd %s && %s -sf %s %s"
965 ln
968 t))))
971 "Like `file-truename' for Tramp files."
973 "%s%s"
976 method user host
981 ;; Use GNU readlink --canonicalize-missing where available.
984 v
992 ;; Use Perl implementation.
1000 v
1004 ;; Do it yourself. We bind `directory-sep-char' here for
1005 ;; XEmacs on Windows, which would otherwise use backslash.
1013 ;; Don't make the following value larger than
1014 ;; necessary. People expect an error message in
1015 ;; a timely fashion when something is wrong;
1016 ;; otherwise they might think that Emacs is hung.
1017 ;; Of course, correctness has to come first.
1019 symlink-target)
1030 method user host
1042 ;; It's a symlink, follow it.
1048 ;; If the symlink was absolute, we'll get a
1049 ;; string like "/user@host:/some/target";
1050 ;; extract the "/some/target" part from it.
1054 v 'file-error
1055 "Symlink target `%s' on wrong host"
1056 symlink-target))
1061 steps)))
1063 ;; It's a file.
1067 v 'file-error
1070 ;; Combine list to form string.
1081 result))))
1083 ;; Preserve trailing "/".
1086 ;; Basic functions.
1089 "Like `file-exists-p' for Tramp files."
1097 v
1099 "%s %s"
1104 "Like `file-attributes' for Tramp files."
1106 ;; Don't modify `last-coding-system-used' by accident.
1113 v
1121 ;; The scripts could fail, for example with huge file size.
1125 "Implement `file-attributes' for Tramp files using the ls(1) command."
1127 res-inode res-filemodes res-numlinks
1128 res-uid res-gid res-size res-symlink-target)
1131 vec
1140 ;; parse `ls -l' output ...
1144 ;; ... inode
1160 ;; ... file mode flags
1162 ;; ... number links
1164 ;; ... uid and gid
1174 ;; ... size
1176 ;; From the file modes, figure out other stuff.
1179 ;; if symlink, find out file name pointed to
1183 ;; return data gathered
1185 ;; 0. t for directory, string (name linked to) for symbolic
1186 ;; link, or nil.
1188 ;; 1. Number of links to file.
1189 res-numlinks
1190 ;; 2. File uid.
1191 res-uid
1192 ;; 3. File gid.
1193 res-gid
1194 ;; 4. Last access time, as a list of integers. Normally this
1195 ;; would be in the same format as `current-time', but the
1196 ;; subseconds part is not currently implemented, and (0 0)
1197 ;; denotes an unknown time.
1198 ;; 5. Last modification time, likewise.
1199 ;; 6. Last status change time, likewise.
1201 ;; 7. Size in bytes (-1, if number is out of range).
1202 res-size
1203 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1204 res-filemodes
1205 ;; 9. t if file's gid would change if file were deleted and
1206 ;; recreated. Will be set in `tramp-convert-file-attributes'
1207 t
1208 ;; 10. inode number.
1209 res-inode
1210 ;; 11. Device number. Will be replaced by a virtual device number.
1211 -1
1212 )))))
1216 "Implement `file-attributes' for Tramp files using a Perl script."
1221 vec
1227 "Implement `file-attributes' for Tramp files using stat(1) command."
1230 vec
1232 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1233 ;; parse correctly the sequence "((". Therefore, we add a space.
1234 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1245 "Like `set-visited-file-modtime' for Tramp files."
1252 coding-system-used)
1256 ;; '(-1 65535) means file doesn't exists yet.
1260 ;; We use '(0 0) as a don't-know value. See also
1261 ;; `tramp-do-file-attributes-with-ls'.
1266 v
1275 nil)))))
1277 ;; This function makes the same assumption as
1278 ;; `tramp-sh-handle-set-visited-file-modtime'.
1280 "Like `verify-visited-file-modtime' for Tramp files.
1281 At the time `verify-visited-file-modtime' calls this function, we
1282 already know that the buffer is visiting a file and that
1283 `visited-file-modtime' does not return 0. Do not call this
1284 function directly, unless those two cases are already taken care
1285 of."
1288 ;; There is no file visiting the buffer, or the buffer has no
1289 ;; recorded last modification time, or there is no established
1290 ;; connection.
1294 t
1302 ;; File exists, and has a known modtime.
1305 modtime
1306 ;; For compatibility, deal with both the old
1307 ;; (HIGH . LOW) and the new (HIGH LOW) return
1308 ;; values of `visited-file-modtime'.
1311 mt)))
1313 ;; Modtime has the don't know value.
1316 v
1323 attr
1326 ;; If file does not exist, say it is not modified if and
1327 ;; only if that agrees with the buffer's record.
1331 "Like `set-file-modes' for Tramp files."
1334 ;; FIXME: extract the proper text from chmod's stderr.
1336 v
1343 "Like `set-file-times' for Tramp files."
1350 time))
1351 ;; With GNU Emacs, `format-time-string' has an
1352 ;; optional parameter UNIVERSAL. This is preferred,
1353 ;; because we could handle the case when the remote
1354 ;; host is located in a different time zone as the
1355 ;; local host.
1359 "%s %s %s %s"
1370 ;; We handle also the local part, because in older Emacsen,
1371 ;; without `set-file-times', this function is an alias for this.
1372 ;; We are local, so we don't need the UTC settings.
1380 "Set the ownership for FILENAME.
1381 If UID and GID are provided, these values are used; otherwise uid
1382 and gid of the corresponding user is taken. Both parameters must
1383 be non-negative integers."
1384 ;; Modern Unices allow chown only for root. So we might need
1385 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1386 ;; working with su(do)? when it is needed, so it shall succeed in
1387 ;; the majority of cases.
1388 ;; Don't modify `last-coding-system-used' by accident.
1393 ;; If we are root on the local host, we can do it directly.
1401 "chown %d:%d %s" uid gid
1404 ;; We handle also the local part, because there doesn't exist
1405 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1409 nil "chown" nil nil nil
1413 "Check, whether SELINUX is enabled on the remote host."
1425 "Like `file-selinux-context' for Tramp files."
1434 "%s -d -Z %s"
1442 ;; Return the context.
1443 context))))
1446 "Like `set-file-selinux-context' for Tramp files."
1463 t)
1465 nil)))
1468 "Check, whether ACL is enabled on the remote host."
1473 "Like `file-acl' for Tramp files."
1479 "getfacl -ac %s 2>/dev/null"
1489 "Like `set-file-acl' for Tramp files."
1496 tramp-end-of-heredoc
1497 acl-string
1498 tramp-end-of-heredoc))
1500 ;; Success.
1503 t)
1504 ;; In case of errors, we return `nil'.
1506 nil)))
1508 ;; Simple functions using the `test' command.
1511 "Like `file-executable-p' for Tramp files."
1514 ;; Examine `file-attributes' cache to see if request can be
1515 ;; satisfied without remote operation.
1520 "Like `file-readable-p' for Tramp files."
1523 ;; Examine `file-attributes' cache to see if request can be
1524 ;; satisfied without remote operation.
1528 ;; When the remote shell is started, it looks for a shell which groks
1529 ;; tilde expansion. Here, we assume that all shells which grok tilde
1530 ;; expansion will also provide a `test' command which groks `-nt' (for
1531 ;; newer than). If this breaks, tell me about it and I'll try to do
1532 ;; something smarter about it.
1534 "Like `file-newer-than-file-p' for Tramp files."
1536 nil)
1538 t)
1539 ;; We are sure both files exist at this point.
1542 ;; We try to get the mtime of both files. If they are not
1543 ;; equal to the "dont-know" value, then we subtract the times
1544 ;; and obtain the result.
1550 ;; If one of them is the dont-know value, then we can
1551 ;; still try to run a shell command on the remote host.
1552 ;; However, this only works if both files are Tramp
1553 ;; files and both have the same method, same user, same
1554 ;; host.
1559 v 'file-error
1560 "Files %s and %s must have same method, user, host"
1561 file1 file2)))
1566 ;; Functions implemented using the basic functions above.
1569 "Like `file-directory-p' for Tramp files."
1571 ;; `file-directory-p' is used as predicate for file name completion.
1572 ;; Sometimes, when a connection is not established yet, it is
1573 ;; desirable to return t immediately for "/method:foo:". It can
1574 ;; be expected that this is always a directory.
1580 "Like `file-writable-p' for Tramp files."
1584 ;; Examine `file-attributes' cache to see if request can be
1585 ;; satisfied without remote operation.
1588 ;; If file doesn't exist, check if directory is writable.
1593 "Like `file-ownership-preserved-p' for Tramp files."
1597 ;; Return t if the file doesn't exist, since it's true that no
1598 ;; information would be lost by an (attempted) delete and create.
1605 ;; Directory listings.
1609 "Like `directory-files-and-attributes' for Tramp files."
1613 directory full match nosort id-format)
1615 ;; Do it directly.
1623 v localname
1633 v localname id-format))
1636 v localname id-format)))))))))
1637 result item)
1647 result
1652 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1655 vec tramp-perl-directory-files-and-attributes
1659 vec
1663 object))
1667 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1670 vec
1673 ;; We must care about file names with spaces, or starting with
1674 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1675 ;; but it does not work on all remote systems. Therefore, we
1676 ;; quote the file names via sed.
1678 "xargs %s -c "
1687 ;; This function should return "foo/" for directories and "bar" for
1688 ;; files.
1690 "Like `file-name-all-completions' for Tramp files."
1695 filename
1697 'list
1699 ;; Try cache entries for `filename', `filename' with last
1700 ;; character removed, `filename' with last two characters
1701 ;; removed, ..., and finally the empty string - all
1702 ;; concatenated to the local directory name.
1705 tramp-completion-reread-directory-timeout)))
1707 ;; This is inefficient for very long file names, pity
1708 ;; `reduce' is not available...
1711 'append
1716 v
1718 "file-name-all-completions"
1719 nil)))
1721 ;; We cannot use a length of 0, because file properties
1722 ;; for "foo" and "foo/" are identical.
1725 ;; Cache expired or no matching cache entry found so we need
1726 ;; to perform a remote operation.
1728 ;; Get a list of directories and files, including reliably
1729 ;; tagging the directories with a trailing '/'. Because I
1730 ;; rock. --daniel@danann.net
1732 ;; Changed to perform `cd' in the same remote op and only
1733 ;; get entries starting with `filename'. Capture any `cd'
1734 ;; error messages. Ensure any `cd' and `echo' aliases are
1735 ;; ignored.
1737 v
1741 v tramp-perl-file-name-all-completions
1747 ;; `read-file-name-completion-ignore-case'
1748 ;; is introduced with Emacs 22.1.
1751 'read-file-name-completion-ignore-case
1757 ;; `ls' with wildcard might fail with `Argument
1758 ;; list too long' error in some corner cases; if
1759 ;; `ls' fails after `cd' succeeded, chances are
1760 ;; that's the case, so let's retry without
1761 ;; wildcard. This will return "too many" entries
1762 ;; but that isn't harmful.
1763 " || %s -a 2>/dev/null)"
1764 " | while IFS= read f; do"
1770 ;; When `filename' is empty, just `ls' without
1771 ;; `filename' argument is more efficient than `ls *'
1772 ;; for very large directories and might avoid the
1773 ;; `Argument list too long' error.
1774 ;;
1775 ;; With and only with wildcard, we need to add
1776 ;; `-d' to prevent `ls' from descending into
1777 ;; sub-directories.
1779 "."
1784 ;; Now grab the output.
1788 ;; Check result code, found in last line of output.
1792 ;; Grab error message from line before last line
1793 ;; (it was put there by `cd 2>&1').
1796 v 'file-error
1797 "tramp-sh-handle-file-name-all-completions: %s"
1799 ;; For peace of mind, if buffer doesn't end in `fail'
1800 ;; then it should end in `ok'. If neither are in the
1801 ;; buffer something went seriously wrong on the remote
1802 ;; side.
1805 v 'file-error
1806 "\
1807 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1813 ;; Because the remote op went through OK we know the
1814 ;; directory we `cd'-ed to exists.
1817 ;; Because the remote op went through OK we know every
1818 ;; file listed by `ls' exists.
1822 result)
1824 ;; Store result in the cache.
1829 ;; cp, mv and ln
1833 "Like `add-name-to-file' for Tramp files."
1838 v 'file-error
1839 "add-name-to-file: %s"
1848 "File %s already exists; make it a new name anyway? "
1849 newname)))
1856 v1
1860 "error with add-name-to-file, see buffer `%s' for details"
1865 preserve-uid-gid preserve-extended-attributes)
1866 "Like `copy-file' for Tramp files."
1870 ;; At least one file a Tramp file?
1874 'copy filename newname ok-if-already-exists keep-date
1875 preserve-uid-gid preserve-extended-attributes))
1876 ;; Compat section.
1879 'copy-file
1881 preserve-uid-gid preserve-extended-attributes)))
1884 'copy-file
1892 "Like `copy-directory' for Tramp files."
1898 ;; When DIRNAME and NEWNAME are remote, they must have
1899 ;; the same method.
1905 ;; scp or rsync DTRT.
1919 ;; We must do it file-wise.
1921 'copy-directory
1926 ;; When newname did exist, we have wrong cached values.
1934 "Like `rename-file' for Tramp files."
1935 ;; Check if both files are local -- invoke normal rename-file.
1936 ;; Otherwise, use Tramp from local system.
1939 ;; At least one file a Tramp file?
1949 preserve-uid-gid preserve-extended-attributes)
1950 "Copy or rename a remote file.
1951 OP must be `copy' or `rename' and indicates the operation to perform.
1952 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1953 the new file (for copy) or the new name of the file (for rename).
1954 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1955 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1956 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1957 the uid and gid if both files are on the same host.
1958 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1960 This function is invoked by `tramp-sh-handle-copy-file' and
1961 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1962 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1963 file names."
1980 filename newname)
1983 ;; Both are Tramp files.
1988 ;; Shortcut: if method, host, user are the same for
1989 ;; both files, we invoke `cp' or `mv' on the remote
1990 ;; host directly.
1993 op filename newname
1994 ok-if-already-exists keep-date preserve-uid-gid))
1996 ;; Try out-of-band operation.
2001 op filename newname keep-date))
2003 ;; No shortcut was possible. So we copy the file
2004 ;; first. If the operation was `rename', we go back
2005 ;; and delete the original file (if the copy was
2006 ;; successful). The approach is simple-minded: we
2007 ;; create a new buffer, insert the contents of the
2008 ;; source file into it, then write out the buffer to
2009 ;; the target file. The advantage is that it doesn't
2010 ;; matter which file name handlers are used for the
2011 ;; source and target file.
2014 op filename newname keep-date))))))
2016 ;; One file is a Tramp file, the other one is local.
2019 ;; Fast track on local machine.
2022 op filename newname
2023 ok-if-already-exists keep-date preserve-uid-gid))
2025 ;; If the Tramp file has an out-of-band method, the
2026 ;; corresponding copy-program can be invoked.
2029 op filename newname keep-date))
2031 ;; Use the inline method via a Tramp buffer.
2033 op filename newname keep-date))))
2036 ;; One of them must be a Tramp file.
2039 ;; Handle `preserve-extended-attributes'. We ignore possible
2040 ;; errors, because ACL strings could be incompatible.
2045 ;; In case of `rename', we must flush the cache of the source file.
2051 ;; When newname did exist, we have wrong cached values.
2058 "Use an Emacs buffer to copy or rename a file.
2059 First arg OP is either `copy' or `rename' and indicates the operation.
2060 FILENAME is the source file, NEWNAME the target file.
2061 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2063 ;; We must disable multibyte, because binary data shall not be
2064 ;; converted.
2069 ;; We don't want the target file to be compressed, so we let-bind
2070 ;; `jka-compr-inhibit' to t.
2074 ;; KEEP-DATE handling.
2076 ;; Set the mode.
2078 ;; If the operation was `rename', delete the original file.
2083 "Invokes `cp' or `mv' on the remote system.
2084 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2085 respectively. FILENAME specifies the file to copy or rename,
2086 NEWNAME is the name of the new file (for copy) or the new name of
2087 the file (for rename). Both files must reside on the same host.
2088 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2089 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2090 the uid and gid from FILENAME."
2100 v 'file-error
2101 "Unknown operation `%s', must be `copy' or `rename'"
2102 op))))
2106 filename))
2110 newname))
2112 cmd-result)
2115 ;; Both files are on a remote host, with same user.
2127 ;; Mask cp -f error.
2129 tramp-operation-not-permitted-regexp nil t))
2130 cmd-result)
2132 nil v 'file-error
2133 "Copying directly failed, see buffer `%s' for details."
2136 ;; We are on the local host.
2139 ;; We can do it directly.
2142 ;; No sticky bit when renaming.
2153 localname1 localname2 ok-if-already-exists
2154 keep-date preserve-uid-gid)
2158 ;; We can do it directly with `tramp-send-command'
2166 ok-if-already-exists keep-date t)
2167 ;; We must change the ownership to the local user.
2173 ;; We need a temporary file in between.
2175 ;; Create the temporary file.
2183 "%s %s %s" cmd
2186 "Copying directly failed, see buffer `%s' for details."
2188 ;; We must change the ownership as remote user.
2189 ;; Since this does not work reliable, we also
2190 ;; give read permissions.
2201 localname1 tmpfile t
2202 keep-date preserve-uid-gid)
2204 'rename-file
2206 ;; We must change the ownership as local user.
2207 ;; Since this does not work reliable, we also
2208 ;; give read permissions.
2212 tmpfile
2216 ;; Move the temporary file to its destination.
2221 "cp -f -p %s %s"
2224 "Copying directly failed, see buffer `%s' for details."
2228 'rename-file
2231 ;; Save exit.
2234 ;; Set the time and mode. Mask possible errors.
2241 "Invoke `scp' program to copy.
2242 The method used must be an out-of-band method."
2246 copy-program copy-args copy-env copy-keep-date port listener spec
2247 options source target remote-copy-program remote-copy-args)
2252 ;; Both are Tramp files. We shall optimize it when the
2253 ;; methods for FILENAME and NEWNAME are the same.
2263 op filename tmpfile keep-date)
2266 ;; Save exit.
2273 ;; Set variables for computing the prompt for reading
2274 ;; password.
2281 ;; Expand hops. Might be necessary for gateway methods.
2285 ;; Check which ones of source and target are Tramp files.
2294 'file-name-directory
2300 ;; Check for host and port number. We cannot use
2301 ;; `tramp-file-name-port', because this returns also
2302 ;; `tramp-default-port', which might clash with settings in
2303 ;; "~/.ssh/config".
2310 ;; Check for user. There might be an interactive setting.
2314 ;; Check for listener port.
2321 ;; Compose copy command.
2331 spec)
2333 ?h host ?u user ?p port ?r listener ?c options
2340 copy-args
2342 ;; " " has either been a replacement of "%k" (when
2343 ;; keep-date argument is non-nil), or a replacement
2344 ;; for the whole keep-date sublist.
2345 " "
2349 copy-args)
2352 copy-args
2356 copy-env
2358 nil
2365 remote-copy-program
2375 remote-copy-args
2379 ;; Check for local copy program.
2384 ;; Install listener on the remote side. The prompt must be
2385 ;; consumed later on, when the process does not listen anymore.
2392 v 'file-error
2396 'identity
2404 v 'file-error
2405 "Listener process not running on remote host: `%s'"
2406 remote-copy-program))
2414 ;; The default directory must be remote.
2418 ;; Set the transfer process properties.
2428 copy-args
2430 copy-args
2435 ;; Use an asynchronous process. By this, password can
2436 ;; be handled. We don't set a timeout, because the
2437 ;; copying of large files can last longer than 60
2438 ;; secs.
2442 copy-program
2444 copy-args
2453 p v nil tramp-actions-copy-out-of-band)
2455 ;; Check the return code.
2460 orig-vec 'file-error
2461 "Couldn't find exit status of `%s'"
2467 orig-vec 'file-error
2468 "Error copying: `%s'"
2471 ;; Reset the transfer process properties.
2474 ;; Clear the remote prompt.
2477 ;; Houston, we have a problem! Likely, the listener is
2478 ;; still running, so let's clear everything (but the
2479 ;; cached password).
2482 ;; Handle KEEP-DATE argument.
2486 ;; Set the mode.
2491 ;; If the operation was `rename', delete the original file.
2498 "Like `make-directory' for Tramp files."
2510 "Like `delete-directory' for Tramp files."
2522 "Like `delete-file' for Tramp files."
2533 ;; Dired.
2535 ;; CCC: This does not seem to be enough. Something dies when
2536 ;; we try and delete two directories under Tramp :/
2538 "Recursively delete the directory given.
2539 This is like `dired-recursive-delete-directory' for Tramp files."
2541 ;; Run a shell command 'rm -r <localname>'.
2542 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2545 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2547 v
2549 ;; Don't read the output, do it explicitly.
2550 nil t)
2551 ;; Wait for the remote system to return to us...
2552 ;; This might take a while, allow it plenty of time.
2554 ;; Make sure that it worked...
2562 "Like `dired-compress-file' for Tramp files."
2563 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2564 ;; Code stolen mainly from dired-aux.el.
2570 ;; Emacs case
2572 ;; XEmacs has `dired-compression-method-alist', which is
2573 ;; transformed into `dired-compress-file-suffixes' structure.
2577 nil
2580 suffix)
2581 ;; See if any suffix rule matches this file name.
2589 nil)
2591 ;; We found an uncompression rule.
2597 ;; `dired-remove-file' is not defined in XEmacs.
2602 ;; We don't recognize the file as compressed, so compress it.
2603 ;; Try gzip.
2608 ;; `dired-remove-file' is not defined in XEmacs.
2618 "Like `insert-directory' for Tramp files."
2625 filename switches wildcard full-directory-p)
2645 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2646 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2649 v
2652 switches
2654 localname
2657 v
2661 "Couldn't `cd %s'"
2665 v
2668 switches
2673 ""
2681 ;; We cannot use `insert-buffer-substring' because the Tramp
2682 ;; buffer changes its contents before insertion due to calling
2683 ;; `expand-file' and alike.
2688 ;; Check for "--dired" output.
2695 ;; Now read the numeric positions of file names.
2701 ;; End is followed by \n or by " -> ".
2703 ;; Remove trailing lines.
2709 ;; Some busyboxes are reluctant to discard colors.
2716 ;; Decode the output, it could be multibyte.
2723 ;; The inserted file could be from somewhere else.
2730 "."
2737 ;; Canonicalization of file names.
2740 "Like `expand-file-name' for Tramp files.
2742 the result will be a local, non-Tramp, file name."
2743 ;; If DIR is not given, use `default-directory' or "/".
2745 ;; Unless NAME is absolute, concat DIR and NAME.
2748 ;; If NAME is not a Tramp file, run the real handler.
2751 ;; Dissect NAME.
2755 ;; Tilde expansion if necessary. This needs a shell which
2756 ;; groks tilde expansion! The function `tramp-find-shell' is
2757 ;; supposed to find such a shell on the remote host. Please
2758 ;; tell me about it when this doesn't work on your system.
2762 ;; We cannot simply apply "~/", because under sudo "~/" is
2763 ;; expanded to the local user home directory but to the
2764 ;; root home directory. On the other hand, using always
2765 ;; the default user name for tilde expansion is not
2766 ;; appropriate either, because ssh and companions might
2767 ;; use a user name from the config file.
2779 ;; There might be a double slash, for example when "~/"
2780 ;; expands to "/". Remove this.
2783 ;; No tilde characters in file name, do normal
2784 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2785 ;; `directory-sep-char' here for XEmacs on Windows, which would
2786 ;; otherwise use backslash. `default-directory' is bound,
2787 ;; because on Windows there would be problems with UNC shares or
2788 ;; Cygwin mounts.
2792 method user host
2796 hop)))))
2798 ;;; Remote commands:
2801 "Flush file caches."
2809 ;; We use BUFFER also as connection buffer during setup. Because of
2810 ;; this, its original contents must be saved, and restored once
2811 ;; connection has been setup.
2813 "Like `start-file-process' for Tramp files."
2816 ;; it might be that the arguments exceed the command line
2817 ;; length. Therefore, we modify the command.
2822 ;; When PROGRAM is nil, we just provide a tty.
2828 args
2837 ;; Use a human-friendly prompt, for example for `shell'.
2841 tramp-initial-end-of-output))
2852 ;; We do not want to raise an error when
2853 ;; `start-file-process' has been started several time in
2854 ;; `eshell' and friends.
2858 ;; BUFFER can be nil. We use a temporary buffer.
2861 ;; NAME must be unique as process name.
2865 ;; Set the new process properties.
2871 ;; We catch this event. Otherwise, `start-process' could
2872 ;; be called on the local host.
2875 ;; Activate narrowing in order to save BUFFER
2876 ;; contents. Clear also the modification time;
2877 ;; otherwise we might be interrupted by
2878 ;; `verify-visited-file-modtime'.
2884 ;; We call `tramp-maybe-open-connection', in order
2885 ;; to cleanup the prompt afterwards.
2891 ;; Now do it.
2893 ;; Send the command.
2895 ;; Check, whether a pty is associated.
2899 v 'file-error
2902 ;; Set query flag and process marker for this
2903 ;; process. We ignore errors, because the process
2904 ;; could have finished already.
2908 ;; Return process.
2909 p))))
2911 ;; Save exit.
2922 "Like `process-file' for Tramp files."
2923 ;; The implementation is not complete yet.
2929 ;; Compute command.
2932 ;; Determine input.
2937 ;; INFILE is on the same remote host.
2939 ;; INFILE must be copied to remote host.
2945 ;; Determine output.
2947 ;; Just a buffer.
2950 ;; A buffer name.
2953 ;; (REAL-DESTINATION ERROR-DESTINATION)
2955 ;; output.
2963 ;; stderr.
2968 ;; stderr is on the same remote host.
2971 ;; stderr must be copied to remote host. The temporary
2972 ;; file must be deleted after execution.
2975 method user host stderr))))
2976 ;; stderr to be discarded.
2979 ;; 't
2984 ;; Send the command. It might not return in time, so we protect
2985 ;; it. Call it in a subshell, in order to preserve working
2986 ;; directory.
2993 command)
2994 t t)
2996 ;; We should add the output anyway.
3003 ;; When the user did interrupt, we should do it also. We use
3004 ;; return code -1 as marker.
3008 ;; Handle errors.
3013 ;; Provide error file.
3016 ;; Cleanup. We remove all file cache values for the connection,
3017 ;; because the remote process could have changed them.
3020 ;; `process-file-side-effects' has been introduced with GNU
3021 ;; Emacs 23.2. If set to `nil', no remote file will be changed
3022 ;; by `program'. If it doesn't exist, we assume its default
3023 ;; value `t'.
3028 ;; Return exit status.
3031 ret))))
3034 "Like `file-local-copy' for Tramp files."
3038 v 'file-error
3048 ;; `copy-file' handles direct copy and out-of-band methods.
3053 ;; Use inline encoding for file transfer.
3057 v 3
3065 tmpfile loc-dec)
3067 ;; If local decoding is a function, we call it.
3068 ;; We must disable multibyte, because
3069 ;; `uudecode-decode-region' doesn't handle it
3070 ;; correctly.
3075 ;; Unset `file-name-handler-alist'. Otherwise,
3076 ;; epa-file gets confused.
3082 ;; If tramp-decoding-function is not defined for this
3083 ;; method, we invoke tramp-decoding-command instead.
3085 ;; Unset `file-name-handler-alist'. Otherwise,
3086 ;; epa-file gets confused.
3094 loc-dec tmpfile2 tmpfile)
3097 ;; Set proper permissions.
3099 ;; Set local user ownership.
3102 ;; Oops, I don't know what to do.
3106 ;; Error handling.
3112 tmpfile)))
3114 ;; This is needed for XEmacs only. Code stolen from files.el.
3117 "Like `insert-file-contents-literally' for Tramp files."
3125 nil))
3132 ;; Save exit.
3137 ;; CCC grok LOCKNAME
3140 "Like `write-region' for Tramp files."
3143 ;; Following part commented out because we don't know what to do about
3144 ;; file locking, and it does not appear to be a problem to ignore it.
3145 ;; Ange-ftp ignores it, too.
3146 ;; (when (and lockname (stringp lockname))
3147 ;; (setq lockname (expand-file-name lockname)))
3148 ;; (unless (or (eq lockname nil)
3149 ;; (string= lockname filename))
3150 ;; (error
3151 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3153 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3164 ;; `file-writable-p' calls `file-expand-file-name'. We
3165 ;; cannot use `tramp-run-real-handler' therefore.
3171 ;; Short track: if we are on the local host, we can run directly.
3173 'write-region
3177 ;; We use this to save the value of
3178 ;; `last-coding-system-used' after writing the tmp
3179 ;; file. At the end of the function, we set
3180 ;; `last-coding-system-used' to this saved value. This
3181 ;; way, any intermediary coding systems used while
3182 ;; talking to the remote shell or suchlike won't hose
3183 ;; this variable. This approach was snarfed from
3184 ;; ange-ftp.el.
3185 coding-system-used
3186 ;; Write region into a tmp file. This isn't really
3187 ;; needed if we use an encoding function, but currently
3188 ;; we use it always because this makes the logic
3189 ;; simpler. We must also set `temporary-file-directory',
3190 ;; because it could point to a remote directory.
3196 ;; If `append' is non-nil, we copy the file locally, and let
3197 ;; the native `write-region' implementation do the job.
3200 ;; We say `no-message' here because we don't want the
3201 ;; visited file modtime data to be clobbered from the temp
3202 ;; file. We call `set-visited-file-modtime' ourselves later
3203 ;; on. We must ensure that `file-coding-system-alist'
3204 ;; matches `tmpfile'.
3210 'write-region
3217 ;; Now, `last-coding-system-used' has the right value. Remember it.
3222 ;; The permissions of the temporary file should be set. If
3223 ;; FILENAME does not exist (eq modes nil) it has been
3224 ;; renamed to the backup file. This case `save-buffer'
3225 ;; handles permissions.
3226 ;; Ensure that it is still readable.
3229 tmpfile
3232 ;; This is a bit lengthy due to the different methods
3233 ;; possible for file transfer. First, we check whether the
3234 ;; method uses an scp program. If so, we call it.
3235 ;; Otherwise, both encoding and decoding command must be
3236 ;; specified. However, if the method _also_ specifies an
3237 ;; encoding function, then that is used for encoding the
3238 ;; contents of the tmp file.
3243 ;; `copy-file' handles direct copy and out-of-band methods.
3254 ;; We keep the local file for performance
3255 ;; reasons, useful for "rsync".
3262 ;; Don't rename, in order to keep context in SELinux.
3267 ;; Use inline file transfer.
3269 ;; Encode tmpfile.
3273 ;; Use encoding function or command.
3276 tmpfile loc-enc)
3278 ;; The following `let' is a workaround for
3279 ;; the base64.el that comes with pgnus-0.84.
3280 ;; If both of the following conditions are
3281 ;; satisfied, it tries to write to a local
3282 ;; file in default-directory, but at this
3283 ;; point, default-directory is remote.
3284 ;; (`call-process-region' can't write to
3285 ;; remote files, it seems.) The file in
3286 ;; question is a tmp file anyway.
3294 loc-enc tmpfile t))
3296 v 'file-error
3299 filename loc-enc))))
3301 ;; Send buffer into remote decoding command which
3302 ;; writes to remote file. Because this happens on
3303 ;; the remote host, we cannot use the function.
3306 filename rem-dec)
3310 v
3314 tramp-end-of-heredoc
3316 tramp-end-of-heredoc))
3318 v nil
3319 "Couldn't write region to `%s', decode using `%s' failed"
3320 filename rem-dec)
3321 ;; When `file-precious-flag' is set, the region is
3322 ;; written to a temporary file. Check that the
3323 ;; checksum is equal to that from the local tmpfile.
3327 ;; cksum runs locally, if possible.
3329 ;; cksum runs remotely.
3331 v
3334 ;; ... they are different.
3341 v 'file-error
3344 filename rem-dec)))))
3346 ;; Save exit.
3349 ;; That's not expected.
3352 v 'file-error
3355 method))))
3357 ;; Make `last-coding-system-used' have the right value.
3364 ;; We must protect `last-coding-system-used', now we have set it
3365 ;; to its correct value.
3367 ;; Set file modification time.
3371 ;; We must pass modtime explicitly, because FILENAME can
3372 ;; be different from (buffer-file-name), f.e. if
3373 ;; `file-precious-flag' is set.
3379 ;; Set the ownership.
3389 ;; VC backends check for the existence of various different special
3390 ;; files. This is very time consuming, because every single check
3391 ;; requires a remote command (the file cache must be invalidated).
3392 ;; Therefore, we apply a kind of optimization. We install the file
3393 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3394 ;; remembers all file names for which `file-exists-p' or
3395 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3396 ;; is performed. Afterwards, a script is applied for all collected
3397 ;; file names, using just one remote command. The result of this
3398 ;; script is used to fill the file cache with actual values. Now we
3399 ;; can reset the file name handlers, and we make a second run of
3400 ;; `vc-registered', which returns the expected result without sending
3401 ;; any other remote command.
3403 "Like `vc-registered' for Tramp files."
3409 ;; There could be new files, created by the vc backend. We
3410 ;; cannot reuse the old cache entries, therefore. In
3411 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3412 ;; could also be a timestamp as `current-time' returns. This
3413 ;; means invalidate all cache entries with an older timestamp.
3419 ;; Here we collect only file names, which need an operation.
3423 ;; Send just one command, in order to fill the cache.
3426 v
3435 ;; We cannot use `tramp-send-command-and-read',
3436 ;; because this does not cooperate well with
3437 ;; heredoc documents.
3439 v
3442 tramp-end-of-heredoc
3444 tramp-vc-registered-file-names
3446 tramp-end-of-heredoc))
3448 ;; Read the expression.
3455 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3456 ;; calls shall be answered from the file cache. We unset
3457 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3458 ;; in order to keep the cache.
3460 remote-file-name-inhibit-cache process-file-side-effects)
3461 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3480 ;; Run.
3484 ;;;###tramp-autoload
3486 "Invoke remote-shell Tramp file name handler.
3487 Fall back to normal file name handler if no Tramp handler exists."
3505 "Invoke special file name handler, which collects files to be handled."
3513 ;; That's what we want: file names, for which checks are
3514 ;; applied. We assume that VC uses only `file-exists-p' and
3515 ;; `file-readable-p' checks; otherwise we must extend the
3516 ;; list. We do not perform any action, but return nil, in
3517 ;; order to keep `vc-registered' running.
3520 nil)
3521 ;; `process-file' and `start-file-process' shall be ignored.
3524 ;; Tramp file name handlers like `expand-file-name'. They
3525 ;; must still work.
3527 ;; Default file name handlers, we don't care.
3531 "Like `file-notify-add-watch' for Tramp files."
3535 command events filter p sequence)
3537 ;; gvfs-monitor-dir.
3541 ;; inotifywait.
3544 events
3551 ;; None.
3553 v 'file-notify-error
3554 "No file notification program found on %s"
3556 ;; Start process.
3558 'start-file-process
3562 sequence))
3563 ;; Return the process object as watch-descriptor.
3566 v 'file-notify-error
3567 "`%s' failed to start on remote host"
3573 p))))
3585 ;; Attribute change is returned in unused wording.
3595 string)
3598 proc
3602 ;; File names are returned as absolute paths. We must
3603 ;; add the remote prefix.
3608 ;; Usually, we would add an Emacs event now. Unfortunately,
3609 ;; `unread-command-events' does not accept several events at
3610 ;; once. Therefore, we apply the callback directly.
3613 ;; Save rest of the string.
3622 ;; Check, whether there is a problem.
3628 line)
3633 proc
3640 ;; Usually, we would add an Emacs event now. Unfortunately,
3641 ;; `unread-command-events' does not accept several events at
3642 ;; once. Therefore, we apply the callback directly.
3645 ;;; Internal Functions:
3648 "Define in remote shell function NAME implemented as SCRIPT.
3649 Only send the definition if it has not already been done."
3650 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3651 ;; might be nil.
3656 ;; The script could contain a call of Perl. This is masked with `%s'.
3661 vec
3672 auto-save-default)
3680 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3681 Returns the exit code of the `test' program."
3684 v
3686 "%s %s %s"
3688 switch
3692 "Run `test'-like program on the remote system, given FILE1, FILE2.
3693 FORMAT-STRING contains the program name, switches, and place holders.
3694 Returns the exit code of the `test' program. Barfs if the methods,
3695 hosts, or files, disagree."
3699 v 'file-error
3704 v1
3711 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3712 First arg VEC specifies the connection, PROGNAME is the program
3713 to search for, and DIRLIST gives the list of directories to
3714 search. If IGNORE-TILDE is non-nil, directory names starting
3715 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3716 only in DIRLIST.
3718 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3720 This function expects to be in the right *tramp* buffer."
3723 ;; Check whether the executable is in $PATH. "which(1)" does not
3724 ;; report always a correct error code; therefore we check the
3725 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3726 ;; 5.11") have problems with this command, we disable the call
3727 ;; therefore.
3738 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3739 ;; `remove' is in CL, and we want to avoid CL dependencies.
3748 vec
3750 "do if test -x $d/%s -a -f $d/%s; "
3751 "then echo tramp_executable $d/%s; "
3754 progname progname progname
3755 tramp-end-of-heredoc
3757 tramp-end-of-heredoc))
3763 result)))
3766 "Sets the remote environment PATH to existing directories.
3767 I.e., for each directory in `tramp-remote-path', it is tested
3768 whether it exists and if so, it is added to the environment
3769 variable PATH."
3775 ;; ------------------------------------------------------------
3776 ;; -- Communication with external shell --
3777 ;; ------------------------------------------------------------
3780 "Find a command on the remote host for checking if a file exists.
3781 Here, we are looking for a command which has zero exit status if the
3782 file exists and nonzero exit status otherwise."
3786 result)
3787 ;; The algorithm is as follows: we try a list of several commands.
3788 ;; For each command, we first run `$cmd /' -- this should return
3789 ;; true, as the root directory always exists. And then we run
3790 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3791 ;; does not exist. This should return false. We use the first
3792 ;; command we find that seems to work.
3793 ;; The list of commands to try is as follows:
3794 ;; `ls -d' This works on most systems, but NetBSD 1.4
3795 ;; has a bug: `ls' always returns zero exit
3796 ;; status, even for files which don't exist.
3797 ;; `test -e' Some Bourne shells have a `test' builtin
3798 ;; which does not know the `-e' option.
3799 ;; `/bin/test -e' For those, the `test' binary on disk normally
3800 ;; provides the option. Alas, the binary
3801 ;; is sometimes `/bin/test' and sometimes it's
3802 ;; `/usr/bin/test'.
3803 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3831 result))
3834 "Opens shell SHELL."
3837 ;; Find arguments for this shell.
3839 item extra-args)
3846 "exec env ENV='' HISTFILE=/dev/null PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3849 t))
3854 "Opens a shell on the remote host which groks tilde expansion."
3862 shell)
3865 ;; CCC: "root" does not exist always, see QNAP 459.
3866 ;; Which check could we apply instead?
3869 ;; The default shell (ksh93) of OpenSolaris and
3870 ;; Solaris is buggy. We've got reports for
3871 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3880 ;; Maybe it works at least for some other commands.
3882 default-shell
3884 vec 2
3886 "Couldn't find a remote shell which groks tilde "
3888 default-shell)))
3890 default-shell)))
3892 ;; Open a new shell if needed.
3898 ;; Utility functions.
3901 "Wait for shell prompt and barf if none appears.
3902 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3903 seconds. If not, it produces an error message with the given ERROR-ARGS."
3907 proc timeout
3916 "Set up an interactive shell.
3917 Mainly sets the prompt and the echo correctly. PROC is the shell
3918 process to set up. VEC specifies the connection."
3920 ;; It is useful to set the prompt in the following command because
3921 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3922 ;; about and thus /bin/sh will display a strange prompt. For
3923 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3924 ;; display the current working directory but /bin/sh will display
3925 ;; a dollar sign. The following command line sets $PS1 to a sane
3926 ;; value, and works under Bourne-ish shells as well as csh-like
3927 ;; shells. Daniel Pittman reports that the unusual positioning of
3928 ;; the single quotes makes it work under `rc', too. We also unset
3929 ;; the variable $ENV because that is read by some sh
3930 ;; implementations (eg, bash when called as sh) on startup; this
3931 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3932 ;; is another way to set the prompt in /bin/bash, it must be
3933 ;; discarded as well.
3935 vec
3940 ;; Disable echo.
3943 ;; Check whether the echo has really been disabled. Some
3944 ;; implementations, like busybox of embedded GNU/Linux, don't
3945 ;; support disabling.
3952 ;; Make sure backspaces and their echo are enabled and no line
3953 ;; width magic interferes with them.
3961 ;; Try to set up the coding system correctly.
3962 ;; CCC this can't be the right way to do it. Hm.
3966 ;; Use MULE to select the right EOL convention for communicating
3967 ;; with the process.
3973 cs-decode cs-encode)
3990 ;; Look for ^M and do something useful if found.
3992 ;; We have found a ^M but cannot frob the process coding system
3993 ;; because we're running on a non-MULE Emacs. Let's try
3994 ;; stty, instead.
3999 ;; Check whether the output of "uname -sr" has been changed. If
4000 ;; yes, this is a strong indication that we must expire all
4001 ;; connection properties. We start again with
4002 ;; `tramp-maybe-open-connection', it will be caught there.
4007 vec "uname"
4011 vec 3
4012 "Connection reset, because remote host changed from `%s' to `%s'"
4013 old-uname new-uname)
4014 ;; We want to keep the password.
4018 ;; Check whether the remote host suffers from buggy
4019 ;; `send-process-string'. This is known for FreeBSD (see comment in
4020 ;; `send_process', file process.c). I've tested sending 624 bytes
4021 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4022 ;; this host type is detected locally. It cannot handle remote
4023 ;; hosts, though.
4027 tramp-chunksize)
4035 ;; Set remote PATH variable.
4038 ;; Search for a good shell before searching for a command which
4039 ;; checks if a file exists. This is done because Tramp wants to use
4040 ;; "test foo; echo $?" to check if various conditions hold, and
4041 ;; there are buggy /bin/sh implementations which don't execute the
4042 ;; "echo $?" part if the "test" part has an error. In particular,
4043 ;; the OpenSolaris /bin/sh is a problem. There are also other
4044 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4045 ;; in function declarations, or changing HISTFILE in place.
4046 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4047 ;; detected.
4050 ;; Disable unexpected output.
4053 ;; IRIX64 bash expands "!" even when in single quotes. This
4054 ;; destroys our shell functions, we must disable it. See
4055 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4059 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4064 ;; Set `remote-tty' process property.
4069 ;; Dump stty settings in the traces.
4073 ;; Set the environment.
4079 unset vars item)
4089 vec
4091 tramp-end-of-heredoc
4093 tramp-end-of-heredoc)
4094 t))
4099 ;; Old text from documentation of tramp-methods:
4100 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4101 ;; of the base64 methods instead since base64 encoding is much more
4102 ;; reliable and the commands are more standardized between the different
4103 ;; Unix versions. But if you can't use base64 for some reason, please
4104 ;; note that the default uudecode command does not work well for some
4105 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4106 ;; the following command for uudecode:
4107 ;;
4108 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4109 ;;
4110 ;; For Irix, no solution is known yet.
4118 "List of local coding commands for inline transfer.
4119 Each item is a list that looks like this:
4121 \(FORMAT ENCODING DECODING\)
4123 FORMAT is symbol describing the encoding/decoding format. It can be
4124 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4126 ENCODING and DECODING can be strings, giving commands, or symbols,
4127 giving functions. If they are strings, then they can contain
4129 file name will be put into the command line at that spot. If the
4130 specifier is not present, the input should be read from standard
4131 input.
4133 If they are functions, they will be called with two arguments, start
4134 and end of region, and are expected to replace the region contents
4139 ;; "-i" is more robust with older base64 from GNU coreutils.
4140 ;; However, I don't know whether all base64 versions do supports
4141 ;; this option.
4153 "List of remote coding commands for inline transfer.
4154 Each item is a list that looks like this:
4156 \(FORMAT ENCODING DECODING [TEST]\)
4158 FORMAT is a symbol describing the encoding/decoding format. It can be
4159 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4161 ENCODING and DECODING can be strings, giving commands, or symbols,
4162 giving variables. If they are strings, then they can contain
4164 file name will be put into the command line at that spot. If the
4165 specifier is not present, the input should be read from standard
4166 input.
4168 If they are variables, this variable is a string containing a
4169 Perl or Shell implementation for this functionality. This
4170 program will be transferred to the remote host, and it is
4172 specifier in the variable value denotes a temporary file.
4174 The optional TEST command can be used for further tests, whether
4178 "Find an inline transfer encoding that works.
4179 Goes through the list `tramp-local-coding-commands' and
4180 `tramp-remote-coding-commands'."
4185 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4193 ;; If the local encoder or decoder is a string, the
4194 ;; corresponding command has to work locally.
4201 loc-enc nil nil))
4209 loc-dec nil nil))
4211 ;; Search for remote coding commands with the same format
4219 ;; Check the remote test command if exists.
4225 ;; Check if remote perl exists when necessary.
4229 ;; Check if remote encoding and decoding commands can be
4230 ;; called remotely with null input and output. This makes
4231 ;; sure there are no syntax errors and the command is really
4232 ;; found. Note that we do not redirect stdout to /dev/null,
4233 ;; for two reasons: when checking the decoding command, we
4234 ;; actually check the output it gives. And also, when
4235 ;; redirecting "mimencode" output to /dev/null, then as root
4236 ;; it might change the permissions of /dev/null!
4244 vec 5
4253 tmpfile)
4260 tramp-temp-name-prefix
4262 value
4264 value
4266 ?t
4272 vec 5
4275 vec
4277 t)
4285 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4291 ;; Set connection properties. Since the commands are risky
4292 ;; (due to output direction), we cache them in the process cache.
4303 "Call the local encoding or decoding command.
4305 Otherwise, INPUT is passed via standard input.
4306 INPUT can also be nil which means `/dev/null'.
4307 OUTPUT can be a string (which specifies a file name), or t (which
4308 means standard output and thus the current buffer), or nil (which
4309 means discard it)."
4311 nil tramp-encoding-shell
4314 nil
4315 tramp-encoding-command-switch
4325 "List of compress and decompress commands for inline transfer.
4326 Each item is a list that looks like this:
4328 \(COMPRESS DECOMPRESS\)
4333 "Find an inline transfer compress command that works.
4334 Goes through the list `tramp-inline-compress-commands'."
4339 item compress decompress found)
4346 vec 5
4347 "Checking local compress commands `%s', `%s' for sanity"
4348 compress decompress)
4353 ;; Windows shells need the program file name after
4354 ;; the pipe symbol be quoted if they use forward
4355 ;; slashes as directory separators.
4362 vec 5
4363 "Checking remote compress commands `%s', `%s' for sanity"
4364 compress decompress)
4370 ;; Did we find something?
4373 ;; Set connection properties. Since the commands are
4374 ;; risky (due to output direction), we cache them in the
4375 ;; process cache.
4389 "Expands VEC according to `tramp-default-proxies-alist'.
4390 Gateway hops are already opened."
4394 choices proxy)
4396 ;; Ad-hoc proxy definitions.
4401 tramp-prefix-format proxy tramp-postfix-host-format)))
4406 proxy)
4407 ;; Add the hop.
4409 'tramp-default-proxies-alist
4412 proxy))
4414 ;; Save the new value.
4419 ;; Look for proxy hosts to be passed.
4425 ;; Host.
4428 ;; User.
4432 ;; No more hops needed.
4434 ;; Replace placeholders.
4437 proxy
4442 ;; Add the hop.
4444 ;; Start next search.
4447 ;; Handle gateways.
4455 ;; Is the method prepared for gateways?
4458 vec 'file-error
4460 ;; Open the gateway connection.
4465 target-alist)
4466 ;; For the password prompt, we need the correct values.
4467 ;; Therefore, we must remember the gateway vector. But we
4468 ;; cannot do it as connection property, because it shouldn't
4469 ;; be persistent. And we have no started process yet either.
4472 ;; Foreign and out-of-band methods are not supported for multi-hops.
4485 vec 'file-error
4486 "Method `%s' is not supported for multi-hops."
4489 ;; In case the host name is not used for the remote shell
4490 ;; command, the user could be misguided by applying a random
4491 ;; hostname.
4497 ;; There are multi-hops.
4499 ;; The host name is used for the remote shell command.
4502 ;; The host is local. We cannot use `tramp-local-host-p'
4503 ;; here, because it opens a connection as well.
4506 v 'file-error
4507 "Host `%s' looks like a remote host, `%s' can only use the local host"
4508 host method)))
4510 ;; Result.
4511 target-alist))
4514 "Maybe open a connection VEC.
4515 Does not do anything if a connection is already open, but re-opens the
4516 connection if a previous connection has died for some reason."
4524 ;; If Tramp opens the same connection within a short time frame,
4525 ;; there is a problem. We shall signal this.
4534 ;; If too much time has passed since last command was sent, look
4535 ;; whether process is still alive. If it isn't, kill it. When
4536 ;; using ssh, it can sometimes happen that the remote end has hung
4537 ;; up but the local ssh client doesn't recognize this until it
4538 ;; tries to send some data to the remote end. So that's why we
4539 ;; try to send a command from time to time, then look again
4540 ;; whether the process is really alive.
4551 ;; The error will be caught locally.
4557 ;; New connection must be opened.
4561 ;; If `non-essential' is non-nil, don't reopen a new connection.
4566 vec 3
4577 ;; Start new process.
4586 ;; We will apply `tramp-ssh-controlmaster-options'
4587 ;; only for the first hop.
4593 ;; This must be done in order to avoid our file
4594 ;; name handler.
4598 'start-process
4603 tramp-encoding-command-interactive)
4606 ;; Set sentinel and query flag.
4617 ;; Check whether process is alive.
4619 p 10
4622 ;; Now do all the connections as specified.
4651 ;; We don't create the temporary file. In
4652 ;; fact, it is just a prefix for the
4653 ;; ControlPath option of ssh; the real
4654 ;; temporary file has another name, and it is
4655 ;; created and protected by ssh. It is also
4656 ;; removed by ssh when the connection is
4657 ;; closed. The temporary file name is cached
4658 ;; in the main connection process, therefore
4659 ;; we cannot use `tramp-get-connection-process'.
4665 tramp-temp-name-prefix
4667 spec r-shell)
4669 ;; Add arguments for asynchronous processes.
4673 ;; Add gateway arguments if necessary.
4677 ;; Check for port number. Until now, there's no
4678 ;; need for handling like method, user, host.
4683 ;; Check, whether there is a restricted shell.
4688 ;; Set variables for computing the prompt for
4689 ;; reading password. They can also be derived
4690 ;; from a gateway.
4695 ;; Add login environment.
4698 login-env
4703 login-env))
4707 "%s=%s %s"
4710 command)))
4713 ;; Replace `login-args' place holders.
4721 ?h l-host ?u l-user ?p l-port ?c options)
4722 command
4724 ;; We do not want to see the trailing local
4725 ;; prompt in `start-file-process'.
4727 command " "
4733 ;; Local shell could be a Windows COMSPEC. It
4734 ;; doesn't know the ";" syntax, but we must exit
4735 ;; always for `start-file-process'. It could
4736 ;; also be a restricted shell, which does not
4737 ;; allow "exec".
4740 ;; Send the command.
4744 p vec pos tramp-actions-before-shell
4748 ;; Next hop.
4752 ;; Make initial shell settings.
4755 ;; When the user did interrupt, we must cleanup.
4758 ;; Propagate the quit signal.
4762 "Send the COMMAND to connection VEC.
4763 Erases temporary buffer before sending the command. If optional
4764 arg NEVEROPEN is non-nil, never try to open the connection. This
4765 is meant to be used from `tramp-maybe-open-connection' only. The
4766 function waits for output unless NOOUTPUT is set."
4770 ;; We mark the command string that it can be erased in the output buffer.
4772 ;; If we put `tramp-echo-mark' after a trailing newline (which
4773 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4774 ;; that newline and adds `tramp-rsh-end-of-line' right after
4775 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4776 ;; trailing line endings and sends two prompts after executing
4777 ;; the command, which confuses `tramp-wait-for-output'.
4781 ;; No need to restore a trailing newline here since `tramp-send-string'
4782 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4784 ;; Send the command.
4790 "Wait for output from remote command."
4796 ;; be leading escape sequences, which must be ignored.
4798 ;; Sometimes, the commands do not return a newline but a
4799 ;; null byte before the shell prompt, for example "git
4800 ;; ls-files -c -z ...".
4805 ;; A simple-minded busybox has sent " ^H" sequences.
4806 ;; Delete them.
4811 ;; Delete the prompt.
4817 proc 'file-error
4818 "[[Remote prompt `%s' not found in %d secs]]"
4819 tramp-end-of-output timeout)
4821 proc 'file-error
4823 ;; Return value is whether end-of-output sentinel was found.
4824 found)))
4828 "Run COMMAND and check its exit status.
4829 Sends `echo $?' along with the COMMAND for checking the exit status.
4830 If COMMAND is nil, just sends `echo $?'. Returns `t' if the exit
4831 status is 0, and `nil' otherwise.
4833 If the optional argument SUBSHELL is non-nil, the command is
4834 executed in a subshell, ie surrounded by parentheses. If
4835 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4837 vec
4839 command
4841 "echo tramp_exit_status $?"
4855 "Run COMMAND, check exit status, throw error if exit status not okay.
4856 Similar to `tramp-send-command-and-check' but accepts two more arguments
4857 FMT and ARGS which are passed to `error'."
4862 "Run COMMAND and return the output, which must be a Lisp expression.
4863 In case there is no valid Lisp expression and NOERROR is nil, it
4864 raises an error."
4870 ;; Read the expression.
4874 ;; Error handling.
4879 vec 'file-error
4880 "`%s' does not return a valid Lisp expression: `%s'"
4884 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4885 Convert file mode bits to string and set virtual device number.
4886 Return ATTR."
4888 ;; Remove color escape sequences from symlink.
4892 ;; Convert uid and gid. Use -1 as indication of unusable value.
4903 ;; Convert last access time.
4908 ;; Convert last modification time.
4913 ;; Convert last status change time.
4918 ;; Convert file size.
4924 ;; Convert file mode bits to string.
4929 ;; Convert directory indication bit.
4932 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4938 ;; Set file's gid change bit.
4946 ;; Convert inode.
4952 ;; Inodes can be incredible huge. We must hide this.
4954 ;; Set virtual device number.
4957 attr))
4960 "Converts STRING to shell glob pattern which ignores case."
4966 string
4970 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
4978 localname)
4984 "Return t if this is an out-of-band method, nil otherwise."
4986 ;; It shall be an out-of-band method.
4988 ;; There must be a size, otherwise the file doesn't exist.
4990 ;; Either the file size is large enough, or (in rare cases) there
4991 ;; does not exist a remote encoding.
4996 ;; Variables local to connection.
5000 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5001 ;; cache the result for the session only. Otherwise, the result
5002 ;; is cached persistently.
5005 vec)
5006 "remote-path"
5015 ;; Default if "getconf" is not available.
5018 vec 3
5029 nil)))))
5031 ;; Replace place holder `tramp-default-remote-path'.
5039 ;; Replace place holder `tramp-own-remote-path'.
5047 ;; Remove double entries.
5054 ;; Remove non-existing directories.
5056 nil
5066 x))
5067 x))
5068 remote-path)))))
5074 locale)
5080 candidates nil)
5082 ;; Return value.
5092 result)
5094 ;; Check parameters. On busybox, "ls" output coloring is
5095 ;; enabled by default sometimes. So we try to disable it
5096 ;; when possible. $LS_COLORING is not supported there.
5097 ;; Some "ls" versions are sensible wrt the order of
5098 ;; arguments, they fail when "-al" is after the
5099 ;; "--color=never" argument (for example on FreeBSD).
5114 ;; Some "ls" versions are sensible wrt the order of arguments,
5115 ;; they fail when "-al" is after the "--dired" argument (for
5116 ;; example on FreeBSD).
5124 "test"
5128 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5129 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5130 ;; for otherwise the shell crashes.
5142 vec
5165 ;; We must check also for some Perl modules.
5173 result)))
5180 tmp)
5181 ;; Check whether stat(1) returns usable syntax. "%s" does not
5182 ;; work on older AIX systems.
5191 result)))
5201 result))))
5217 ;; Busyboxes do support the "-t" option only when they have been
5218 ;; built with the DESKTOP config option. Let's check it.
5221 vec "touch-t"
5223 vec
5225 "%s -t %s %s"
5226 result
5230 result)))
5249 result)
5251 ;; Check POSIX parameter.
5258 vec
5267 vec
5271 "print $>"
5283 vec
5287 "import os; print (os.getuid())"
5301 ;; Ensure there is a valid result.
5309 vec
5318 vec
5327 vec
5331 "import os; print (os.getgid())"
5345 ;; Ensure there is a valid result.
5351 ;; Some predefined connection properties.
5353 "Return the compress command related to PROP.
5354 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5355 the length of the file to be compressed.
5357 If no corresponding command is found, nil is returned."
5366 "Return the coding command related to PROP.
5367 PROP is either `remote-encoding', `remote-decoding',
5368 `local-encoding' or `local-decoding'.
5370 SIZE is the length of the file to be coded. Depending on SIZE,
5371 compression might be applied.
5373 If no corresponding command is found, nil is returned.
5374 Otherwise, either a string is returned which contains a `%s' mark
5375 to be used for the respective input or output file; or a Lisp
5376 function cell is returned to be applied on a buffer."
5377 ;; We must catch the errors, because we want to return `nil', when
5378 ;; no inline coding is found.
5388 compress)
5389 ;; The connection property might have been cached. So we must
5390 ;; send the script to the remote side - maybe.
5398 ;; Check for the `compress' command.
5400 ;; Return the value.
5416 'call-process-region beg end
5421 coding)
5424 ;; Windows shells need the program file name after
5425 ;; the pipe symbol be quoted if they use forward
5426 ;; slashes as directory separators.
5433 coding compress))
5436 ;; Windows shells need the program file name after
5437 ;; the pipe symbol be quoted if they use forward
5438 ;; slashes as directory separators.
5443 compress coding))
5457 ;;; TODO:
5459 ;; * Don't use globbing for directories with many files, as this is
5460 ;; likely to produce long command lines, and some shells choke on
5461 ;; long command lines.
5462 ;; * Make it work for different encodings, and for different file name
5463 ;; encodings, too. (Daniel Pittman)
5464 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5465 ;; then look if it's the right version (with `perl -v').
5466 ;; * When editing a remote CVS controlled file as a different user, VC
5467 ;; gets confused about the file locking status. Try to find out why
5468 ;; the workaround doesn't work.
5469 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5470 ;; until the last but one hop via `start-file-process'. Apply it
5471 ;; also for ftp and smb.
5472 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5473 ;; some shell with root privileges, it would be nice if I could
5474 ;; just call
5475 ;; trampclient filename.c
5476 ;; as an editor, and the _current_ shell would connect to an Emacs
5477 ;; server and would be used in an existing non-privileged Emacs
5478 ;; session for doing the editing in question.
5479 ;; That way, I need not tell Emacs my password again and be afraid
5480 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5481 ;; once display a just typed password in the context of a keyboard
5482 ;; sequence prompt for a question immediately following in a shell
5483 ;; script run within Emacs -- nasty).
5484 ;; And if I have some ssh session running to a different computer,
5485 ;; having the possibility of passing a local file there to a local
5486 ;; Emacs session (in case I can arrange for a connection back) would
5487 ;; be nice.
5488 ;; Likely the corresponding Tramp server should not allow the
5489 ;; equivalent of the emacsclient -eval option in order to make this
5490 ;; reasonably unproblematic. And maybe trampclient should have some
5491 ;; way of passing credentials, like by using an SSL socket or
5492 ;; something. (David Kastrup)
5493 ;; * Reconnect directly to a compliant shell without first going
5494 ;; through the user's default shell. (Pete Forman)
5495 ;; * How can I interrupt the remote process with a signal
5496 ;; (interrupt-process seems not to work)? (Markus Triska)
5497 ;; * Avoid the local shell entirely for starting remote processes. If
5498 ;; so, I think even a signal, when delivered directly to the local
5499 ;; SSH instance, would correctly be propagated to the remote process
5500 ;; automatically; possibly SSH would have to be started with
5501 ;; "-t". (Markus Triska)
5502 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5503 ;; isn't on the remote host. (Mark A. Hershberger)
5504 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5505 ;; * Optimize out-of-band copying when both methods are scp-like (not
5506 ;; rsync).
5507 ;; * Keep a second connection open for out-of-band methods like scp or
5508 ;; rsync.
5510 ;;; tramp-sh.el ends here