| blob | ae0dad715bf689f718845b6cc142b755221aec90 |
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.
71 is special on Unix systems and indicates the shell history should
72 not be logged (this avoids clutter due to Tramp commands).
74 The symbol `unset' removes any setting of HISTFILE.
76 If you set this variable to nil, however, the *override* is
77 disabled, so the history will go to the default storage
86 ;;;###tramp-autoload
90 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
91 ;; root users. It uses the `$' character for other users. In order
92 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
96 "///%s#$"
98 "String used to recognize end of output.
99 The '$' character at the end is quoted; the string cannot be
102 ;;;###tramp-autoload
109 ;; Initialize `tramp-methods' with the supported methods.
110 ;;;###tramp-autoload
121 ;;;###tramp-autoload
131 ;;;###tramp-autoload
148 ;;;###tramp-autoload
166 ;;;###tramp-autoload
181 ;;;###tramp-autoload
188 ;;;###tramp-autoload
195 ;;;###tramp-autoload
208 ;;;###tramp-autoload
221 ;;;###tramp-autoload
229 ;;;###tramp-autoload
237 ;; We use "-v" for better error tracking.
240 ;; We use "-p" as required for newer busyboxes. For older
241 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
242 ;; can be achieved by tweaking `tramp-connection-properties'.
245 ;;;###tramp-autoload
253 ;;;###tramp-autoload
258 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
263 ;;;###tramp-autoload
271 ;;;###tramp-autoload
278 ;;;###tramp-autoload
282 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
286 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
287 tramp-terminal-type
288 tramp-initial-end-of-output))
293 ;;;###tramp-autoload
299 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
300 tramp-terminal-type
301 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))
324 ;;;###tramp-autoload
331 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
332 tramp-terminal-type
333 tramp-initial-end-of-output))
342 ;;;###tramp-autoload
353 ;;;###tramp-autoload
357 ;;;###tramp-autoload
361 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
362 ;; Do not add "plink" based methods, they ask interactively for the user.
363 ;;;###tramp-autoload
372 ;;;###tramp-autoload
378 ;;;###tramp-autoload
394 ;;;###tramp-autoload
399 ;;;###tramp-autoload
404 ;;;###tramp-autoload
412 ;;;###tramp-autoload
439 ;; "getconf PATH" yields:
440 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
441 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
442 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
443 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
444 ;; IRIX64: /usr/bin
445 ;;;###tramp-autoload
451 "List of directories to search for executables on remote host.
452 For every remote host, this variable will be set buffer local,
453 keeping the list of existing directories on that host.
455 You can use `~' in this list, but when searching for a shell which groks
456 tilde expansion, all directory names starting with `~' will be ignored.
458 `Default Directories' represent the list of directories given by
460 entry on top of this list, because these are the default
461 directories for POSIX compatible commands. On remote hosts which
462 do not offer the getconf command (like cygwin), the value
465 `Private Directories' are the settings of the $PATH environment,
466 as given in your `~/.profile'."
473 ;;;###tramp-autoload
481 "List of environment variables to be set on the remote host.
483 Each element should be a string of the form ENVVARNAME=VALUE. An
484 entry ENVVARNAME= disables the corresponding environment variable,
485 which might have been set in the init files like ~/.profile.
487 Special handling is applied to the PATH environment, which should
488 not be set here. Instead, it should be set via `tramp-remote-path'."
494 "Alist specifying extra arguments to pass to the remote shell.
495 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
496 matching the shell file name and ARGS is a string specifying the
497 arguments.
499 This variable is only used when Tramp needs to start up another shell
500 for tilde expansion. The extra arguments should typically prevent the
501 shell from reading its init file."
503 ;; This might be the wrong way to test whether the widget type
504 ;; `alist' is available. Who knows the right way to test it?
519 "List of pattern/action pairs.
520 Whenever a pattern matches, the corresponding action is performed.
521 Each item looks like (PATTERN ACTION).
523 The PATTERN should be a symbol, a variable. The value of this
524 variable gives the regular expression to search for. Note that the
526 appended to it.
528 The ACTION should also be a symbol, but a function. When the
536 "List of pattern/action pairs.
537 This list is used for copying/renaming with out-of-band methods.
542 "(echo begin 600 %t; tail -n +2) | uudecode
543 cat %t
544 rm -f %t"
545 "Shell function to implement `uudecode' to standard output.
546 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
547 for this or `uudecode -p', but some systems don't, and for them
551 "%s -e '
552 use File::Spec;
555 sub recursive {
556 my ($volume, @dirs) = @_;
557 my $real = realpath(File::Spec->catpath(
559 if ($real) {
560 my ($vol, $dir) = File::Spec->splitpath($real, 1);
561 return ($vol, File::Spec->splitdir($dir));
562 }
563 else {
564 my $last = pop(@dirs);
565 ($volume, @dirs) = recursive($volume, @dirs);
566 push(@dirs, $last);
567 return ($volume, @dirs);
568 }
569 }
571 $result = realpath($ARGV[0]);
572 if (!$result) {
573 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
574 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
577 }
581 }
585 "Perl script to produce output suitable for use with `file-truename'
586 on the remote file system.
587 Escape sequence %s is replaced with name of Perl binary.
591 "%s -e 'sub case {
592 my $str = shift;
593 if ($ARGV[2]) {
594 return lc($str);
595 }
596 else {
597 return $str;
598 }
599 }
601 @files = readdir(d); closedir(d);
602 foreach $f (@files) {
603 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
606 }
607 else {
609 }
610 }
611 }
614 "Perl script to produce output suitable for use with
615 `file-name-all-completions' on the remote file system. Escape
616 sequence %s is replaced with name of Perl binary. This string is
619 ;; Perl script to implement `file-attributes' in a Lisp `read'able
620 ;; output. If you are hacking on this, note that you get *no* output
621 ;; unless this spits out a complete line, including the '\n' at the
622 ;; end.
623 ;; The device number is returned as "-1", because there will be a virtual
624 ;; device number set in `tramp-sh-handle-file-attributes'.
626 "%s -e '
627 @stat = lstat($ARGV[0]);
628 if (!@stat) {
630 exit 0;
631 }
632 if (($stat[2] & 0170000) == 0120000)
633 {
634 $type = readlink($ARGV[0]);
636 }
637 elsif (($stat[2] & 0170000) == 040000)
638 {
640 }
641 else
642 {
644 };
647 printf(
649 $type,
650 $stat[3],
651 $uid,
652 $gid,
653 $stat[8] >> 16 & 0xffff,
654 $stat[8] & 0xffff,
655 $stat[9] >> 16 & 0xffff,
656 $stat[9] & 0xffff,
657 $stat[10] >> 16 & 0xffff,
658 $stat[10] & 0xffff,
659 $stat[7],
660 $stat[2],
661 $stat[1] >> 16 & 0xffff,
662 $stat[1] & 0xffff
664 "Perl script to produce output suitable for use with `file-attributes'
665 on the remote file system.
666 Escape sequence %s is replaced with name of Perl binary.
670 "%s -e '
673 @list = readdir(DIR);
674 closedir(DIR);
675 $n = scalar(@list);
677 for($i = 0; $i < $n; $i++)
678 {
679 $filename = $list[$i];
680 @stat = lstat($filename);
681 if (($stat[2] & 0170000) == 0120000)
682 {
683 $type = readlink($filename);
685 }
686 elsif (($stat[2] & 0170000) == 040000)
687 {
689 }
690 else
691 {
693 };
696 printf(
697 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
698 $filename,
699 $type,
700 $stat[3],
701 $uid,
702 $gid,
703 $stat[8] >> 16 & 0xffff,
704 $stat[8] & 0xffff,
705 $stat[9] >> 16 & 0xffff,
706 $stat[9] & 0xffff,
707 $stat[10] >> 16 & 0xffff,
708 $stat[10] & 0xffff,
709 $stat[7],
710 $stat[2],
711 $stat[1] >> 16 & 0xffff,
712 $stat[1] & 0xffff,
713 $stat[0] >> 16 & 0xffff,
714 $stat[0] & 0xffff);
715 }
717 "Perl script implementing `directory-files-attributes' as Lisp `read'able
718 output.
719 Escape sequence %s is replaced with name of Perl binary.
722 ;; These two use base64 encoding.
724 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
725 "Perl program to use for encoding a file.
726 Escape sequence %s is replaced with name of Perl binary.
727 This string is passed to `format', so percent characters need to be doubled.
728 This implementation requires the MIME::Base64 Perl module to be installed
732 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
733 "Perl program to use for decoding a file.
734 Escape sequence %s is replaced with name of Perl binary.
735 This string is passed to `format', so percent characters need to be doubled.
736 This implementation requires the MIME::Base64 Perl module to be installed
740 "%s -e '
741 # This script contributed by Juanma Barranquero <lektu@terra.es>.
742 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
743 use strict;
745 my %%trans = do {
746 my $i = 0;
747 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
748 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
749 };
750 my $data;
752 # We read in chunks of 54 bytes, to generate output lines
753 # of 72 chars (plus end of line)
754 while (read STDIN, $data, 54) {
755 my $pad = q();
757 # Only for the last chunk, and only if did not fill the last three-byte packet
758 if (eof) {
759 my $mod = length($data) %% 3;
760 $pad = q(=) x (3 - $mod) if $mod;
761 }
763 # Not the fastest method, but it is simple: unpack to binary string, split
764 # by groups of 6 bits and convert back from binary to byte; then map into
765 # the translation table
766 print
767 join q(),
768 map($trans{$_},
769 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
770 $pad,
772 }' 2>/dev/null"
773 "Perl program to use for encoding a file.
774 Escape sequence %s is replaced with name of Perl binary.
778 "%s -e '
779 # This script contributed by Juanma Barranquero <lektu@terra.es>.
780 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
781 use strict;
783 my %%trans = do {
784 my $i = 0;
785 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
786 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
787 };
789 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
793 # We are going to accumulate into $pending to accept any line length
794 # (we do not check they are <= 76 chars as the RFC says)
795 my $pending = q();
797 while (my $data = <STDIN>) {
798 chomp $data;
800 # If we find one or two =, we have reached the end and
801 # any following data is to be discarded
802 my $finished = $data =~ s/(==?).*/$1/;
803 $pending .= $data;
805 my $len = length($pending);
806 my $chunk = substr($pending, 0, $len & ~3);
807 $pending = substr($pending, $len & ~3 + 1);
809 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
810 # split in 8-bit chunks and convert back to char.
811 print join q(),
812 map $bytes{$_},
813 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
815 last if $finished;
816 }' 2>/dev/null"
817 "Perl program to use for decoding a file.
818 Escape sequence %s is replaced with name of Perl binary.
822 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
823 "Perl program to use for encoding a file.
827 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
828 "Perl program to use for decoding a file.
833 while read file; do
836 else
838 fi
841 else
843 fi
844 done
846 "Script to check existence of VC related files.
847 It must be send formatted with two strings; the tests for file
848 existence, and file readability. Input shall be read via
849 here-document, otherwise the command could exceed maximum length
852 ;; New handlers should be added here.
856 ;; `byte-compiler-base-file-name' performed by default handler.
861 ;; `diff-latest-backup-file' performed by default handler.
865 . tramp-sh-handle-directory-files-and-attributes)
866 ;; `dired-call-process' performed by default handler.
869 . tramp-sh-handle-dired-recursive-delete-directory)
876 ;; `file-equal-p' performed by default handler.
879 ;; `file-in-directory-p' performed by default handler.
887 ;; `file-name-sans-versions' performed by default handler.
900 ;; `find-file-noselect' performed by default handler.
901 ;; `get-file-buffer' performed by default handler.
905 . tramp-sh-handle-insert-file-contents-literally)
924 "Alist of handler functions.
927 ;; This must be the last entry, because `identity' always matches.
928 ;;;###tramp-autoload
932 ;;; File Name Handler Functions:
936 "Like `make-symbolic-link' for Tramp files.
937 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
938 the symlink. If LINKNAME is a Tramp file, only the localname component is
939 used as the target of the symlink.
941 If LINKNAME is a Tramp file and the localname component is relative, then
942 it is expanded first, before the localname component is taken. Note that
943 this can give surprising results if the user/host for the source and
944 target of the symlink differ."
951 l 'file-error
954 ;; Do the 'confirm if exists' thing.
956 ;; What to do?
961 "File %s already exists; make it a link anyway? "
962 l-localname)))))
967 ;; If FILENAME is a Tramp name, use just the localname component.
976 ;; Right, they are on the same host, regardless of user, method,
977 ;; etc. We now make the link on the remote machine. This will
978 ;; occur as the user that FILENAME belongs to.
980 l
982 "cd %s && %s -sf %s %s"
984 ln
987 t))))
990 "Like `file-truename' for Tramp files."
992 "%s%s"
995 method user host
1000 ;; Use GNU readlink --canonicalize-missing where available.
1003 v
1011 ;; Use Perl implementation.
1019 v
1023 ;; Do it yourself. We bind `directory-sep-char' here for
1024 ;; XEmacs on Windows, which would otherwise use backslash.
1032 ;; Don't make the following value larger than
1033 ;; necessary. People expect an error message in
1034 ;; a timely fashion when something is wrong;
1035 ;; otherwise they might think that Emacs is hung.
1036 ;; Of course, correctness has to come first.
1038 symlink-target)
1049 method user host
1061 ;; It's a symlink, follow it.
1067 ;; If the symlink was absolute, we'll get a
1068 ;; string like "/user@host:/some/target";
1069 ;; extract the "/some/target" part from it.
1073 v 'file-error
1074 "Symlink target `%s' on wrong host"
1075 symlink-target))
1080 steps)))
1082 ;; It's a file.
1086 v 'file-error
1089 ;; Combine list to form string.
1100 result))))
1102 ;; Preserve trailing "/".
1105 ;; Basic functions.
1108 "Like `file-exists-p' for Tramp files."
1116 v
1118 "%s %s"
1123 "Like `file-attributes' for Tramp files."
1126 ;; Don't modify `last-coding-system-used' by accident.
1133 v
1141 ;; The scripts could fail, for example with huge file size.
1145 "Implement `file-attributes' for Tramp files using the ls(1) command."
1147 res-inode res-filemodes res-numlinks
1148 res-uid res-gid res-size res-symlink-target)
1151 vec
1160 ;; parse `ls -l' output ...
1164 ;; ... inode
1180 ;; ... file mode flags
1182 ;; ... number links
1184 ;; ... uid and gid
1194 ;; ... size
1196 ;; From the file modes, figure out other stuff.
1199 ;; if symlink, find out file name pointed to
1203 ;; return data gathered
1205 ;; 0. t for directory, string (name linked to) for symbolic
1206 ;; link, or nil.
1208 ;; 1. Number of links to file.
1209 res-numlinks
1210 ;; 2. File uid.
1211 res-uid
1212 ;; 3. File gid.
1213 res-gid
1214 ;; 4. Last access time, as a list of integers. Normally this
1215 ;; would be in the same format as `current-time', but the
1216 ;; subseconds part is not currently implemented, and (0 0)
1217 ;; denotes an unknown time.
1218 ;; 5. Last modification time, likewise.
1219 ;; 6. Last status change time, likewise.
1221 ;; 7. Size in bytes (-1, if number is out of range).
1222 res-size
1223 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1224 res-filemodes
1225 ;; 9. t if file's gid would change if file were deleted and
1226 ;; recreated. Will be set in `tramp-convert-file-attributes'
1227 t
1228 ;; 10. inode number.
1229 res-inode
1230 ;; 11. Device number. Will be replaced by a virtual device number.
1231 -1
1232 )))))
1236 "Implement `file-attributes' for Tramp files using a Perl script."
1241 vec
1247 "Implement `file-attributes' for Tramp files using stat(1) command."
1250 vec
1252 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1253 ;; parse correctly the sequence "((". Therefore, we add a space.
1254 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1265 "Like `set-visited-file-modtime' for Tramp files."
1272 coding-system-used)
1276 ;; '(-1 65535) means file doesn't exists yet.
1280 ;; We use '(0 0) as a don't-know value. See also
1281 ;; `tramp-do-file-attributes-with-ls'.
1286 v
1295 nil)))))
1297 ;; This function makes the same assumption as
1298 ;; `tramp-sh-handle-set-visited-file-modtime'.
1300 "Like `verify-visited-file-modtime' for Tramp files.
1301 At the time `verify-visited-file-modtime' calls this function, we
1302 already know that the buffer is visiting a file and that
1303 `visited-file-modtime' does not return 0. Do not call this
1304 function directly, unless those two cases are already taken care
1305 of."
1308 ;; There is no file visiting the buffer, or the buffer has no
1309 ;; recorded last modification time, or there is no established
1310 ;; connection.
1314 t
1322 ;; File exists, and has a known modtime.
1325 modtime
1326 ;; For compatibility, deal with both the old
1327 ;; (HIGH . LOW) and the new (HIGH LOW) return
1328 ;; values of `visited-file-modtime'.
1331 mt)))
1333 ;; Modtime has the don't know value.
1336 v
1343 attr
1346 ;; If file does not exist, say it is not modified if and
1347 ;; only if that agrees with the buffer's record.
1351 "Like `set-file-modes' for Tramp files."
1354 ;; FIXME: extract the proper text from chmod's stderr.
1356 v
1363 "Like `set-file-times' for Tramp files."
1370 time))
1371 ;; With GNU Emacs, `format-time-string' has an
1372 ;; optional parameter UNIVERSAL. This is preferred,
1373 ;; because we could handle the case when the remote
1374 ;; host is located in a different time zone as the
1375 ;; local host.
1379 "%s %s %s %s"
1390 ;; We handle also the local part, because in older Emacsen,
1391 ;; without `set-file-times', this function is an alias for this.
1392 ;; We are local, so we don't need the UTC settings.
1400 "Set the ownership for FILENAME.
1401 If UID and GID are provided, these values are used; otherwise uid
1402 and gid of the corresponding user is taken. Both parameters must
1403 be non-negative integers."
1404 ;; Modern Unices allow chown only for root. So we might need
1405 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1406 ;; working with su(do)? when it is needed, so it shall succeed in
1407 ;; the majority of cases.
1408 ;; Don't modify `last-coding-system-used' by accident.
1413 ;; If we are root on the local host, we can do it directly.
1421 "chown %d:%d %s" uid gid
1424 ;; We handle also the local part, because there doesn't exist
1425 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1429 nil "chown" nil nil nil
1433 "Check, whether SELINUX is enabled on the remote host."
1445 "Like `file-selinux-context' for Tramp files."
1454 "%s -d -Z %s"
1462 ;; Return the context.
1463 context))))
1466 "Like `set-file-selinux-context' for Tramp files."
1483 t)
1485 nil)))
1488 "Check, whether ACL is enabled on the remote host."
1493 "Like `file-acl' for Tramp files."
1499 "getfacl -ac %s 2>/dev/null"
1509 "Like `set-file-acl' for Tramp files."
1516 tramp-end-of-heredoc
1517 acl-string
1518 tramp-end-of-heredoc))
1520 ;; Success.
1523 t)
1524 ;; In case of errors, we return `nil'.
1526 nil)))
1528 ;; Simple functions using the `test' command.
1531 "Like `file-executable-p' for Tramp files."
1534 ;; Examine `file-attributes' cache to see if request can be
1535 ;; satisfied without remote operation.
1540 "Like `file-readable-p' for Tramp files."
1543 ;; Examine `file-attributes' cache to see if request can be
1544 ;; satisfied without remote operation.
1548 ;; When the remote shell is started, it looks for a shell which groks
1549 ;; tilde expansion. Here, we assume that all shells which grok tilde
1550 ;; expansion will also provide a `test' command which groks `-nt' (for
1551 ;; newer than). If this breaks, tell me about it and I'll try to do
1552 ;; something smarter about it.
1554 "Like `file-newer-than-file-p' for Tramp files."
1556 nil)
1558 t)
1559 ;; We are sure both files exist at this point.
1562 ;; We try to get the mtime of both files. If they are not
1563 ;; equal to the "dont-know" value, then we subtract the times
1564 ;; and obtain the result.
1570 ;; If one of them is the dont-know value, then we can
1571 ;; still try to run a shell command on the remote host.
1572 ;; However, this only works if both files are Tramp
1573 ;; files and both have the same method, same user, same
1574 ;; host.
1579 v 'file-error
1580 "Files %s and %s must have same method, user, host"
1581 file1 file2)))
1586 ;; Functions implemented using the basic functions above.
1589 "Like `file-directory-p' for Tramp files."
1591 ;; `file-directory-p' is used as predicate for file name completion.
1592 ;; Sometimes, when a connection is not established yet, it is
1593 ;; desirable to return t immediately for "/method:foo:". It can
1594 ;; be expected that this is always a directory.
1600 "Like `file-writable-p' for Tramp files."
1604 ;; Examine `file-attributes' cache to see if request can be
1605 ;; satisfied without remote operation.
1608 ;; If file doesn't exist, check if directory is writable.
1613 "Like `file-ownership-preserved-p' for Tramp files."
1617 ;; Return t if the file doesn't exist, since it's true that no
1618 ;; information would be lost by an (attempted) delete and create.
1625 ;; Directory listings.
1629 "Like `directory-files-and-attributes' for Tramp files."
1633 directory full match nosort id-format)
1635 ;; Do it directly.
1643 v localname
1653 v localname id-format))
1656 v localname id-format)))))))))
1657 result item)
1667 result
1672 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1675 vec tramp-perl-directory-files-and-attributes
1679 vec
1683 object))
1687 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1690 vec
1693 ;; We must care about file names with spaces, or starting with
1694 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1695 ;; but it does not work on all remote systems. Therefore, we
1696 ;; quote the file names via sed.
1698 "xargs %s -c "
1707 ;; This function should return "foo/" for directories and "bar" for
1708 ;; files.
1710 "Like `file-name-all-completions' for Tramp files."
1715 filename
1717 'list
1719 ;; Try cache entries for `filename', `filename' with last
1720 ;; character removed, `filename' with last two characters
1721 ;; removed, ..., and finally the empty string - all
1722 ;; concatenated to the local directory name.
1725 tramp-completion-reread-directory-timeout)))
1727 ;; This is inefficient for very long file names, pity
1728 ;; `reduce' is not available...
1731 'append
1736 v
1738 "file-name-all-completions"
1739 nil)))
1741 ;; We cannot use a length of 0, because file properties
1742 ;; for "foo" and "foo/" are identical.
1745 ;; Cache expired or no matching cache entry found so we need
1746 ;; to perform a remote operation.
1748 ;; Get a list of directories and files, including reliably
1749 ;; tagging the directories with a trailing '/'. Because I
1750 ;; rock. --daniel@danann.net
1752 ;; Changed to perform `cd' in the same remote op and only
1753 ;; get entries starting with `filename'. Capture any `cd'
1754 ;; error messages. Ensure any `cd' and `echo' aliases are
1755 ;; ignored.
1757 v
1761 v tramp-perl-file-name-all-completions
1767 ;; `read-file-name-completion-ignore-case'
1768 ;; is introduced with Emacs 22.1.
1771 'read-file-name-completion-ignore-case
1777 ;; `ls' with wildcard might fail with `Argument
1778 ;; list too long' error in some corner cases; if
1779 ;; `ls' fails after `cd' succeeded, chances are
1780 ;; that's the case, so let's retry without
1781 ;; wildcard. This will return "too many" entries
1782 ;; but that isn't harmful.
1783 " || %s -a 2>/dev/null)"
1784 " | while IFS= read f; do"
1790 ;; When `filename' is empty, just `ls' without
1791 ;; `filename' argument is more efficient than `ls *'
1792 ;; for very large directories and might avoid the
1793 ;; `Argument list too long' error.
1794 ;;
1795 ;; With and only with wildcard, we need to add
1796 ;; `-d' to prevent `ls' from descending into
1797 ;; sub-directories.
1799 "."
1804 ;; Now grab the output.
1808 ;; Check result code, found in last line of output.
1812 ;; Grab error message from line before last line
1813 ;; (it was put there by `cd 2>&1').
1816 v 'file-error
1817 "tramp-sh-handle-file-name-all-completions: %s"
1819 ;; For peace of mind, if buffer doesn't end in `fail'
1820 ;; then it should end in `ok'. If neither are in the
1821 ;; buffer something went seriously wrong on the remote
1822 ;; side.
1825 v 'file-error
1826 "\
1827 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1833 ;; Because the remote op went through OK we know the
1834 ;; directory we `cd'-ed to exists.
1837 ;; Because the remote op went through OK we know every
1838 ;; file listed by `ls' exists.
1842 result)
1844 ;; Store result in the cache.
1849 ;; cp, mv and ln
1853 "Like `add-name-to-file' for Tramp files."
1858 v 'file-error
1859 "add-name-to-file: %s"
1868 "File %s already exists; make it a new name anyway? "
1869 newname)))
1876 v1
1880 "error with add-name-to-file, see buffer `%s' for details"
1885 preserve-uid-gid preserve-extended-attributes)
1886 "Like `copy-file' for Tramp files."
1890 ;; At least one file a Tramp file?
1894 'copy filename newname ok-if-already-exists keep-date
1895 preserve-uid-gid preserve-extended-attributes))
1896 ;; Compat section.
1899 'copy-file
1901 preserve-uid-gid preserve-extended-attributes)))
1904 'copy-file
1912 "Like `copy-directory' for Tramp files."
1918 ;; When DIRNAME and NEWNAME are remote, they must have
1919 ;; the same method.
1925 ;; scp or rsync DTRT.
1939 ;; We must do it file-wise.
1941 'copy-directory
1946 ;; When newname did exist, we have wrong cached values.
1954 "Like `rename-file' for Tramp files."
1955 ;; Check if both files are local -- invoke normal rename-file.
1956 ;; Otherwise, use Tramp from local system.
1959 ;; At least one file a Tramp file?
1969 preserve-uid-gid preserve-extended-attributes)
1970 "Copy or rename a remote file.
1971 OP must be `copy' or `rename' and indicates the operation to perform.
1972 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1973 the new file (for copy) or the new name of the file (for rename).
1974 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1975 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1976 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1977 the uid and gid if both files are on the same host.
1978 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1980 This function is invoked by `tramp-sh-handle-copy-file' and
1981 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1982 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1983 file names."
2000 filename newname)
2003 ;; Both are Tramp files.
2008 ;; Shortcut: if method, host, user are the same for
2009 ;; both files, we invoke `cp' or `mv' on the remote
2010 ;; host directly.
2013 op filename newname
2014 ok-if-already-exists keep-date preserve-uid-gid))
2016 ;; Try out-of-band operation.
2021 op filename newname keep-date))
2023 ;; No shortcut was possible. So we copy the file
2024 ;; first. If the operation was `rename', we go back
2025 ;; and delete the original file (if the copy was
2026 ;; successful). The approach is simple-minded: we
2027 ;; create a new buffer, insert the contents of the
2028 ;; source file into it, then write out the buffer to
2029 ;; the target file. The advantage is that it doesn't
2030 ;; matter which file name handlers are used for the
2031 ;; source and target file.
2034 op filename newname keep-date))))))
2036 ;; One file is a Tramp file, the other one is local.
2039 ;; Fast track on local machine.
2042 op filename newname
2043 ok-if-already-exists keep-date preserve-uid-gid))
2045 ;; If the Tramp file has an out-of-band method, the
2046 ;; corresponding copy-program can be invoked.
2049 op filename newname keep-date))
2051 ;; Use the inline method via a Tramp buffer.
2053 op filename newname keep-date))))
2056 ;; One of them must be a Tramp file.
2059 ;; Handle `preserve-extended-attributes'. We ignore possible
2060 ;; errors, because ACL strings could be incompatible.
2065 ;; In case of `rename', we must flush the cache of the source file.
2071 ;; When newname did exist, we have wrong cached values.
2078 "Use an Emacs buffer to copy or rename a file.
2079 First arg OP is either `copy' or `rename' and indicates the operation.
2080 FILENAME is the source file, NEWNAME the target file.
2081 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2083 ;; We must disable multibyte, because binary data shall not be
2084 ;; converted. We remove `tramp-file-name-handler' from
2085 ;; `inhibit-file-name-handlers'; otherwise the file name handler
2086 ;; for `insert-file-contents' might be deactivated in some corner
2087 ;; cases.
2094 ;; We don't want the target file to be compressed, so we let-bind
2095 ;; `jka-compr-inhibit' to t.
2099 ;; KEEP-DATE handling.
2101 ;; Set the mode.
2103 ;; If the operation was `rename', delete the original file.
2108 "Invokes `cp' or `mv' on the remote system.
2109 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2110 respectively. FILENAME specifies the file to copy or rename,
2111 NEWNAME is the name of the new file (for copy) or the new name of
2112 the file (for rename). Both files must reside on the same host.
2113 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2114 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2115 the uid and gid from FILENAME."
2125 v 'file-error
2126 "Unknown operation `%s', must be `copy' or `rename'"
2127 op))))
2131 filename))
2135 newname))
2137 cmd-result)
2140 ;; Both files are on a remote host, with same user.
2152 ;; Mask cp -f error.
2154 tramp-operation-not-permitted-regexp nil t))
2155 cmd-result)
2157 nil v 'file-error
2158 "Copying directly failed, see buffer `%s' for details."
2161 ;; We are on the local host.
2164 ;; We can do it directly.
2167 ;; No sticky bit when renaming.
2178 localname1 localname2 ok-if-already-exists
2179 keep-date preserve-uid-gid)
2183 ;; We can do it directly with `tramp-send-command'
2191 ok-if-already-exists keep-date t)
2192 ;; We must change the ownership to the local user.
2198 ;; We need a temporary file in between.
2200 ;; Create the temporary file.
2208 "%s %s %s" cmd
2211 "Copying directly failed, see buffer `%s' for details."
2213 ;; We must change the ownership as remote user.
2214 ;; Since this does not work reliable, we also
2215 ;; give read permissions.
2226 localname1 tmpfile t
2227 keep-date preserve-uid-gid)
2229 'rename-file
2231 ;; We must change the ownership as local user.
2232 ;; Since this does not work reliable, we also
2233 ;; give read permissions.
2237 tmpfile
2241 ;; Move the temporary file to its destination.
2246 "cp -f -p %s %s"
2249 "Copying directly failed, see buffer `%s' for details."
2253 'rename-file
2256 ;; Save exit.
2259 ;; Set the time and mode. Mask possible errors.
2266 "Invoke `scp' program to copy.
2267 The method used must be an out-of-band method."
2271 copy-program copy-args copy-env copy-keep-date port listener spec
2272 options source target remote-copy-program remote-copy-args)
2277 ;; Both are Tramp files. We shall optimize it when the
2278 ;; methods for FILENAME and NEWNAME are the same.
2288 op filename tmpfile keep-date)
2291 ;; Save exit.
2298 ;; Set variables for computing the prompt for reading
2299 ;; password.
2306 ;; Expand hops. Might be necessary for gateway methods.
2310 ;; Check which ones of source and target are Tramp files.
2319 'file-name-directory
2325 ;; Check for host and port number. We cannot use
2326 ;; `tramp-file-name-port', because this returns also
2327 ;; `tramp-default-port', which might clash with settings in
2328 ;; "~/.ssh/config".
2335 ;; Check for user. There might be an interactive setting.
2339 ;; Check for listener port.
2346 ;; Compose copy command.
2356 spec)
2358 ?h host ?u user ?p port ?r listener ?c options
2365 copy-args
2367 ;; " " has either been a replacement of "%k" (when
2368 ;; keep-date argument is non-nil), or a replacement
2369 ;; for the whole keep-date sublist.
2370 " "
2374 copy-args)
2377 copy-args
2381 copy-env
2383 nil
2390 remote-copy-program
2400 remote-copy-args
2404 ;; Check for local copy program.
2409 ;; Install listener on the remote side. The prompt must be
2410 ;; consumed later on, when the process does not listen anymore.
2417 v 'file-error
2421 'identity
2429 v 'file-error
2430 "Listener process not running on remote host: `%s'"
2431 remote-copy-program))
2439 ;; The default directory must be remote.
2443 ;; Set the transfer process properties.
2453 copy-args
2455 copy-args
2460 ;; Use an asynchronous process. By this, password can
2461 ;; be handled. We don't set a timeout, because the
2462 ;; copying of large files can last longer than 60
2463 ;; secs.
2467 copy-program
2469 copy-args
2478 ;; We must adapt `tramp-local-end-of-line' for
2479 ;; sending the password.
2482 p v nil tramp-actions-copy-out-of-band))
2484 ;; Check the return code.
2489 orig-vec 'file-error
2490 "Couldn't find exit status of `%s'"
2496 orig-vec 'file-error
2497 "Error copying: `%s'"
2500 ;; Reset the transfer process properties.
2503 ;; Clear the remote prompt.
2506 ;; Houston, we have a problem! Likely, the listener is
2507 ;; still running, so let's clear everything (but the
2508 ;; cached password).
2511 ;; Handle KEEP-DATE argument.
2515 ;; Set the mode.
2520 ;; If the operation was `rename', delete the original file.
2527 "Like `make-directory' for Tramp files."
2539 "Like `delete-directory' for Tramp files."
2551 "Like `delete-file' for Tramp files."
2562 ;; Dired.
2564 ;; CCC: This does not seem to be enough. Something dies when
2565 ;; we try and delete two directories under Tramp :/
2567 "Recursively delete the directory given.
2568 This is like `dired-recursive-delete-directory' for Tramp files."
2570 ;; Run a shell command 'rm -r <localname>'.
2571 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2574 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2576 v
2578 ;; Don't read the output, do it explicitly.
2579 nil t)
2580 ;; Wait for the remote system to return to us...
2581 ;; This might take a while, allow it plenty of time.
2583 ;; Make sure that it worked...
2591 "Like `dired-compress-file' for Tramp files."
2592 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2593 ;; Code stolen mainly from dired-aux.el.
2599 ;; Emacs case
2601 ;; XEmacs has `dired-compression-method-alist', which is
2602 ;; transformed into `dired-compress-file-suffixes' structure.
2606 nil
2609 suffix)
2610 ;; See if any suffix rule matches this file name.
2618 nil)
2620 ;; We found an uncompression rule.
2626 ;; `dired-remove-file' is not defined in XEmacs.
2631 ;; We don't recognize the file as compressed, so compress it.
2632 ;; Try gzip.
2637 ;; `dired-remove-file' is not defined in XEmacs.
2647 "Like `insert-directory' for Tramp files."
2654 filename switches wildcard full-directory-p)
2674 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2675 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2678 v
2681 switches
2683 localname
2686 v
2690 "Couldn't `cd %s'"
2694 v
2697 switches
2702 ""
2710 ;; We cannot use `insert-buffer-substring' because the Tramp
2711 ;; buffer changes its contents before insertion due to calling
2712 ;; `expand-file' and alike.
2717 ;; Check for "--dired" output.
2724 ;; Now read the numeric positions of file names.
2730 ;; End is followed by \n or by " -> ".
2732 ;; Remove trailing lines.
2738 ;; Some busyboxes are reluctant to discard colors.
2745 ;; Decode the output, it could be multibyte.
2752 ;; The inserted file could be from somewhere else.
2759 "."
2766 ;; Canonicalization of file names.
2769 "Like `expand-file-name' for Tramp files.
2771 the result will be a local, non-Tramp, file name."
2772 ;; If DIR is not given, use `default-directory' or "/".
2774 ;; Unless NAME is absolute, concat DIR and NAME.
2777 ;; If NAME is not a Tramp file, run the real handler.
2780 ;; Dissect NAME.
2784 ;; Tilde expansion if necessary. This needs a shell which
2785 ;; groks tilde expansion! The function `tramp-find-shell' is
2786 ;; supposed to find such a shell on the remote host. Please
2787 ;; tell me about it when this doesn't work on your system.
2791 ;; We cannot simply apply "~/", because under sudo "~/" is
2792 ;; expanded to the local user home directory but to the
2793 ;; root home directory. On the other hand, using always
2794 ;; the default user name for tilde expansion is not
2795 ;; appropriate either, because ssh and companions might
2796 ;; use a user name from the config file.
2808 ;; There might be a double slash, for example when "~/"
2809 ;; expands to "/". Remove this.
2812 ;; No tilde characters in file name, do normal
2813 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2814 ;; `directory-sep-char' here for XEmacs on Windows, which would
2815 ;; otherwise use backslash. `default-directory' is bound,
2816 ;; because on Windows there would be problems with UNC shares or
2817 ;; Cygwin mounts.
2821 method user host
2825 hop)))))
2827 ;;; Remote commands:
2830 "Flush file caches."
2838 ;; We use BUFFER also as connection buffer during setup. Because of
2839 ;; this, its original contents must be saved, and restored once
2840 ;; connection has been setup.
2842 "Like `start-file-process' for Tramp files."
2845 ;; it might be that the arguments exceed the command line
2846 ;; length. Therefore, we modify the command.
2851 ;; When PROGRAM is nil, we just provide a tty.
2857 args
2861 ;; Use a human-friendly prompt, for example for `shell'.
2865 tramp-initial-end-of-output)))
2866 ;; We use as environment the difference to toplevel
2867 ;; `process-environment'.
2868 env
2873 env)
2892 ;; We do not want to raise an error when
2893 ;; `start-file-process' has been started several times in
2894 ;; `eshell' and friends.
2898 ;; BUFFER can be nil. We use a temporary buffer.
2901 ;; NAME must be unique as process name.
2905 ;; Set the new process properties.
2911 ;; We catch this event. Otherwise, `start-process' could
2912 ;; be called on the local host.
2915 ;; Activate narrowing in order to save BUFFER
2916 ;; contents. Clear also the modification time;
2917 ;; otherwise we might be interrupted by
2918 ;; `verify-visited-file-modtime'.
2924 ;; We call `tramp-maybe-open-connection', in order
2925 ;; to cleanup the prompt afterwards.
2931 ;; Now do it.
2933 ;; Send the command.
2935 ;; Check, whether a pty is associated.
2939 v 'file-error
2942 ;; Set query flag and process marker for this
2943 ;; process. We ignore errors, because the process
2944 ;; could have finished already.
2948 ;; Return process.
2949 p))))
2951 ;; Save exit.
2962 "Like `process-file' for Tramp files."
2963 ;; The implementation is not complete yet.
2969 ;; Compute command.
2972 ;; We use as environment the difference to toplevel `process-environment'.
2980 "env %s %s"
2982 ;; Determine input.
2987 ;; INFILE is on the same remote host.
2989 ;; INFILE must be copied to remote host.
2995 ;; Determine output.
2997 ;; Just a buffer.
3000 ;; A buffer name.
3003 ;; (REAL-DESTINATION ERROR-DESTINATION)
3005 ;; output.
3013 ;; stderr.
3018 ;; stderr is on the same remote host.
3021 ;; stderr must be copied to remote host. The temporary
3022 ;; file must be deleted after execution.
3025 method user host stderr))))
3026 ;; stderr to be discarded.
3029 ;; 't
3034 ;; Send the command. It might not return in time, so we protect
3035 ;; it. Call it in a subshell, in order to preserve working
3036 ;; directory.
3043 command)
3044 t t)
3046 ;; We should add the output anyway.
3053 ;; When the user did interrupt, we should do it also. We use
3054 ;; return code -1 as marker.
3058 ;; Handle errors.
3063 ;; Provide error file.
3066 ;; Cleanup. We remove all file cache values for the connection,
3067 ;; because the remote process could have changed them.
3070 ;; `process-file-side-effects' has been introduced with GNU
3071 ;; Emacs 23.2. If set to `nil', no remote file will be changed
3072 ;; by `program'. If it doesn't exist, we assume its default
3073 ;; value `t'.
3078 ;; Return exit status.
3081 ret))))
3084 "Like `file-local-copy' for Tramp files."
3088 v 'file-error
3098 ;; `copy-file' handles direct copy and out-of-band methods.
3103 ;; Use inline encoding for file transfer.
3107 v 3
3115 tmpfile loc-dec)
3117 ;; If local decoding is a function, we call it.
3118 ;; We must disable multibyte, because
3119 ;; `uudecode-decode-region' doesn't handle it
3120 ;; correctly.
3125 ;; Unset `file-name-handler-alist'. Otherwise,
3126 ;; epa-file gets confused.
3132 ;; If tramp-decoding-function is not defined for this
3133 ;; method, we invoke tramp-decoding-command instead.
3135 ;; Unset `file-name-handler-alist'. Otherwise,
3136 ;; epa-file gets confused.
3144 loc-dec tmpfile2 tmpfile)
3147 ;; Set proper permissions.
3149 ;; Set local user ownership.
3152 ;; Oops, I don't know what to do.
3156 ;; Error handling.
3162 tmpfile)))
3164 ;; This is needed for XEmacs only. Code stolen from files.el.
3167 "Like `insert-file-contents-literally' for Tramp files."
3175 nil))
3182 ;; Save exit.
3187 ;; CCC grok LOCKNAME
3190 "Like `write-region' for Tramp files."
3193 ;; Following part commented out because we don't know what to do about
3194 ;; file locking, and it does not appear to be a problem to ignore it.
3195 ;; Ange-ftp ignores it, too.
3196 ;; (when (and lockname (stringp lockname))
3197 ;; (setq lockname (expand-file-name lockname)))
3198 ;; (unless (or (eq lockname nil)
3199 ;; (string= lockname filename))
3200 ;; (error
3201 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3203 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3214 ;; `file-writable-p' calls `file-expand-file-name'. We
3215 ;; cannot use `tramp-run-real-handler' therefore.
3221 ;; Short track: if we are on the local host, we can run directly.
3223 'write-region
3227 ;; We use this to save the value of
3228 ;; `last-coding-system-used' after writing the tmp
3229 ;; file. At the end of the function, we set
3230 ;; `last-coding-system-used' to this saved value. This
3231 ;; way, any intermediary coding systems used while
3232 ;; talking to the remote shell or suchlike won't hose
3233 ;; this variable. This approach was snarfed from
3234 ;; ange-ftp.el.
3235 coding-system-used
3236 ;; Write region into a tmp file. This isn't really
3237 ;; needed if we use an encoding function, but currently
3238 ;; we use it always because this makes the logic
3239 ;; simpler. We must also set `temporary-file-directory',
3240 ;; because it could point to a remote directory.
3246 ;; If `append' is non-nil, we copy the file locally, and let
3247 ;; the native `write-region' implementation do the job.
3250 ;; We say `no-message' here because we don't want the
3251 ;; visited file modtime data to be clobbered from the temp
3252 ;; file. We call `set-visited-file-modtime' ourselves later
3253 ;; on. We must ensure that `file-coding-system-alist'
3254 ;; matches `tmpfile'.
3260 'write-region
3267 ;; Now, `last-coding-system-used' has the right value. Remember it.
3272 ;; The permissions of the temporary file should be set. If
3273 ;; FILENAME does not exist (eq modes nil) it has been
3274 ;; renamed to the backup file. This case `save-buffer'
3275 ;; handles permissions.
3276 ;; Ensure that it is still readable.
3279 tmpfile
3282 ;; This is a bit lengthy due to the different methods
3283 ;; possible for file transfer. First, we check whether the
3284 ;; method uses an scp program. If so, we call it.
3285 ;; Otherwise, both encoding and decoding command must be
3286 ;; specified. However, if the method _also_ specifies an
3287 ;; encoding function, then that is used for encoding the
3288 ;; contents of the tmp file.
3293 ;; `copy-file' handles direct copy and out-of-band methods.
3304 ;; We keep the local file for performance
3305 ;; reasons, useful for "rsync".
3312 ;; Don't rename, in order to keep context in SELinux.
3317 ;; Use inline file transfer.
3319 ;; Encode tmpfile.
3323 ;; Use encoding function or command.
3326 tmpfile loc-enc)
3328 ;; The following `let' is a workaround for
3329 ;; the base64.el that comes with pgnus-0.84.
3330 ;; If both of the following conditions are
3331 ;; satisfied, it tries to write to a local
3332 ;; file in default-directory, but at this
3333 ;; point, default-directory is remote.
3334 ;; (`call-process-region' can't write to
3335 ;; remote files, it seems.) The file in
3336 ;; question is a tmp file anyway.
3344 loc-enc tmpfile t))
3346 v 'file-error
3349 filename loc-enc))))
3351 ;; Send buffer into remote decoding command which
3352 ;; writes to remote file. Because this happens on
3353 ;; the remote host, we cannot use the function.
3356 filename rem-dec)
3360 v
3364 tramp-end-of-heredoc
3366 tramp-end-of-heredoc))
3368 v nil
3369 "Couldn't write region to `%s', decode using `%s' failed"
3370 filename rem-dec)
3371 ;; When `file-precious-flag' is set, the region is
3372 ;; written to a temporary file. Check that the
3373 ;; checksum is equal to that from the local tmpfile.
3377 ;; cksum runs locally, if possible.
3379 ;; cksum runs remotely.
3381 v
3384 ;; ... they are different.
3391 v 'file-error
3394 filename rem-dec)))))
3396 ;; Save exit.
3399 ;; That's not expected.
3402 v 'file-error
3405 method))))
3407 ;; Make `last-coding-system-used' have the right value.
3414 ;; We must protect `last-coding-system-used', now we have set it
3415 ;; to its correct value.
3417 ;; Set file modification time.
3421 ;; We must pass modtime explicitly, because FILENAME can
3422 ;; be different from (buffer-file-name), f.e. if
3423 ;; `file-precious-flag' is set.
3429 ;; Set the ownership.
3439 ;; VC backends check for the existence of various different special
3440 ;; files. This is very time consuming, because every single check
3441 ;; requires a remote command (the file cache must be invalidated).
3442 ;; Therefore, we apply a kind of optimization. We install the file
3443 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3444 ;; remembers all file names for which `file-exists-p' or
3445 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3446 ;; is performed. Afterwards, a script is applied for all collected
3447 ;; file names, using just one remote command. The result of this
3448 ;; script is used to fill the file cache with actual values. Now we
3449 ;; can reset the file name handlers, and we make a second run of
3450 ;; `vc-registered', which returns the expected result without sending
3451 ;; any other remote command.
3453 "Like `vc-registered' for Tramp files."
3459 ;; There could be new files, created by the vc backend. We
3460 ;; cannot reuse the old cache entries, therefore. In
3461 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3462 ;; could also be a timestamp as `current-time' returns. This
3463 ;; means invalidate all cache entries with an older timestamp.
3469 ;; Here we collect only file names, which need an operation.
3473 ;; Send just one command, in order to fill the cache.
3476 v
3485 ;; We cannot use `tramp-send-command-and-read',
3486 ;; because this does not cooperate well with
3487 ;; heredoc documents.
3489 v
3492 tramp-end-of-heredoc
3494 tramp-vc-registered-file-names
3496 tramp-end-of-heredoc))
3498 ;; Read the expression.
3505 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3506 ;; calls shall be answered from the file cache. We unset
3507 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3508 ;; in order to keep the cache.
3510 remote-file-name-inhibit-cache process-file-side-effects)
3511 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3530 ;; Run.
3534 ;;;###tramp-autoload
3536 "Invoke remote-shell Tramp file name handler.
3537 Fall back to normal file name handler if no Tramp handler exists."
3555 "Invoke special file name handler, which collects files to be handled."
3563 ;; That's what we want: file names, for which checks are
3564 ;; applied. We assume that VC uses only `file-exists-p' and
3565 ;; `file-readable-p' checks; otherwise we must extend the
3566 ;; list. We do not perform any action, but return nil, in
3567 ;; order to keep `vc-registered' running.
3570 nil)
3571 ;; `process-file' and `start-file-process' shall be ignored.
3574 ;; Tramp file name handlers like `expand-file-name'. They
3575 ;; must still work.
3577 ;; Default file name handlers, we don't care.
3581 "Like `file-notify-add-watch' for Tramp files."
3585 command events filter p sequence)
3587 ;; gvfs-monitor-dir.
3591 ;; inotifywait.
3594 events
3601 ;; None.
3603 v 'file-notify-error
3604 "No file notification program found on %s"
3606 ;; Start process.
3608 'start-file-process
3612 sequence))
3613 ;; Return the process object as watch-descriptor.
3616 v 'file-notify-error
3617 "`%s' failed to start on remote host"
3623 p))))
3635 ;; Attribute change is returned in unused wording.
3645 string)
3648 proc
3652 ;; File names are returned as absolute paths. We must
3653 ;; add the remote prefix.
3658 ;; Usually, we would add an Emacs event now. Unfortunately,
3659 ;; `unread-command-events' does not accept several events at
3660 ;; once. Therefore, we apply the callback directly.
3663 ;; Save rest of the string.
3672 ;; Check, whether there is a problem.
3678 line)
3683 proc
3690 ;; Usually, we would add an Emacs event now. Unfortunately,
3691 ;; `unread-command-events' does not accept several events at
3692 ;; once. Therefore, we apply the callback directly.
3695 ;;; Internal Functions:
3698 "Define in remote shell function NAME implemented as SCRIPT.
3699 Only send the definition if it has not already been done."
3700 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3701 ;; might be nil.
3706 ;; The script could contain a call of Perl. This is masked with `%s'.
3711 vec
3722 auto-save-default)
3730 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3731 Returns the exit code of the `test' program."
3734 v
3736 "%s %s %s"
3738 switch
3742 "Run `test'-like program on the remote system, given FILE1, FILE2.
3743 FORMAT-STRING contains the program name, switches, and place holders.
3744 Returns the exit code of the `test' program. Barfs if the methods,
3745 hosts, or files, disagree."
3749 v 'file-error
3754 v1
3761 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3762 First arg VEC specifies the connection, PROGNAME is the program
3763 to search for, and DIRLIST gives the list of directories to
3764 search. If IGNORE-TILDE is non-nil, directory names starting
3765 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3766 only in DIRLIST.
3768 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3770 This function expects to be in the right *tramp* buffer."
3773 ;; Check whether the executable is in $PATH. "which(1)" does not
3774 ;; report always a correct error code; therefore we check the
3775 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3776 ;; 5.11") have problems with this command, we disable the call
3777 ;; therefore.
3788 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3789 ;; `remove' is in CL, and we want to avoid CL dependencies.
3798 vec
3800 "do if test -x $d/%s -a -f $d/%s; "
3801 "then echo tramp_executable $d/%s; "
3804 progname progname progname
3805 tramp-end-of-heredoc
3807 tramp-end-of-heredoc))
3813 result)))
3816 "Sets the remote environment PATH to existing directories.
3817 I.e., for each directory in `tramp-remote-path', it is tested
3818 whether it exists and if so, it is added to the environment
3819 variable PATH."
3825 ;; ------------------------------------------------------------
3826 ;; -- Communication with external shell --
3827 ;; ------------------------------------------------------------
3830 "Find a command on the remote host for checking if a file exists.
3831 Here, we are looking for a command which has zero exit status if the
3832 file exists and nonzero exit status otherwise."
3836 result)
3837 ;; The algorithm is as follows: we try a list of several commands.
3838 ;; For each command, we first run `$cmd /' -- this should return
3839 ;; true, as the root directory always exists. And then we run
3840 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3841 ;; does not exist. This should return false. We use the first
3842 ;; command we find that seems to work.
3843 ;; The list of commands to try is as follows:
3844 ;; `ls -d' This works on most systems, but NetBSD 1.4
3845 ;; has a bug: `ls' always returns zero exit
3846 ;; status, even for files which don't exist.
3847 ;; `test -e' Some Bourne shells have a `test' builtin
3848 ;; which does not know the `-e' option.
3849 ;; `/bin/test -e' For those, the `test' binary on disk normally
3850 ;; provides the option. Alas, the binary
3851 ;; is sometimes `/bin/test' and sometimes it's
3852 ;; `/usr/bin/test'.
3853 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3881 result))
3884 "Opens shell SHELL."
3887 ;; Find arguments for this shell.
3889 item extra-args)
3894 ;; It is useful to set the prompt in the following command
3895 ;; because some people have a setting for $PS1 which /bin/sh
3896 ;; doesn't know about and thus /bin/sh will display a strange
3897 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3898 ;; ksh will display the current working directory but /bin/sh
3899 ;; will display a dollar sign. The following command line sets
3900 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3901 ;; well as csh-like shells. We also unset the variable $ENV
3902 ;; because that is read by some sh implementations (eg, bash
3903 ;; when called as sh) on startup; this way, we avoid the startup
3904 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3905 ;; the prompt in /bin/bash, it must be discarded as well.
3908 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3911 "HISTFILE="
3913 ""
3918 t))
3923 "Opens a shell on the remote host which groks tilde expansion."
3931 shell)
3934 ;; CCC: "root" does not exist always, see QNAP 459.
3935 ;; Which check could we apply instead?
3938 ;; The default shell (ksh93) of OpenSolaris and
3939 ;; Solaris is buggy. We've got reports for
3940 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3949 ;; Maybe it works at least for some other commands.
3951 default-shell
3953 vec 2
3955 "Couldn't find a remote shell which groks tilde "
3957 default-shell)))
3959 default-shell)))
3961 ;; Open a new shell if needed.
3967 ;; Utility functions.
3970 "Wait for shell prompt and barf if none appears.
3971 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3972 seconds. If not, it produces an error message with the given ERROR-ARGS."
3976 proc timeout
3985 "Set up an interactive shell.
3986 Mainly sets the prompt and the echo correctly. PROC is the shell
3987 process to set up. VEC specifies the connection."
3990 vec
3995 ;; Disable echo.
3998 ;; Check whether the echo has really been disabled. Some
3999 ;; implementations, like busybox of embedded GNU/Linux, don't
4000 ;; support disabling.
4007 ;; Make sure backspaces and their echo are enabled and no line
4008 ;; width magic interferes with them.
4016 ;; Try to set up the coding system correctly.
4017 ;; CCC this can't be the right way to do it. Hm.
4021 ;; Use MULE to select the right EOL convention for communicating
4022 ;; with the process.
4028 cs-decode cs-encode)
4045 ;; Look for ^M and do something useful if found.
4047 ;; We have found a ^M but cannot frob the process coding system
4048 ;; because we're running on a non-MULE Emacs. Let's try
4049 ;; stty, instead.
4054 ;; Check whether the output of "uname -sr" has been changed. If
4055 ;; yes, this is a strong indication that we must expire all
4056 ;; connection properties. We start again with
4057 ;; `tramp-maybe-open-connection', it will be caught there.
4062 vec "uname"
4066 vec 3
4067 "Connection reset, because remote host changed from `%s' to `%s'"
4068 old-uname new-uname)
4069 ;; We want to keep the password.
4073 ;; Check whether the remote host suffers from buggy
4074 ;; `send-process-string'. This is known for FreeBSD (see comment in
4075 ;; `send_process', file process.c). I've tested sending 624 bytes
4076 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4077 ;; this host type is detected locally. It cannot handle remote
4078 ;; hosts, though.
4082 tramp-chunksize)
4090 ;; Set remote PATH variable.
4093 ;; Search for a good shell before searching for a command which
4094 ;; checks if a file exists. This is done because Tramp wants to use
4095 ;; "test foo; echo $?" to check if various conditions hold, and
4096 ;; there are buggy /bin/sh implementations which don't execute the
4097 ;; "echo $?" part if the "test" part has an error. In particular,
4098 ;; the OpenSolaris /bin/sh is a problem. There are also other
4099 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4100 ;; in function declarations, or changing HISTFILE in place.
4101 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4102 ;; detected.
4105 ;; Disable unexpected output.
4108 ;; IRIX64 bash expands "!" even when in single quotes. This
4109 ;; destroys our shell functions, we must disable it. See
4110 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4114 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4119 ;; Set `remote-tty' process property.
4124 ;; Dump stty settings in the traces.
4128 ;; Set the environment.
4133 unset vars item)
4143 vec
4145 tramp-end-of-heredoc
4147 tramp-end-of-heredoc)
4148 t))
4153 ;; Old text from documentation of tramp-methods:
4154 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4155 ;; of the base64 methods instead since base64 encoding is much more
4156 ;; reliable and the commands are more standardized between the different
4157 ;; Unix versions. But if you can't use base64 for some reason, please
4158 ;; note that the default uudecode command does not work well for some
4159 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4160 ;; the following command for uudecode:
4161 ;;
4162 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4163 ;;
4164 ;; For Irix, no solution is known yet.
4172 "List of local coding commands for inline transfer.
4173 Each item is a list that looks like this:
4175 \(FORMAT ENCODING DECODING\)
4177 FORMAT is symbol describing the encoding/decoding format. It can be
4178 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4180 ENCODING and DECODING can be strings, giving commands, or symbols,
4181 giving functions. If they are strings, then they can contain
4183 file name will be put into the command line at that spot. If the
4184 specifier is not present, the input should be read from standard
4185 input.
4187 If they are functions, they will be called with two arguments, start
4188 and end of region, and are expected to replace the region contents
4193 ;; "-i" is more robust with older base64 from GNU coreutils.
4194 ;; However, I don't know whether all base64 versions do supports
4195 ;; this option.
4207 "List of remote coding commands for inline transfer.
4208 Each item is a list that looks like this:
4210 \(FORMAT ENCODING DECODING [TEST]\)
4212 FORMAT is a symbol describing the encoding/decoding format. It can be
4213 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4215 ENCODING and DECODING can be strings, giving commands, or symbols,
4216 giving variables. If they are strings, then they can contain
4218 file name will be put into the command line at that spot. If the
4219 specifier is not present, the input should be read from standard
4220 input.
4222 If they are variables, this variable is a string containing a
4223 Perl or Shell implementation for this functionality. This
4224 program will be transferred to the remote host, and it is
4226 specifier in the variable value denotes a temporary file.
4228 The optional TEST command can be used for further tests, whether
4232 "Find an inline transfer encoding that works.
4233 Goes through the list `tramp-local-coding-commands' and
4234 `tramp-remote-coding-commands'."
4239 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4247 ;; If the local encoder or decoder is a string, the
4248 ;; corresponding command has to work locally.
4255 loc-enc nil nil))
4263 loc-dec nil nil))
4265 ;; Search for remote coding commands with the same format
4273 ;; Check the remote test command if exists.
4279 ;; Check if remote perl exists when necessary.
4283 ;; Check if remote encoding and decoding commands can be
4284 ;; called remotely with null input and output. This makes
4285 ;; sure there are no syntax errors and the command is really
4286 ;; found. Note that we do not redirect stdout to /dev/null,
4287 ;; for two reasons: when checking the decoding command, we
4288 ;; actually check the output it gives. And also, when
4289 ;; redirecting "mimencode" output to /dev/null, then as root
4290 ;; it might change the permissions of /dev/null!
4298 vec 5
4307 tmpfile)
4314 tramp-temp-name-prefix
4316 value
4318 value
4320 ?t
4326 vec 5
4329 vec
4331 t)
4339 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4345 ;; Set connection properties. Since the commands are risky
4346 ;; (due to output direction), we cache them in the process cache.
4357 "Call the local encoding or decoding command.
4359 Otherwise, INPUT is passed via standard input.
4360 INPUT can also be nil which means `/dev/null'.
4361 OUTPUT can be a string (which specifies a file name), or t (which
4362 means standard output and thus the current buffer), or nil (which
4363 means discard it)."
4365 nil tramp-encoding-shell
4368 nil
4369 tramp-encoding-command-switch
4379 "List of compress and decompress commands for inline transfer.
4380 Each item is a list that looks like this:
4382 \(COMPRESS DECOMPRESS\)
4387 "Find an inline transfer compress command that works.
4388 Goes through the list `tramp-inline-compress-commands'."
4393 item compress decompress found)
4400 vec 5
4401 "Checking local compress commands `%s', `%s' for sanity"
4402 compress decompress)
4407 ;; Windows shells need the program file name after
4408 ;; the pipe symbol be quoted if they use forward
4409 ;; slashes as directory separators.
4416 vec 5
4417 "Checking remote compress commands `%s', `%s' for sanity"
4418 compress decompress)
4424 ;; Did we find something?
4427 ;; Set connection properties. Since the commands are
4428 ;; risky (due to output direction), we cache them in the
4429 ;; process cache.
4443 "Expands VEC according to `tramp-default-proxies-alist'.
4444 Gateway hops are already opened."
4448 choices proxy)
4450 ;; Ad-hoc proxy definitions.
4455 tramp-prefix-format proxy tramp-postfix-host-format)))
4460 proxy)
4461 ;; Add the hop.
4463 'tramp-default-proxies-alist
4466 proxy))
4468 ;; Save the new value.
4473 ;; Look for proxy hosts to be passed.
4479 ;; Host.
4482 ;; User.
4486 ;; No more hops needed.
4488 ;; Replace placeholders.
4491 proxy
4496 ;; Add the hop.
4498 ;; Start next search.
4501 ;; Handle gateways.
4509 ;; Is the method prepared for gateways?
4512 vec 'file-error
4514 ;; Open the gateway connection.
4519 target-alist)
4520 ;; For the password prompt, we need the correct values.
4521 ;; Therefore, we must remember the gateway vector. But we
4522 ;; cannot do it as connection property, because it shouldn't
4523 ;; be persistent. And we have no started process yet either.
4527 ;; Foreign and out-of-band methods are not supported for multi-hops.
4540 vec 'file-error
4541 "Method `%s' is not supported for multi-hops."
4544 ;; In case the host name is not used for the remote shell
4545 ;; command, the user could be misguided by applying a random
4546 ;; hostname.
4552 ;; There are multi-hops.
4554 ;; The host name is used for the remote shell command.
4557 ;; The host is local. We cannot use `tramp-local-host-p'
4558 ;; here, because it opens a connection as well.
4561 v 'file-error
4562 "Host `%s' looks like a remote host, `%s' can only use the local host"
4563 host method)))
4565 ;; Result.
4566 target-alist))
4569 "Maybe open a connection VEC.
4570 Does not do anything if a connection is already open, but re-opens the
4571 connection if a previous connection has died for some reason."
4579 ;; If Tramp opens the same connection within a short time frame,
4580 ;; there is a problem. We shall signal this.
4589 ;; If too much time has passed since last command was sent, look
4590 ;; whether process is still alive. If it isn't, kill it. When
4591 ;; using ssh, it can sometimes happen that the remote end has hung
4592 ;; up but the local ssh client doesn't recognize this until it
4593 ;; tries to send some data to the remote end. So that's why we
4594 ;; try to send a command from time to time, then look again
4595 ;; whether the process is really alive.
4606 ;; The error will be caught locally.
4612 ;; New connection must be opened.
4616 ;; If `non-essential' is non-nil, don't reopen a new connection.
4621 vec 3
4632 ;; Start new process.
4640 tramp-histfile-override)))
4644 ;; We will apply `tramp-ssh-controlmaster-options'
4645 ;; only for the first hop.
4651 ;; This must be done in order to avoid our file
4652 ;; name handler.
4656 'start-process
4661 tramp-encoding-command-interactive)
4664 ;; Set sentinel and query flag.
4675 ;; Check whether process is alive.
4677 p 10
4680 ;; Now do all the connections as specified.
4710 ;; We don't create the temporary file. In
4711 ;; fact, it is just a prefix for the
4712 ;; ControlPath option of ssh; the real
4713 ;; temporary file has another name, and it is
4714 ;; created and protected by ssh. It is also
4715 ;; removed by ssh when the connection is
4716 ;; closed. The temporary file name is cached
4717 ;; in the main connection process, therefore
4718 ;; we cannot use `tramp-get-connection-process'.
4724 tramp-temp-name-prefix
4726 spec r-shell)
4728 ;; Add arguments for asynchronous processes.
4732 ;; Add gateway arguments if necessary.
4738 ;; Check for port number. Until now, there's no
4739 ;; need for handling like method, user, host.
4744 ;; Check, whether there is a restricted shell.
4749 ;; Set variables for computing the prompt for
4750 ;; reading password. They can also be derived
4751 ;; from a gateway.
4756 ;; Add login environment.
4759 login-env
4764 login-env))
4768 "%s=%s %s"
4771 command)))
4774 ;; Replace `login-args' place holders.
4782 ?h l-host ?u l-user ?p l-port ?c options)
4783 command
4785 ;; We do not want to see the trailing local
4786 ;; prompt in `start-file-process'.
4788 command " "
4794 ;; Local shell could be a Windows COMSPEC. It
4795 ;; doesn't know the ";" syntax, but we must exit
4796 ;; always for `start-file-process'. It could
4797 ;; also be a restricted shell, which does not
4798 ;; allow "exec".
4801 ;; Send the command.
4805 p vec pos tramp-actions-before-shell
4809 ;; Next hop.
4813 ;; Make initial shell settings.
4816 ;; When the user did interrupt, we must cleanup.
4819 ;; Propagate the quit signal.
4823 "Send the COMMAND to connection VEC.
4824 Erases temporary buffer before sending the command. If optional
4825 arg NEVEROPEN is non-nil, never try to open the connection. This
4826 is meant to be used from `tramp-maybe-open-connection' only. The
4827 function waits for output unless NOOUTPUT is set."
4831 ;; We mark the command string that it can be erased in the output buffer.
4833 ;; If we put `tramp-echo-mark' after a trailing newline (which
4834 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4835 ;; that newline and adds `tramp-rsh-end-of-line' right after
4836 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4837 ;; trailing line endings and sends two prompts after executing
4838 ;; the command, which confuses `tramp-wait-for-output'.
4842 ;; No need to restore a trailing newline here since `tramp-send-string'
4843 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4845 ;; Send the command.
4851 "Wait for output from remote command."
4857 ;; be leading escape sequences, which must be ignored.
4859 ;; Sometimes, the commands do not return a newline but a
4860 ;; null byte before the shell prompt, for example "git
4861 ;; ls-files -c -z ...".
4866 ;; A simple-minded busybox has sent " ^H" sequences.
4867 ;; Delete them.
4872 ;; Delete the prompt.
4878 proc 'file-error
4879 "[[Remote prompt `%s' not found in %d secs]]"
4880 tramp-end-of-output timeout)
4882 proc 'file-error
4884 ;; Return value is whether end-of-output sentinel was found.
4885 found)))
4889 "Run COMMAND and check its exit status.
4890 Sends `echo $?' along with the COMMAND for checking the exit status.
4891 If COMMAND is nil, just sends `echo $?'. Returns `t' if the exit
4892 status is 0, and `nil' otherwise.
4894 If the optional argument SUBSHELL is non-nil, the command is
4895 executed in a subshell, ie surrounded by parentheses. If
4896 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4898 vec
4900 command
4902 "echo tramp_exit_status $?"
4916 "Run COMMAND, check exit status, throw error if exit status not okay.
4917 Similar to `tramp-send-command-and-check' but accepts two more arguments
4918 FMT and ARGS which are passed to `error'."
4923 "Run COMMAND and return the output, which must be a Lisp expression.
4924 If MARKER is a regexp, read the output after that string.
4925 In case there is no valid Lisp expression and NOERROR is nil, it
4926 raises an error."
4933 ;; Read the marker.
4939 vec 'file-error
4940 "`%s' does not return the marker `%s': `%s'"
4942 ;; Read the expression.
4945 ;; Error handling.
4950 vec 'file-error
4951 "`%s' does not return a valid Lisp expression: `%s'"
4955 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4956 Convert file mode bits to string and set virtual device number.
4957 Return ATTR."
4959 ;; Remove color escape sequences from symlink.
4963 ;; Convert uid and gid. Use -1 as indication of unusable value.
4974 ;; Convert last access time.
4979 ;; Convert last modification time.
4984 ;; Convert last status change time.
4989 ;; Convert file size.
4995 ;; Convert file mode bits to string.
5000 ;; Convert directory indication bit.
5003 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5009 ;; Set file's gid change bit.
5017 ;; Convert inode.
5023 ;; Inodes can be incredible huge. We must hide this.
5025 ;; Set virtual device number.
5028 attr))
5031 "Converts STRING to shell glob pattern which ignores case."
5037 string
5041 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
5049 localname)
5055 "Return t if this is an out-of-band method, nil otherwise."
5057 ;; It shall be an out-of-band method.
5059 ;; There must be a size, otherwise the file doesn't exist.
5061 ;; Either the file size is large enough, or (in rare cases) there
5062 ;; does not exist a remote encoding.
5067 ;; Variables local to connection.
5071 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5072 ;; cache the result for the session only. Otherwise, the result
5073 ;; is cached persistently.
5076 vec)
5077 "remote-path"
5086 ;; Default if "getconf" is not available.
5089 vec 3
5094 ;; The login shell could return more than just the $PATH
5095 ;; string. So we use `tramp-end-of-heredoc' as marker.
5098 vec
5104 'identity
5111 ;; Replace place holder `tramp-default-remote-path'.
5119 ;; Replace place holder `tramp-own-remote-path'.
5127 ;; Remove double entries.
5134 ;; Remove non-existing directories.
5136 nil
5146 x))
5147 x))
5148 remote-path)))))
5154 locale)
5160 candidates nil)
5162 ;; Return value.
5172 result)
5174 ;; Check parameters. On busybox, "ls" output coloring is
5175 ;; enabled by default sometimes. So we try to disable it
5176 ;; when possible. $LS_COLORING is not supported there.
5177 ;; Some "ls" versions are sensible wrt the order of
5178 ;; arguments, they fail when "-al" is after the
5179 ;; "--color=never" argument (for example on FreeBSD).
5194 ;; Some "ls" versions are sensible wrt the order of arguments,
5195 ;; they fail when "-al" is after the "--dired" argument (for
5196 ;; example on FreeBSD).
5204 "test"
5208 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5209 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5210 ;; for otherwise the shell crashes.
5222 vec
5245 ;; We must check also for some Perl modules.
5253 result)))
5260 tmp)
5261 ;; Check whether stat(1) returns usable syntax. "%s" does not
5262 ;; work on older AIX systems.
5271 result)))
5281 result))))
5297 ;; Busyboxes do support the "-t" option only when they have been
5298 ;; built with the DESKTOP config option. Let's check it.
5301 vec "touch-t"
5303 vec
5305 "%s -t %s %s"
5306 result
5310 result)))
5329 result)
5331 ;; Check POSIX parameter.
5338 vec
5347 vec
5351 "print $>"
5363 vec
5367 "import os; print (os.getuid())"
5381 ;; Ensure there is a valid result.
5389 vec
5398 vec
5407 vec
5411 "import os; print (os.getgid())"
5425 ;; Ensure there is a valid result.
5431 ;; Some predefined connection properties.
5433 "Return the compress command related to PROP.
5434 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5435 the length of the file to be compressed.
5437 If no corresponding command is found, nil is returned."
5446 "Return the coding command related to PROP.
5447 PROP is either `remote-encoding', `remote-decoding',
5448 `local-encoding' or `local-decoding'.
5450 SIZE is the length of the file to be coded. Depending on SIZE,
5451 compression might be applied.
5453 If no corresponding command is found, nil is returned.
5454 Otherwise, either a string is returned which contains a `%s' mark
5455 to be used for the respective input or output file; or a Lisp
5456 function cell is returned to be applied on a buffer."
5457 ;; We must catch the errors, because we want to return `nil', when
5458 ;; no inline coding is found.
5468 compress)
5469 ;; The connection property might have been cached. So we must
5470 ;; send the script to the remote side - maybe.
5478 ;; Check for the `compress' command.
5480 ;; Return the value.
5496 'call-process-region beg end
5501 coding)
5504 ;; Windows shells need the program file name after
5505 ;; the pipe symbol be quoted if they use forward
5506 ;; slashes as directory separators.
5513 coding compress))
5516 ;; Windows shells need the program file name after
5517 ;; the pipe symbol be quoted if they use forward
5518 ;; slashes as directory separators.
5523 compress coding))
5537 ;;; TODO:
5539 ;; * Don't use globbing for directories with many files, as this is
5540 ;; likely to produce long command lines, and some shells choke on
5541 ;; long command lines.
5542 ;; * Make it work for different encodings, and for different file name
5543 ;; encodings, too. (Daniel Pittman)
5544 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5545 ;; then look if it's the right version (with `perl -v').
5546 ;; * When editing a remote CVS controlled file as a different user, VC
5547 ;; gets confused about the file locking status. Try to find out why
5548 ;; the workaround doesn't work.
5549 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5550 ;; until the last but one hop via `start-file-process'. Apply it
5551 ;; also for ftp and smb.
5552 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5553 ;; some shell with root privileges, it would be nice if I could
5554 ;; just call
5555 ;; trampclient filename.c
5556 ;; as an editor, and the _current_ shell would connect to an Emacs
5557 ;; server and would be used in an existing non-privileged Emacs
5558 ;; session for doing the editing in question.
5559 ;; That way, I need not tell Emacs my password again and be afraid
5560 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5561 ;; once display a just typed password in the context of a keyboard
5562 ;; sequence prompt for a question immediately following in a shell
5563 ;; script run within Emacs -- nasty).
5564 ;; And if I have some ssh session running to a different computer,
5565 ;; having the possibility of passing a local file there to a local
5566 ;; Emacs session (in case I can arrange for a connection back) would
5567 ;; be nice.
5568 ;; Likely the corresponding Tramp server should not allow the
5569 ;; equivalent of the emacsclient -eval option in order to make this
5570 ;; reasonably unproblematic. And maybe trampclient should have some
5571 ;; way of passing credentials, like by using an SSL socket or
5572 ;; something. (David Kastrup)
5573 ;; * Reconnect directly to a compliant shell without first going
5574 ;; through the user's default shell. (Pete Forman)
5575 ;; * How can I interrupt the remote process with a signal
5576 ;; (interrupt-process seems not to work)? (Markus Triska)
5577 ;; * Avoid the local shell entirely for starting remote processes. If
5578 ;; so, I think even a signal, when delivered directly to the local
5579 ;; SSH instance, would correctly be propagated to the remote process
5580 ;; automatically; possibly SSH would have to be started with
5581 ;; "-t". (Markus Triska)
5582 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5583 ;; isn't on the remote host. (Mark A. Hershberger)
5584 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5585 ;; * Optimize out-of-band copying when both methods are scp-like (not
5586 ;; rsync).
5587 ;; * Keep a second connection open for out-of-band methods like scp or
5588 ;; rsync.
5590 ;;; tramp-sh.el ends here