| blob | bb939bf2df87c85f28997e6d9566b5f55f2dbc75 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2015 Free Software Foundation, Inc.
5 ;; (copyright statements below in code to be updated with the above notice)
7 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Keywords: comm, processes
10 ;; Package: tramp
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Code:
31 ;; Pacify byte-compiler.
43 ;;;###tramp-autoload
45 "The minimum size of compressing where inline transfer.
46 When inline transfer, compress transferred data of file
47 whose size is this value or above (up to `tramp-copy-size-limit').
48 If it is nil, no compression at all will be applied."
52 ;;;###tramp-autoload
54 "The maximum file size where inline copying is preferred over an \
55 out-of-the-band copy.
56 If it is nil, out-of-the-band copy will be used without a check."
60 ;;;###tramp-autoload
62 "Value of TERM environment variable for logging in to remote host.
63 Because Tramp wants to parse the output of the remote shell, it is easily
64 confused by ANSI color escape sequences and suchlike. Often, shell init
65 files conditionalize this setup based on the TERM environment variable."
69 ;;;###tramp-autoload
71 "When invoking a shell, override the HISTFILE with this value.
72 When setting to a string, it redirects the shell history to that
76 The value t, the default value, unsets any setting of HISTFILE,
77 and sets both HISTFILESIZE and HISTSIZE to 0. If you set this
78 variable to nil, however, the *override* is disabled, so the
79 history will go to the default storage location,
87 ;;;###tramp-autoload
91 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
92 ;; root users. It uses the `$' character for other users. In order
93 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
97 "///%s#$"
99 "String used to recognize end of output.
100 The '$' character at the end is quoted; the string cannot be
103 ;;;###tramp-autoload
110 ;;;###tramp-autoload
112 "Whether to use `tramp-ssh-controlmaster-options'."
118 "Which ssh Control* arguments to use.
120 If it is a string, it should have the form
123 spec must be doubled, because the string is used as format string.
125 Otherwise, it will be auto-detected by Tramp, if
126 `tramp-use-ssh-controlmaster-options' is non-nil. The value
127 depends on the installed local ssh version.
131 ;; Initialize `tramp-methods' with the supported methods.
132 ;;;###tramp-autoload
144 ;;;###tramp-autoload
155 ;;;###tramp-autoload
173 ;;;###tramp-autoload
192 ;;;###tramp-autoload
208 ;;;###tramp-autoload
216 ;;;###tramp-autoload
224 ;;;###tramp-autoload
238 ;;;###tramp-autoload
252 ;;;###tramp-autoload
261 ;;;###tramp-autoload
270 ;; We use "-v" for better error tracking.
273 ;; We use "-p" as required for newer busyboxes. For older
274 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
275 ;; can be achieved by tweaking `tramp-connection-properties'.
278 ;;;###tramp-autoload
287 ;;;###tramp-autoload
292 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
298 ;;;###tramp-autoload
307 ;;;###tramp-autoload
315 ;;;###tramp-autoload
319 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
323 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
324 tramp-terminal-type
325 tramp-initial-end-of-output))
331 ;;;###tramp-autoload
337 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
338 tramp-terminal-type
339 tramp-initial-end-of-output))
344 ;;;###tramp-autoload
351 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
352 tramp-terminal-type
353 tramp-initial-end-of-output))
364 ;;;###tramp-autoload
371 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
372 tramp-terminal-type
373 tramp-initial-end-of-output))
383 ;;;###tramp-autoload
395 ;;;###tramp-autoload
399 ;;;###tramp-autoload
403 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
404 ;; Do not add "plink" based methods, they ask interactively for the user.
405 ;;;###tramp-autoload
414 ;;;###tramp-autoload
420 ;;;###tramp-autoload
436 ;;;###tramp-autoload
441 ;;;###tramp-autoload
446 ;;;###tramp-autoload
454 ;;;###tramp-autoload
481 ;; "getconf PATH" yields:
482 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
483 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
484 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
485 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
486 ;; IRIX64: /usr/bin
487 ;;;###tramp-autoload
493 "List of directories to search for executables on remote host.
494 For every remote host, this variable will be set buffer local,
495 keeping the list of existing directories on that host.
497 You can use `~' in this list, but when searching for a shell which groks
498 tilde expansion, all directory names starting with `~' will be ignored.
500 `Default Directories' represent the list of directories given by
502 entry on top of this list, because these are the default
503 directories for POSIX compatible commands. On remote hosts which
504 do not offer the getconf command (like cygwin), the value
507 `Private Directories' are the settings of the $PATH environment,
508 as given in your `~/.profile'."
515 ;;;###tramp-autoload
522 "List of environment variables to be set on the remote host.
524 Each element should be a string of the form ENVVARNAME=VALUE. An
525 entry ENVVARNAME= disables the corresponding environment variable,
526 which might have been set in the init files like ~/.profile.
528 Special handling is applied to the PATH environment, which should
529 not be set here. Instead, it should be set via `tramp-remote-path'."
534 ;;;###tramp-autoload
536 "Alist specifying extra arguments to pass to the remote shell.
537 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
538 matching the shell file name and ARGS is a string specifying the
539 arguments.
541 This variable is only used when Tramp needs to start up another shell
542 for tilde expansion. The extra arguments should typically prevent the
543 shell from reading its init file."
545 ;; This might be the wrong way to test whether the widget type
546 ;; `alist' is available. Who knows the right way to test it?
561 "List of pattern/action pairs.
562 Whenever a pattern matches, the corresponding action is performed.
563 Each item looks like (PATTERN ACTION).
565 The PATTERN should be a symbol, a variable. The value of this
566 variable gives the regular expression to search for. Note that the
568 appended to it.
570 The ACTION should also be a symbol, but a function. When the
578 "List of pattern/action pairs.
579 This list is used for copying/renaming with out-of-band methods.
584 "(echo begin 600 %t; tail -n +2) | uudecode
585 cat %t
586 rm -f %t"
587 "Shell function to implement `uudecode' to standard output.
588 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
589 for this or `uudecode -p', but some systems don't, and for them
593 "%s -e '
594 use File::Spec;
597 sub recursive {
598 my ($volume, @dirs) = @_;
599 my $real = realpath(File::Spec->catpath(
601 if ($real) {
602 my ($vol, $dir) = File::Spec->splitpath($real, 1);
603 return ($vol, File::Spec->splitdir($dir));
604 }
605 else {
606 my $last = pop(@dirs);
607 ($volume, @dirs) = recursive($volume, @dirs);
608 push(@dirs, $last);
609 return ($volume, @dirs);
610 }
611 }
613 $result = realpath($ARGV[0]);
614 if (!$result) {
615 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
616 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
619 }
623 }
627 "Perl script to produce output suitable for use with `file-truename'
628 on the remote file system.
629 Escape sequence %s is replaced with name of Perl binary.
633 "%s -e 'sub case {
634 my $str = shift;
635 if ($ARGV[2]) {
636 return lc($str);
637 }
638 else {
639 return $str;
640 }
641 }
643 @files = readdir(d); closedir(d);
644 foreach $f (@files) {
645 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
648 }
649 else {
651 }
652 }
653 }
656 "Perl script to produce output suitable for use with
657 `file-name-all-completions' on the remote file system. Escape
658 sequence %s is replaced with name of Perl binary. This string is
661 ;; Perl script to implement `file-attributes' in a Lisp `read'able
662 ;; output. If you are hacking on this, note that you get *no* output
663 ;; unless this spits out a complete line, including the '\n' at the
664 ;; end.
665 ;; The device number is returned as "-1", because there will be a virtual
666 ;; device number set in `tramp-sh-handle-file-attributes'.
668 "%s -e '
669 @stat = lstat($ARGV[0]);
670 if (!@stat) {
672 exit 0;
673 }
674 if (($stat[2] & 0170000) == 0120000)
675 {
676 $type = readlink($ARGV[0]);
679 }
680 elsif (($stat[2] & 0170000) == 040000)
681 {
683 }
684 else
685 {
687 };
690 printf(
692 $type,
693 $stat[3],
694 $uid,
695 $gid,
696 $stat[8] >> 16 & 0xffff,
697 $stat[8] & 0xffff,
698 $stat[9] >> 16 & 0xffff,
699 $stat[9] & 0xffff,
700 $stat[10] >> 16 & 0xffff,
701 $stat[10] & 0xffff,
702 $stat[7],
703 $stat[2],
704 $stat[1] >> 16 & 0xffff,
705 $stat[1] & 0xffff
707 "Perl script to produce output suitable for use with `file-attributes'
708 on the remote file system.
709 Escape sequence %s is replaced with name of Perl binary.
713 "%s -e '
716 @list = readdir(DIR);
717 closedir(DIR);
718 $n = scalar(@list);
720 for($i = 0; $i < $n; $i++)
721 {
722 $filename = $list[$i];
723 @stat = lstat($filename);
724 if (($stat[2] & 0170000) == 0120000)
725 {
726 $type = readlink($filename);
729 }
730 elsif (($stat[2] & 0170000) == 040000)
731 {
733 }
734 else
735 {
737 };
741 printf(
742 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
743 $filename,
744 $type,
745 $stat[3],
746 $uid,
747 $gid,
748 $stat[8] >> 16 & 0xffff,
749 $stat[8] & 0xffff,
750 $stat[9] >> 16 & 0xffff,
751 $stat[9] & 0xffff,
752 $stat[10] >> 16 & 0xffff,
753 $stat[10] & 0xffff,
754 $stat[7],
755 $stat[2],
756 $stat[1] >> 16 & 0xffff,
757 $stat[1] & 0xffff,
758 $stat[0] >> 16 & 0xffff,
759 $stat[0] & 0xffff);
760 }
762 "Perl script implementing `directory-files-attributes' as Lisp `read'able
763 output.
764 Escape sequence %s is replaced with name of Perl binary.
767 ;; These two use base64 encoding.
769 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
770 "Perl program to use for encoding a file.
771 Escape sequence %s is replaced with name of Perl binary.
772 This string is passed to `format', so percent characters need to be doubled.
773 This implementation requires the MIME::Base64 Perl module to be installed
777 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
778 "Perl program to use for decoding a file.
779 Escape sequence %s is replaced with name of Perl binary.
780 This string is passed to `format', so percent characters need to be doubled.
781 This implementation requires the MIME::Base64 Perl module to be installed
785 "%s -e '
786 # This script contributed by Juanma Barranquero <lektu@terra.es>.
787 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
788 use strict;
790 my %%trans = do {
791 my $i = 0;
792 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
793 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
794 };
795 my $data;
797 # We read in chunks of 54 bytes, to generate output lines
798 # of 72 chars (plus end of line)
799 while (read STDIN, $data, 54) {
800 my $pad = q();
802 # Only for the last chunk, and only if did not fill the last three-byte packet
803 if (eof) {
804 my $mod = length($data) %% 3;
805 $pad = q(=) x (3 - $mod) if $mod;
806 }
808 # Not the fastest method, but it is simple: unpack to binary string, split
809 # by groups of 6 bits and convert back from binary to byte; then map into
810 # the translation table
811 print
812 join q(),
813 map($trans{$_},
814 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
815 $pad,
817 }' 2>/dev/null"
818 "Perl program to use for encoding a file.
819 Escape sequence %s is replaced with name of Perl binary.
823 "%s -e '
824 # This script contributed by Juanma Barranquero <lektu@terra.es>.
825 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
826 use strict;
828 my %%trans = do {
829 my $i = 0;
830 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
831 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
832 };
834 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
838 # We are going to accumulate into $pending to accept any line length
839 # (we do not check they are <= 76 chars as the RFC says)
840 my $pending = q();
842 while (my $data = <STDIN>) {
843 chomp $data;
845 # If we find one or two =, we have reached the end and
846 # any following data is to be discarded
847 my $finished = $data =~ s/(==?).*/$1/;
848 $pending .= $data;
850 my $len = length($pending);
851 my $chunk = substr($pending, 0, $len & ~3);
852 $pending = substr($pending, $len & ~3 + 1);
854 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
855 # split in 8-bit chunks and convert back to char.
856 print join q(),
857 map $bytes{$_},
858 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
860 last if $finished;
861 }' 2>/dev/null"
862 "Perl program to use for decoding a file.
863 Escape sequence %s is replaced with name of Perl binary.
867 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
868 "Perl program to use for encoding a file.
872 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
873 "Perl program to use for decoding a file.
878 while read file; do
881 else
883 fi
886 else
888 fi
889 done
891 "Script to check existence of VC related files.
892 It must be send formatted with two strings; the tests for file
893 existence, and file readability. Input shall be read via
894 here-document, otherwise the command could exceed maximum length
897 ;; New handlers should be added here.
901 ;; `byte-compiler-base-file-name' performed by default handler.
906 ;; `diff-latest-backup-file' performed by default handler.
910 . tramp-sh-handle-directory-files-and-attributes)
911 ;; `dired-call-process' performed by default handler.
914 . tramp-sh-handle-dired-recursive-delete-directory)
921 ;; `file-equal-p' performed by default handler.
924 ;; `file-in-directory-p' performed by default handler.
932 ;; `file-name-sans-versions' performed by default handler.
945 ;; `find-file-noselect' performed by default handler.
946 ;; `get-file-buffer' performed by default handler.
950 . tramp-sh-handle-insert-file-contents-literally)
969 "Alist of handler functions.
972 ;; This must be the last entry, because `identity' always matches.
973 ;;;###tramp-autoload
977 ;;; File Name Handler Functions:
981 "Like `make-symbolic-link' for Tramp files.
982 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
983 the symlink. If LINKNAME is a Tramp file, only the localname component is
984 used as the target of the symlink.
986 If LINKNAME is a Tramp file and the localname component is relative, then
987 it is expanded first, before the localname component is taken. Note that
988 this can give surprising results if the user/host for the source and
989 target of the symlink differ."
996 l 'file-error
999 ;; Do the 'confirm if exists' thing.
1001 ;; What to do?
1006 "File %s already exists; make it a link anyway? "
1007 l-localname)))))
1012 ;; If FILENAME is a Tramp name, use just the localname component.
1021 ;; Right, they are on the same host, regardless of user, method,
1022 ;; etc. We now make the link on the remote machine. This will
1023 ;; occur as the user that FILENAME belongs to.
1025 l
1027 "cd %s && %s -sf %s %s"
1029 ln
1032 t))))
1035 "Like `file-truename' for Tramp files."
1037 "%s%s"
1040 method user host
1045 ;; Use GNU readlink --canonicalize-missing where available.
1048 v
1056 ;; Use Perl implementation.
1064 v
1068 ;; Do it yourself. We bind `directory-sep-char' here for
1069 ;; XEmacs on Windows, which would otherwise use backslash.
1077 ;; Don't make the following value larger than
1078 ;; necessary. People expect an error message in
1079 ;; a timely fashion when something is wrong;
1080 ;; otherwise they might think that Emacs is hung.
1081 ;; Of course, correctness has to come first.
1083 symlink-target)
1094 method user host
1106 ;; It's a symlink, follow it.
1112 ;; If the symlink was absolute, we'll get a
1113 ;; string like "/user@host:/some/target";
1114 ;; extract the "/some/target" part from it.
1118 v 'file-error
1119 "Symlink target `%s' on wrong host"
1120 symlink-target))
1125 steps)))
1127 ;; It's a file.
1131 v 'file-error
1134 ;; Combine list to form string.
1145 result))))
1147 ;; Preserve trailing "/".
1150 ;; Basic functions.
1153 "Like `file-exists-p' for Tramp files."
1161 v
1163 "%s %s"
1168 "Like `file-attributes' for Tramp files."
1171 ;; Don't modify `last-coding-system-used' by accident.
1178 v
1186 ;; The scripts could fail, for example with huge file size.
1190 "Implement `file-attributes' for Tramp files using the ls(1) command."
1192 res-inode res-filemodes res-numlinks
1193 res-uid res-gid res-size res-symlink-target)
1196 vec
1203 ;; On systems which have no quoting style, file names
1204 ;; with special characters could fail.
1209 ;; Parse `ls -l' output ...
1213 ;; ... inode
1229 ;; ... file mode flags
1231 ;; ... number links
1233 ;; ... uid and gid
1243 ;; ... size
1245 ;; From the file modes, figure out other stuff.
1248 ;; If symlink, find out file name pointed to.
1255 ;; Return data gathered.
1257 ;; 0. t for directory, string (name linked to) for symbolic
1258 ;; link, or nil.
1260 ;; 1. Number of links to file.
1261 res-numlinks
1262 ;; 2. File uid.
1263 res-uid
1264 ;; 3. File gid.
1265 res-gid
1266 ;; 4. Last access time, as a list of integers. Normally this
1267 ;; would be in the same format as `current-time', but the
1268 ;; subseconds part is not currently implemented, and (0 0)
1269 ;; denotes an unknown time.
1270 ;; 5. Last modification time, likewise.
1271 ;; 6. Last status change time, likewise.
1273 ;; 7. Size in bytes (-1, if number is out of range).
1274 res-size
1275 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1276 res-filemodes
1277 ;; 9. t if file's gid would change if file were deleted and
1278 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1279 t
1280 ;; 10. Inode number.
1281 res-inode
1282 ;; 11. Device number. Will be replaced by a virtual device number.
1283 -1
1284 )))))
1288 "Implement `file-attributes' for Tramp files using a Perl script."
1293 vec
1299 "Implement `file-attributes' for Tramp files using stat(1) command."
1302 vec
1305 ;; On Opsware, pdksh (which is the true name of ksh there)
1306 ;; doesn't parse correctly the sequence "((". Therefore, we add
1307 ;; a space. Apostrophes in the stat output are masked as "//",
1308 ;; in order to make a proper shell escape of them in file names.
1309 "( (%s %s || %s -h %s) && (%s -c "
1310 "'((//%%N//) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 //%%A// t %%ie0 -1)' "
1322 "Like `set-visited-file-modtime' for Tramp files."
1329 coding-system-used)
1333 ;; '(-1 65535) means file doesn't exists yet.
1337 ;; We use '(0 0) as a don't-know value. See also
1338 ;; `tramp-do-file-attributes-with-ls'.
1343 v
1352 nil)))))
1354 ;; This function makes the same assumption as
1355 ;; `tramp-sh-handle-set-visited-file-modtime'.
1357 "Like `verify-visited-file-modtime' for Tramp files.
1358 At the time `verify-visited-file-modtime' calls this function, we
1359 already know that the buffer is visiting a file and that
1360 `visited-file-modtime' does not return 0. Do not call this
1361 function directly, unless those two cases are already taken care
1362 of."
1365 ;; There is no file visiting the buffer, or the buffer has no
1366 ;; recorded last modification time, or there is no established
1367 ;; connection.
1371 t
1379 ;; File exists, and has a known modtime.
1382 modtime
1383 ;; For compatibility, deal with both the old
1384 ;; (HIGH . LOW) and the new (HIGH LOW) return
1385 ;; values of `visited-file-modtime'.
1388 mt)))
1390 ;; Modtime has the don't know value.
1393 v
1400 attr
1403 ;; If file does not exist, say it is not modified if and
1404 ;; only if that agrees with the buffer's record.
1408 "Like `set-file-modes' for Tramp files."
1411 ;; FIXME: extract the proper text from chmod's stderr.
1413 v
1420 "Like `set-file-times' for Tramp files."
1427 time))
1428 ;; With GNU Emacs, `format-time-string' has an
1429 ;; optional parameter UNIVERSAL. This is preferred,
1430 ;; because we could handle the case when the remote
1431 ;; host is located in a different time zone as the
1432 ;; local host.
1436 "%s %s %s %s"
1447 ;; We handle also the local part, because in older Emacsen,
1448 ;; without `set-file-times', this function is an alias for this.
1449 ;; We are local, so we don't need the UTC settings.
1457 "Set the ownership for FILENAME.
1458 If UID and GID are provided, these values are used; otherwise uid
1459 and gid of the corresponding user is taken. Both parameters must
1460 be non-negative integers."
1461 ;; Modern Unices allow chown only for root. So we might need
1462 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1463 ;; working with su(do)? when it is needed, so it shall succeed in
1464 ;; the majority of cases.
1465 ;; Don't modify `last-coding-system-used' by accident.
1470 ;; If we are root on the local host, we can do it directly.
1478 "chown %d:%d %s" uid gid
1481 ;; We handle also the local part, because there doesn't exist
1482 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1483 ;; timeout for this.
1488 nil "chown" nil nil nil
1492 "Check, whether SELINUX is enabled on the remote host."
1504 "Like `file-selinux-context' for Tramp files."
1513 "%s -d -Z %s"
1521 ;; Return the context.
1522 context))))
1525 "Like `set-file-selinux-context' for Tramp files."
1542 t)
1544 nil)))
1547 "Check, whether ACL is enabled on the remote host."
1552 "Like `file-acl' for Tramp files."
1558 "getfacl -ac %s 2>/dev/null"
1568 "Like `set-file-acl' for Tramp files."
1575 tramp-end-of-heredoc
1576 acl-string
1577 tramp-end-of-heredoc))
1579 ;; Success.
1582 t)
1583 ;; In case of errors, we return nil.
1585 nil)))
1587 ;; Simple functions using the `test' command.
1590 "Like `file-executable-p' for Tramp files."
1593 ;; Examine `file-attributes' cache to see if request can be
1594 ;; satisfied without remote operation.
1599 "Like `file-readable-p' for Tramp files."
1602 ;; Examine `file-attributes' cache to see if request can be
1603 ;; satisfied without remote operation.
1607 ;; When the remote shell is started, it looks for a shell which groks
1608 ;; tilde expansion. Here, we assume that all shells which grok tilde
1609 ;; expansion will also provide a `test' command which groks `-nt' (for
1610 ;; newer than). If this breaks, tell me about it and I'll try to do
1611 ;; something smarter about it.
1613 "Like `file-newer-than-file-p' for Tramp files."
1615 nil)
1617 t)
1618 ;; We are sure both files exist at this point.
1621 ;; We try to get the mtime of both files. If they are not
1622 ;; equal to the "dont-know" value, then we subtract the times
1623 ;; and obtain the result.
1629 ;; If one of them is the dont-know value, then we can
1630 ;; still try to run a shell command on the remote host.
1631 ;; However, this only works if both files are Tramp
1632 ;; files and both have the same method, same user, same
1633 ;; host.
1638 v 'file-error
1639 "Files %s and %s must have same method, user, host"
1640 file1 file2)))
1645 ;; Functions implemented using the basic functions above.
1648 "Like `file-directory-p' for Tramp files."
1650 ;; `file-directory-p' is used as predicate for file name completion.
1651 ;; Sometimes, when a connection is not established yet, it is
1652 ;; desirable to return t immediately for "/method:foo:". It can
1653 ;; be expected that this is always a directory.
1659 "Like `file-writable-p' for Tramp files."
1663 ;; Examine `file-attributes' cache to see if request can be
1664 ;; satisfied without remote operation.
1667 ;; If file doesn't exist, check if directory is writable.
1672 "Like `file-ownership-preserved-p' for Tramp files."
1676 ;; Return t if the file doesn't exist, since it's true that no
1677 ;; information would be lost by an (attempted) delete and create.
1684 ;; Directory listings.
1688 "Like `directory-files-and-attributes' for Tramp files."
1696 v localname
1707 v localname id-format))
1710 v localname id-format))
1712 result item)
1722 result
1724 ;; The scripts could fail, for example with huge file size.
1726 directory full match nosort id-format)))))
1730 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1733 vec tramp-perl-directory-files-and-attributes
1737 vec
1741 object))
1745 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1748 vec
1751 ;; We must care about file names with spaces, or starting with
1752 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1753 ;; but it does not work on all remote systems. Apostrophes in
1754 ;; the stat output are masked as "//", in order to make a proper
1755 ;; shell escape of them in file names.
1757 "xargs %s -c "
1758 "'(//%%n// (//%%N//) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 //%%A// t %%ie0 -1)' "
1762 ;; On systems which have no quoting style, file names with
1763 ;; special characters could fail.
1770 ;; This function should return "foo/" for directories and "bar" for
1771 ;; files.
1773 "Like `file-name-all-completions' for Tramp files."
1778 filename
1780 'list
1782 ;; Try cache entries for `filename', `filename' with last
1783 ;; character removed, `filename' with last two characters
1784 ;; removed, ..., and finally the empty string - all
1785 ;; concatenated to the local directory name.
1788 tramp-completion-reread-directory-timeout)))
1790 ;; This is inefficient for very long file names, pity
1791 ;; `reduce' is not available...
1794 'append
1799 v
1801 "file-name-all-completions"
1802 nil)))
1804 ;; We cannot use a length of 0, because file properties
1805 ;; for "foo" and "foo/" are identical.
1808 ;; Cache expired or no matching cache entry found so we need
1809 ;; to perform a remote operation.
1811 ;; Get a list of directories and files, including reliably
1812 ;; tagging the directories with a trailing '/'. Because I
1813 ;; rock. --daniel@danann.net
1815 ;; Changed to perform `cd' in the same remote op and only
1816 ;; get entries starting with `filename'. Capture any `cd'
1817 ;; error messages. Ensure any `cd' and `echo' aliases are
1818 ;; ignored.
1820 v
1824 v tramp-perl-file-name-all-completions
1830 ;; `read-file-name-completion-ignore-case'
1831 ;; is introduced with Emacs 22.1.
1834 'read-file-name-completion-ignore-case
1839 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1840 ;; `ls' with wildcard might fail with `Argument
1841 ;; list too long' error in some corner cases; if
1842 ;; `ls' fails after `cd' succeeded, chances are
1843 ;; that's the case, so let's retry without
1844 ;; wildcard. This will return "too many" entries
1845 ;; but that isn't harmful.
1846 " || %s -a 2>/dev/null)"
1847 " | while IFS= read f; do"
1853 ;; When `filename' is empty, just `ls' without
1854 ;; `filename' argument is more efficient than `ls *'
1855 ;; for very large directories and might avoid the
1856 ;; `Argument list too long' error.
1857 ;;
1858 ;; With and only with wildcard, we need to add
1859 ;; `-d' to prevent `ls' from descending into
1860 ;; sub-directories.
1862 "."
1867 ;; Now grab the output.
1871 ;; Check result code, found in last line of output.
1875 ;; Grab error message from line before last line
1876 ;; (it was put there by `cd 2>&1').
1879 v 'file-error
1880 "tramp-sh-handle-file-name-all-completions: %s"
1882 ;; For peace of mind, if buffer doesn't end in `fail'
1883 ;; then it should end in `ok'. If neither are in the
1884 ;; buffer something went seriously wrong on the remote
1885 ;; side.
1888 v 'file-error
1889 "\
1890 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1896 ;; Because the remote op went through OK we know the
1897 ;; directory we `cd'-ed to exists.
1900 ;; Because the remote op went through OK we know every
1901 ;; file listed by `ls' exists.
1905 result)
1907 ;; Store result in the cache.
1912 ;; cp, mv and ln
1916 "Like `add-name-to-file' for Tramp files."
1921 v 'file-error
1922 "add-name-to-file: %s"
1931 "File %s already exists; make it a new name anyway? "
1932 newname)))
1939 v1
1943 "error with add-name-to-file, see buffer `%s' for details"
1948 preserve-uid-gid preserve-extended-attributes)
1949 "Like `copy-file' for Tramp files."
1953 ;; At least one file a Tramp file?
1957 'copy filename newname ok-if-already-exists keep-date
1958 preserve-uid-gid preserve-extended-attributes))
1959 ;; Compat section.
1962 'copy-file
1964 preserve-uid-gid preserve-extended-attributes)))
1967 'copy-file
1975 "Like `copy-directory' for Tramp files."
1981 ;; When DIRNAME and NEWNAME are remote, they must have
1982 ;; the same method.
1988 ;; scp or rsync DTRT.
2002 ;; We must do it file-wise.
2004 'copy-directory
2009 ;; When newname did exist, we have wrong cached values.
2017 "Like `rename-file' for Tramp files."
2018 ;; Check if both files are local -- invoke normal rename-file.
2019 ;; Otherwise, use Tramp from local system.
2022 ;; At least one file a Tramp file?
2032 preserve-uid-gid preserve-extended-attributes)
2033 "Copy or rename a remote file.
2034 OP must be `copy' or `rename' and indicates the operation to perform.
2035 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2036 the new file (for copy) or the new name of the file (for rename).
2037 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2038 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2039 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2040 the uid and gid if both files are on the same host.
2041 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2043 This function is invoked by `tramp-sh-handle-copy-file' and
2044 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2045 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2046 file names."
2063 filename newname)
2066 ;; Both are Tramp files.
2071 ;; Shortcut: if method, host, user are the same for
2072 ;; both files, we invoke `cp' or `mv' on the remote
2073 ;; host directly.
2076 op filename newname
2077 ok-if-already-exists keep-date preserve-uid-gid))
2079 ;; Try out-of-band operation.
2084 op filename newname keep-date))
2086 ;; No shortcut was possible. So we copy the file
2087 ;; first. If the operation was `rename', we go back
2088 ;; and delete the original file (if the copy was
2089 ;; successful). The approach is simple-minded: we
2090 ;; create a new buffer, insert the contents of the
2091 ;; source file into it, then write out the buffer to
2092 ;; the target file. The advantage is that it doesn't
2093 ;; matter which file name handlers are used for the
2094 ;; source and target file.
2097 op filename newname keep-date))))))
2099 ;; One file is a Tramp file, the other one is local.
2102 ;; Fast track on local machine.
2105 op filename newname
2106 ok-if-already-exists keep-date preserve-uid-gid))
2108 ;; If the Tramp file has an out-of-band method, the
2109 ;; corresponding copy-program can be invoked.
2112 op filename newname keep-date))
2114 ;; Use the inline method via a Tramp buffer.
2116 op filename newname keep-date))))
2119 ;; One of them must be a Tramp file.
2122 ;; Handle `preserve-extended-attributes'. We ignore possible
2123 ;; errors, because ACL strings could be incompatible.
2128 ;; In case of `rename', we must flush the cache of the source file.
2134 ;; When newname did exist, we have wrong cached values.
2141 "Use an Emacs buffer to copy or rename a file.
2142 First arg OP is either `copy' or `rename' and indicates the operation.
2143 FILENAME is the source file, NEWNAME the target file.
2144 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2145 ;; We must disable multibyte, because binary data shall not be
2146 ;; converted. We don't want the target file to be compressed, so we
2147 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2148 ;; be called either. We remove `tramp-file-name-handler' from
2149 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2150 ;; `insert-file-contents' might be deactivated in some corner cases.
2161 ;; KEEP-DATE handling.
2163 ;; Set the mode.
2165 ;; If the operation was `rename', delete the original file.
2170 "Invokes `cp' or `mv' on the remote system.
2171 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2172 respectively. FILENAME specifies the file to copy or rename,
2173 NEWNAME is the name of the new file (for copy) or the new name of
2174 the file (for rename). Both files must reside on the same host.
2175 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2176 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2177 the uid and gid from FILENAME."
2187 v 'file-error
2188 "Unknown operation `%s', must be `copy' or `rename'"
2189 op))))
2193 filename))
2197 newname))
2199 cmd-result)
2202 ;; Both files are on a remote host, with same user.
2214 ;; Mask cp -f error.
2216 tramp-operation-not-permitted-regexp nil t))
2217 cmd-result)
2219 nil v 'file-error
2220 "Copying directly failed, see buffer `%s' for details."
2223 ;; We are on the local host.
2226 ;; We can do it directly.
2229 ;; No sticky bit when renaming.
2240 localname1 localname2 ok-if-already-exists
2241 keep-date preserve-uid-gid)
2245 ;; We can do it directly with `tramp-send-command'
2253 ok-if-already-exists keep-date t)
2254 ;; We must change the ownership to the local user.
2260 ;; We need a temporary file in between.
2262 ;; Create the temporary file.
2270 "%s %s %s" cmd
2273 "Copying directly failed, see buffer `%s' for details."
2275 ;; We must change the ownership as remote user.
2276 ;; Since this does not work reliable, we also
2277 ;; give read permissions.
2288 localname1 tmpfile t
2289 keep-date preserve-uid-gid)
2291 'rename-file
2293 ;; We must change the ownership as local user.
2294 ;; Since this does not work reliable, we also
2295 ;; give read permissions.
2299 tmpfile
2303 ;; Move the temporary file to its destination.
2308 "cp -f -p %s %s"
2311 "Copying directly failed, see buffer `%s' for details."
2315 'rename-file
2318 ;; Save exit.
2321 ;; Set the time and mode. Mask possible errors.
2328 "Invoke `scp' program to copy.
2329 The method used must be an out-of-band method."
2333 copy-program copy-args copy-env copy-keep-date port listener spec
2334 options source target remote-copy-program remote-copy-args)
2339 ;; Both are Tramp files. We shall optimize it when the
2340 ;; methods for FILENAME and NEWNAME are the same.
2350 op filename tmpfile keep-date)
2353 ;; Save exit.
2360 ;; Set variables for computing the prompt for reading
2361 ;; password.
2368 ;; Expand hops. Might be necessary for gateway methods.
2372 ;; Check which ones of source and target are Tramp files.
2381 'file-name-directory
2387 ;; Check for host and port number. We cannot use
2388 ;; `tramp-file-name-port', because this returns also
2389 ;; `tramp-default-port', which might clash with settings in
2390 ;; "~/.ssh/config".
2397 ;; Check for user. There might be an interactive setting.
2401 ;; Check for listener port.
2408 ;; Compose copy command.
2417 ?h host ?u user ?p port ?r listener ?c options
2423 copy-args
2425 ;; " " has either been a replacement of "%k" (when
2426 ;; keep-date argument is non-nil), or a replacement
2427 ;; for the whole keep-date sublist.
2428 " "
2433 copy-args
2437 copy-env
2439 nil
2446 remote-copy-program
2452 remote-copy-args
2456 ;; Check for local copy program.
2461 ;; Install listener on the remote side. The prompt must be
2462 ;; consumed later on, when the process does not listen anymore.
2469 v 'file-error
2473 'identity
2481 v 'file-error
2482 "Listener process not running on remote host: `%s'"
2483 remote-copy-program))
2491 ;; The default directory must be remote.
2495 ;; Set the transfer process properties.
2505 copy-args
2507 copy-args
2512 ;; Use an asynchronous process. By this, password can
2513 ;; be handled. We don't set a timeout, because the
2514 ;; copying of large files can last longer than 60
2515 ;; secs.
2519 copy-program
2521 copy-args
2530 ;; We must adapt `tramp-local-end-of-line' for
2531 ;; sending the password.
2534 p v nil tramp-actions-copy-out-of-band))
2536 ;; Check the return code.
2541 orig-vec 'file-error
2542 "Couldn't find exit status of `%s'"
2548 orig-vec 'file-error
2549 "Error copying: `%s'"
2552 ;; Reset the transfer process properties.
2555 ;; Clear the remote prompt.
2558 ;; Houston, we have a problem! Likely, the listener is
2559 ;; still running, so let's clear everything (but the
2560 ;; cached password).
2563 ;; Handle KEEP-DATE argument.
2567 ;; Set the mode.
2572 ;; If the operation was `rename', delete the original file.
2579 "Like `make-directory' for Tramp files."
2591 "Like `delete-directory' for Tramp files."
2603 "Like `delete-file' for Tramp files."
2614 ;; Dired.
2616 ;; CCC: This does not seem to be enough. Something dies when
2617 ;; we try and delete two directories under Tramp :/
2619 "Recursively delete the directory given.
2620 This is like `dired-recursive-delete-directory' for Tramp files."
2622 ;; Run a shell command 'rm -r <localname>'.
2623 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2626 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2628 v
2630 ;; Don't read the output, do it explicitly.
2631 nil t)
2632 ;; Wait for the remote system to return to us...
2633 ;; This might take a while, allow it plenty of time.
2635 ;; Make sure that it worked...
2643 "Like `dired-compress-file' for Tramp files."
2644 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2645 ;; Code stolen mainly from dired-aux.el.
2651 ;; Emacs case
2653 ;; XEmacs has `dired-compression-method-alist', which is
2654 ;; transformed into `dired-compress-file-suffixes' structure.
2658 nil
2661 suffix)
2662 ;; See if any suffix rule matches this file name.
2670 nil)
2672 ;; We found an uncompression rule.
2678 ;; `dired-remove-file' is not defined in XEmacs.
2683 ;; We don't recognize the file as compressed, so compress it.
2684 ;; Try gzip.
2689 ;; `dired-remove-file' is not defined in XEmacs.
2699 "Like `insert-directory' for Tramp files."
2706 filename switches wildcard full-directory-p)
2726 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2727 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2730 v
2733 switches
2735 localname
2738 v
2742 "Couldn't `cd %s'"
2746 v
2749 switches
2754 ""
2762 ;; We cannot use `insert-buffer-substring' because the Tramp
2763 ;; buffer changes its contents before insertion due to calling
2764 ;; `expand-file' and alike.
2769 ;; Check for "--dired" output.
2776 ;; Now read the numeric positions of file names.
2782 ;; End is followed by \n or by " -> ".
2784 ;; Remove trailing lines.
2790 ;; Some busyboxes are reluctant to discard colors.
2797 ;; Decode the output, it could be multibyte.
2804 ;; The inserted file could be from somewhere else.
2811 "."
2818 ;; Canonicalization of file names.
2821 "Like `expand-file-name' for Tramp files.
2823 the result will be a local, non-Tramp, file name."
2824 ;; If DIR is not given, use `default-directory' or "/".
2826 ;; Unless NAME is absolute, concat DIR and NAME.
2829 ;; If NAME is not a Tramp file, run the real handler.
2832 ;; Dissect NAME.
2836 ;; Tilde expansion if necessary. This needs a shell which
2837 ;; groks tilde expansion! The function `tramp-find-shell' is
2838 ;; supposed to find such a shell on the remote host. Please
2839 ;; tell me about it when this doesn't work on your system.
2843 ;; We cannot simply apply "~/", because under sudo "~/" is
2844 ;; expanded to the local user home directory but to the
2845 ;; root home directory. On the other hand, using always
2846 ;; the default user name for tilde expansion is not
2847 ;; appropriate either, because ssh and companions might
2848 ;; use a user name from the config file.
2860 ;; There might be a double slash, for example when "~/"
2861 ;; expands to "/". Remove this.
2864 ;; No tilde characters in file name, do normal
2865 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2866 ;; `directory-sep-char' here for XEmacs on Windows, which would
2867 ;; otherwise use backslash. `default-directory' is bound,
2868 ;; because on Windows there would be problems with UNC shares or
2869 ;; Cygwin mounts.
2873 method user host
2877 hop)))))
2879 ;;; Remote commands:
2882 "Flush file caches."
2890 ;; We use BUFFER also as connection buffer during setup. Because of
2891 ;; this, its original contents must be saved, and restored once
2892 ;; connection has been setup.
2894 "Like `start-file-process' for Tramp files."
2897 ;; it might be that the arguments exceed the command line
2898 ;; length. Therefore, we modify the command.
2903 ;; When PROGRAM is nil, we just provide a tty.
2909 args
2913 ;; Use a human-friendly prompt, for example for `shell'.
2914 ;; We discard hops, if existing, that's why we cannot use
2915 ;; `file-remote-p'.
2922 tramp-initial-end-of-output))
2923 ;; We use as environment the difference to toplevel
2924 ;; `process-environment'.
2925 env
2930 env)
2949 ;; We do not want to raise an error when
2950 ;; `start-file-process' has been started several times in
2951 ;; `eshell' and friends.
2955 ;; BUFFER can be nil. We use a temporary buffer.
2958 ;; NAME must be unique as process name.
2962 ;; Set the new process properties.
2968 ;; We catch this event. Otherwise, `start-process' could
2969 ;; be called on the local host.
2972 ;; Activate narrowing in order to save BUFFER
2973 ;; contents. Clear also the modification time;
2974 ;; otherwise we might be interrupted by
2975 ;; `verify-visited-file-modtime'.
2981 ;; We call `tramp-maybe-open-connection', in order
2982 ;; to cleanup the prompt afterwards.
2988 ;; Now do it.
2990 ;; Send the command.
2992 ;; Check, whether a pty is associated.
2996 v 'file-error
2999 ;; Set query flag and process marker for this
3000 ;; process. We ignore errors, because the process
3001 ;; could have finished already.
3005 ;; Return process.
3006 p))))
3008 ;; Save exit.
3019 "Like `process-file' for Tramp files."
3020 ;; The implementation is not complete yet.
3026 ;; Compute command.
3029 ;; We use as environment the difference to toplevel `process-environment'.
3037 "env %s %s"
3039 ;; Determine input.
3044 ;; INFILE is on the same remote host.
3046 ;; INFILE must be copied to remote host.
3052 ;; Determine output.
3054 ;; Just a buffer.
3057 ;; A buffer name.
3060 ;; (REAL-DESTINATION ERROR-DESTINATION)
3062 ;; output.
3070 ;; stderr.
3075 ;; stderr is on the same remote host.
3078 ;; stderr must be copied to remote host. The temporary
3079 ;; file must be deleted after execution.
3082 method user host stderr))))
3083 ;; stderr to be discarded.
3086 ;; 't
3091 ;; Send the command. It might not return in time, so we protect
3092 ;; it. Call it in a subshell, in order to preserve working
3093 ;; directory.
3100 command)
3101 t t)
3103 ;; We should add the output anyway.
3110 ;; When the user did interrupt, we should do it also. We use
3111 ;; return code -1 as marker.
3115 ;; Handle errors.
3120 ;; Provide error file.
3123 ;; Cleanup. We remove all file cache values for the connection,
3124 ;; because the remote process could have changed them.
3127 ;; `process-file-side-effects' has been introduced with GNU
3128 ;; Emacs 23.2. If set to nil, no remote file will be changed
3129 ;; by `program'. If it doesn't exist, we assume its default
3130 ;; value t.
3135 ;; Return exit status.
3138 ret))))
3141 "Like `file-local-copy' for Tramp files."
3145 v 'file-error
3155 ;; `copy-file' handles direct copy and out-of-band methods.
3160 ;; Use inline encoding for file transfer.
3164 v 3
3172 tmpfile loc-dec)
3174 ;; If local decoding is a function, we call it.
3175 ;; We must disable multibyte, because
3176 ;; `uudecode-decode-region' doesn't handle it
3177 ;; correctly. Unset `file-name-handler-alist'.
3178 ;; Otherwise, epa-file gets confused.
3186 ;; If tramp-decoding-function is not defined for this
3187 ;; method, we invoke tramp-decoding-command instead.
3189 ;; Unset `file-name-handler-alist'. Otherwise,
3190 ;; epa-file gets confused.
3198 loc-dec tmpfile2 tmpfile)
3201 ;; Set proper permissions.
3203 ;; Set local user ownership.
3206 ;; Oops, I don't know what to do.
3210 ;; Error handling.
3216 tmpfile)))
3218 ;; This is needed for XEmacs only. Code stolen from files.el.
3221 "Like `insert-file-contents-literally' for Tramp files."
3229 nil))
3237 ;; Save exit.
3242 ;; CCC grok LOCKNAME
3245 "Like `write-region' for Tramp files."
3248 ;; Following part commented out because we don't know what to do about
3249 ;; file locking, and it does not appear to be a problem to ignore it.
3250 ;; Ange-ftp ignores it, too.
3251 ;; (when (and lockname (stringp lockname))
3252 ;; (setq lockname (expand-file-name lockname)))
3253 ;; (unless (or (eq lockname nil)
3254 ;; (string= lockname filename))
3255 ;; (error
3256 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3258 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3269 ;; `file-writable-p' calls `file-expand-file-name'. We
3270 ;; cannot use `tramp-run-real-handler' therefore.
3276 ;; Short track: if we are on the local host, we can run directly.
3278 'write-region
3282 ;; We use this to save the value of
3283 ;; `last-coding-system-used' after writing the tmp
3284 ;; file. At the end of the function, we set
3285 ;; `last-coding-system-used' to this saved value. This
3286 ;; way, any intermediary coding systems used while
3287 ;; talking to the remote shell or suchlike won't hose
3288 ;; this variable. This approach was snarfed from
3289 ;; ange-ftp.el.
3290 coding-system-used
3291 ;; Write region into a tmp file. This isn't really
3292 ;; needed if we use an encoding function, but currently
3293 ;; we use it always because this makes the logic
3294 ;; simpler. We must also set `temporary-file-directory',
3295 ;; because it could point to a remote directory.
3301 ;; If `append' is non-nil, we copy the file locally, and let
3302 ;; the native `write-region' implementation do the job.
3305 ;; We say `no-message' here because we don't want the
3306 ;; visited file modtime data to be clobbered from the temp
3307 ;; file. We call `set-visited-file-modtime' ourselves later
3308 ;; on. We must ensure that `file-coding-system-alist'
3309 ;; matches `tmpfile'.
3315 'write-region
3322 ;; Now, `last-coding-system-used' has the right value. Remember it.
3327 ;; The permissions of the temporary file should be set. If
3328 ;; FILENAME does not exist (eq modes nil) it has been
3329 ;; renamed to the backup file. This case `save-buffer'
3330 ;; handles permissions.
3331 ;; Ensure that it is still readable.
3334 tmpfile
3337 ;; This is a bit lengthy due to the different methods
3338 ;; possible for file transfer. First, we check whether the
3339 ;; method uses an scp program. If so, we call it.
3340 ;; Otherwise, both encoding and decoding command must be
3341 ;; specified. However, if the method _also_ specifies an
3342 ;; encoding function, then that is used for encoding the
3343 ;; contents of the tmp file.
3348 ;; `copy-file' handles direct copy and out-of-band methods.
3358 ;; We keep the local file for performance
3359 ;; reasons, useful for "rsync".
3366 ;; Don't rename, in order to keep context in SELinux.
3371 ;; Use inline file transfer.
3373 ;; Encode tmpfile.
3377 ;; Use encoding function or command.
3380 tmpfile loc-enc)
3382 ;; The following `let' is a workaround for
3383 ;; the base64.el that comes with pgnus-0.84.
3384 ;; If both of the following conditions are
3385 ;; satisfied, it tries to write to a local
3386 ;; file in default-directory, but at this
3387 ;; point, default-directory is remote.
3388 ;; (`call-process-region' can't write to
3389 ;; remote files, it seems.) The file in
3390 ;; question is a tmp file anyway.
3398 loc-enc tmpfile t))
3400 v 'file-error
3403 filename loc-enc))))
3405 ;; Send buffer into remote decoding command which
3406 ;; writes to remote file. Because this happens on
3407 ;; the remote host, we cannot use the function.
3410 filename rem-dec)
3414 v
3418 tramp-end-of-heredoc
3420 tramp-end-of-heredoc))
3422 v nil
3423 "Couldn't write region to `%s', decode using `%s' failed"
3424 filename rem-dec)
3425 ;; When `file-precious-flag' is set, the region is
3426 ;; written to a temporary file. Check that the
3427 ;; checksum is equal to that from the local tmpfile.
3431 ;; cksum runs locally, if possible.
3433 ;; cksum runs remotely.
3435 v
3438 ;; ... they are different.
3445 v 'file-error
3448 filename rem-dec)))))
3450 ;; Save exit.
3453 ;; That's not expected.
3456 v 'file-error
3459 method))))
3461 ;; Make `last-coding-system-used' have the right value.
3468 ;; We must protect `last-coding-system-used', now we have set it
3469 ;; to its correct value.
3471 ;; Set file modification time.
3475 ;; We must pass modtime explicitly, because FILENAME can
3476 ;; be different from (buffer-file-name), f.e. if
3477 ;; `file-precious-flag' is set.
3483 ;; Set the ownership.
3493 ;; VC backends check for the existence of various different special
3494 ;; files. This is very time consuming, because every single check
3495 ;; requires a remote command (the file cache must be invalidated).
3496 ;; Therefore, we apply a kind of optimization. We install the file
3497 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3498 ;; remembers all file names for which `file-exists-p' or
3499 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3500 ;; is performed. Afterwards, a script is applied for all collected
3501 ;; file names, using just one remote command. The result of this
3502 ;; script is used to fill the file cache with actual values. Now we
3503 ;; can reset the file name handlers, and we make a second run of
3504 ;; `vc-registered', which returns the expected result without sending
3505 ;; any other remote command.
3507 "Like `vc-registered' for Tramp files."
3513 ;; There could be new files, created by the vc backend. We
3514 ;; cannot reuse the old cache entries, therefore. In
3515 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3516 ;; could also be a timestamp as `current-time' returns. This
3517 ;; means invalidate all cache entries with an older timestamp.
3523 ;; Here we collect only file names, which need an operation.
3527 ;; Send just one command, in order to fill the cache.
3530 v
3539 ;; We cannot use `tramp-send-command-and-read',
3540 ;; because this does not cooperate well with
3541 ;; heredoc documents.
3543 v
3546 tramp-end-of-heredoc
3548 tramp-vc-registered-file-names
3550 tramp-end-of-heredoc))
3552 ;; Read the expression.
3559 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3560 ;; calls shall be answered from the file cache. We unset
3561 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3562 ;; in order to keep the cache.
3564 remote-file-name-inhibit-cache process-file-side-effects)
3565 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3584 ;; Run.
3588 ;;;###tramp-autoload
3590 "Invoke remote-shell Tramp file name handler.
3591 Fall back to normal file name handler if no Tramp handler exists."
3609 "Invoke special file name handler, which collects files to be handled."
3617 ;; That's what we want: file names, for which checks are
3618 ;; applied. We assume that VC uses only `file-exists-p' and
3619 ;; `file-readable-p' checks; otherwise we must extend the
3620 ;; list. We do not perform any action, but return nil, in
3621 ;; order to keep `vc-registered' running.
3624 nil)
3625 ;; `process-file' and `start-file-process' shall be ignored.
3628 ;; Tramp file name handlers like `expand-file-name'. They
3629 ;; must still work.
3631 ;; Default file name handlers, we don't care.
3635 "Like `file-notify-add-watch' for Tramp files."
3639 command events filter p sequence)
3641 ;; gvfs-monitor-dir.
3645 ;; inotifywait.
3648 events
3655 ;; None.
3657 v 'file-notify-error
3658 "No file notification program found on %s"
3660 ;; Start process.
3662 'start-file-process
3666 sequence))
3667 ;; Return the process object as watch-descriptor.
3670 v 'file-notify-error
3671 "`%s' failed to start on remote host"
3677 p))))
3689 ;; Attribute change is returned in unused wording.
3699 string)
3702 proc
3706 ;; File names are returned as absolute paths. We must
3707 ;; add the remote prefix.
3712 ;; Usually, we would add an Emacs event now. Unfortunately,
3713 ;; `unread-command-events' does not accept several events at
3714 ;; once. Therefore, we apply the callback directly.
3717 ;; Save rest of the string.
3726 ;; Check, whether there is a problem.
3732 line)
3737 proc
3744 ;; Usually, we would add an Emacs event now. Unfortunately,
3745 ;; `unread-command-events' does not accept several events at
3746 ;; once. Therefore, we apply the callback directly.
3749 ;;; Internal Functions:
3752 "Define in remote shell function NAME implemented as SCRIPT.
3753 Only send the definition if it has not already been done."
3754 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3755 ;; might be nil.
3760 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3761 ;; could result in unwanted command expansion. Avoid this.
3764 ;; The script could contain a call of Perl. This is masked with `%s'.
3769 vec
3777 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3778 Returns the exit code of the `test' program."
3781 v
3783 "%s %s %s"
3785 switch
3789 "Run `test'-like program on the remote system, given FILE1, FILE2.
3790 FORMAT-STRING contains the program name, switches, and place holders.
3791 Returns the exit code of the `test' program. Barfs if the methods,
3792 hosts, or files, disagree."
3796 v 'file-error
3801 v1
3808 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3809 First arg VEC specifies the connection, PROGNAME is the program
3810 to search for, and DIRLIST gives the list of directories to
3811 search. If IGNORE-TILDE is non-nil, directory names starting
3812 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3813 only in DIRLIST.
3815 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3817 This function expects to be in the right *tramp* buffer."
3820 ;; Check whether the executable is in $PATH. "which(1)" does not
3821 ;; report always a correct error code; therefore we check the
3822 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3823 ;; 5.11") have problems with this command, we disable the call
3824 ;; therefore.
3835 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3836 ;; `remove' is in CL, and we want to avoid CL dependencies.
3845 vec
3847 "do if test -x $d/%s && test -f $d/%s; "
3848 "then echo tramp_executable $d/%s; "
3851 progname progname progname
3852 tramp-end-of-heredoc
3854 tramp-end-of-heredoc))
3860 result)))
3863 "Sets the remote environment PATH to existing directories.
3864 I.e., for each directory in `tramp-remote-path', it is tested
3865 whether it exists and if so, it is added to the environment
3866 variable PATH."
3872 ;; ------------------------------------------------------------
3873 ;; -- Communication with external shell --
3874 ;; ------------------------------------------------------------
3877 "Find a command on the remote host for checking if a file exists.
3878 Here, we are looking for a command which has zero exit status if the
3879 file exists and nonzero exit status otherwise."
3883 result)
3884 ;; The algorithm is as follows: we try a list of several commands.
3885 ;; For each command, we first run `$cmd /' -- this should return
3886 ;; true, as the root directory always exists. And then we run
3887 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3888 ;; does not exist. This should return false. We use the first
3889 ;; command we find that seems to work.
3890 ;; The list of commands to try is as follows:
3891 ;; `ls -d' This works on most systems, but NetBSD 1.4
3892 ;; has a bug: `ls' always returns zero exit
3893 ;; status, even for files which don't exist.
3894 ;; `test -e' Some Bourne shells have a `test' builtin
3895 ;; which does not know the `-e' option.
3896 ;; `/bin/test -e' For those, the `test' binary on disk normally
3897 ;; provides the option. Alas, the binary
3898 ;; is sometimes `/bin/test' and sometimes it's
3899 ;; `/usr/bin/test'.
3900 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3928 result))
3931 "Opens shell SHELL."
3934 ;; Find arguments for this shell.
3936 item extra-args)
3941 ;; It is useful to set the prompt in the following command
3942 ;; because some people have a setting for $PS1 which /bin/sh
3943 ;; doesn't know about and thus /bin/sh will display a strange
3944 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3945 ;; ksh will display the current working directory but /bin/sh
3946 ;; will display a dollar sign. The following command line sets
3947 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3948 ;; well as csh-like shells. We also unset the variable $ENV
3949 ;; because that is read by some sh implementations (eg, bash
3950 ;; when called as sh) on startup; this way, we avoid the startup
3951 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3952 ;; the prompt in /bin/bash, it must be discarded as well.
3953 ;; $HISTFILE is set according to `tramp-histfile-override'.
3956 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3961 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3965 t))
3970 "Opens a shell on the remote host which groks tilde expansion."
3973 shell)
3976 ;; CCC: "root" does not exist always, see QNAP 459.
3977 ;; Which check could we apply instead?
3980 ;; The default shell (ksh93) of OpenSolaris and
3981 ;; Solaris is buggy. We've got reports for
3982 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3991 ;; Maybe it works at least for some other commands.
3993 default-shell
3995 vec 2
3997 "Couldn't find a remote shell which groks tilde "
3999 default-shell)))
4001 default-shell)))
4003 ;; Open a new shell if needed.
4009 ;; Utility functions.
4012 "Wait for shell prompt and barf if none appears.
4013 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4014 seconds. If not, it produces an error message with the given ERROR-ARGS."
4018 proc timeout
4027 "Set up an interactive shell.
4028 Mainly sets the prompt and the echo correctly. PROC is the shell
4029 process to set up. VEC specifies the connection."
4033 ;; Disable tab and echo expansion.
4036 ;; Check whether the echo has really been disabled. Some
4037 ;; implementations, like busybox of embedded GNU/Linux, don't
4038 ;; support disabling.
4045 ;; Make sure backspaces and their echo are enabled and no line
4046 ;; width magic interferes with them.
4054 ;; Try to set up the coding system correctly.
4055 ;; CCC this can't be the right way to do it. Hm.
4059 ;; Use MULE to select the right EOL convention for communicating
4060 ;; with the process.
4066 cs-decode cs-encode)
4083 ;; Look for ^M and do something useful if found.
4085 ;; We have found a ^M but cannot frob the process coding system
4086 ;; because we're running on a non-MULE Emacs. Let's try
4087 ;; stty, instead.
4092 ;; Check whether the output of "uname -sr" has been changed. If
4093 ;; yes, this is a strong indication that we must expire all
4094 ;; connection properties. We start again with
4095 ;; `tramp-maybe-open-connection', it will be caught there.
4100 vec "uname"
4104 vec 3
4105 "Connection reset, because remote host changed from `%s' to `%s'"
4106 old-uname new-uname)
4107 ;; We want to keep the password.
4111 ;; Check whether the remote host suffers from buggy
4112 ;; `send-process-string'. This is known for FreeBSD (see comment in
4113 ;; `send_process', file process.c). I've tested sending 624 bytes
4114 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4115 ;; this host type is detected locally. It cannot handle remote
4116 ;; hosts, though.
4120 tramp-chunksize)
4128 ;; Set remote PATH variable.
4131 ;; Search for a good shell before searching for a command which
4132 ;; checks if a file exists. This is done because Tramp wants to use
4133 ;; "test foo; echo $?" to check if various conditions hold, and
4134 ;; there are buggy /bin/sh implementations which don't execute the
4135 ;; "echo $?" part if the "test" part has an error. In particular,
4136 ;; the OpenSolaris /bin/sh is a problem. There are also other
4137 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4138 ;; in function declarations, or changing HISTFILE in place.
4139 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4140 ;; detected.
4143 ;; Disable unexpected output.
4146 ;; IRIX64 bash expands "!" even when in single quotes. This
4147 ;; destroys our shell functions, we must disable it. See
4148 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4152 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4157 ;; Set `remote-tty' process property.
4162 ;; Dump stty settings in the traces.
4166 ;; Set the environment.
4171 unset vars item)
4181 vec
4183 tramp-end-of-heredoc
4185 tramp-end-of-heredoc)
4186 t))
4191 ;; Old text from documentation of tramp-methods:
4192 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4193 ;; of the base64 methods instead since base64 encoding is much more
4194 ;; reliable and the commands are more standardized between the different
4195 ;; Unix versions. But if you can't use base64 for some reason, please
4196 ;; note that the default uudecode command does not work well for some
4197 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4198 ;; the following command for uudecode:
4199 ;;
4200 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4201 ;;
4202 ;; For Irix, no solution is known yet.
4210 "List of local coding commands for inline transfer.
4211 Each item is a list that looks like this:
4213 \(FORMAT ENCODING DECODING\)
4215 FORMAT is symbol describing the encoding/decoding format. It can be
4216 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4218 ENCODING and DECODING can be strings, giving commands, or symbols,
4219 giving functions. If they are strings, then they can contain
4221 file name will be put into the command line at that spot. If the
4222 specifier is not present, the input should be read from standard
4223 input.
4225 If they are functions, they will be called with two arguments, start
4226 and end of region, and are expected to replace the region contents
4231 ;; "-i" is more robust with older base64 from GNU coreutils.
4232 ;; However, I don't know whether all base64 versions do supports
4233 ;; this option.
4245 "List of remote coding commands for inline transfer.
4246 Each item is a list that looks like this:
4248 \(FORMAT ENCODING DECODING [TEST]\)
4250 FORMAT is a symbol describing the encoding/decoding format. It can be
4251 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4253 ENCODING and DECODING can be strings, giving commands, or symbols,
4254 giving variables. If they are strings, then they can contain
4256 file name will be put into the command line at that spot. If the
4257 specifier is not present, the input should be read from standard
4258 input.
4260 If they are variables, this variable is a string containing a
4261 Perl or Shell implementation for this functionality. This
4262 program will be transferred to the remote host, and it is
4264 specifier in the variable value denotes a temporary file.
4266 The optional TEST command can be used for further tests, whether
4270 "Find an inline transfer encoding that works.
4271 Goes through the list `tramp-local-coding-commands' and
4272 `tramp-remote-coding-commands'."
4277 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4285 ;; If the local encoder or decoder is a string, the
4286 ;; corresponding command has to work locally.
4293 loc-enc nil nil))
4301 loc-dec nil nil))
4303 ;; Search for remote coding commands with the same format
4311 ;; Check the remote test command if exists.
4317 ;; Check if remote perl exists when necessary.
4321 ;; Check if remote encoding and decoding commands can be
4322 ;; called remotely with null input and output. This makes
4323 ;; sure there are no syntax errors and the command is really
4324 ;; found. Note that we do not redirect stdout to /dev/null,
4325 ;; for two reasons: when checking the decoding command, we
4326 ;; actually check the output it gives. And also, when
4327 ;; redirecting "mimencode" output to /dev/null, then as root
4328 ;; it might change the permissions of /dev/null!
4336 vec 5
4345 tmpfile)
4352 tramp-temp-name-prefix
4354 value
4356 value
4358 ?t
4364 vec 5
4367 vec
4369 t)
4377 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4383 ;; Set connection properties. Since the commands are risky
4384 ;; (due to output direction), we cache them in the process cache.
4395 "Call the local encoding or decoding command.
4397 Otherwise, INPUT is passed via standard input.
4398 INPUT can also be nil which means `/dev/null'.
4399 OUTPUT can be a string (which specifies a file name), or t (which
4400 means standard output and thus the current buffer), or nil (which
4401 means discard it)."
4403 nil tramp-encoding-shell
4406 nil
4407 tramp-encoding-command-switch
4417 "List of compress and decompress commands for inline transfer.
4418 Each item is a list that looks like this:
4420 \(COMPRESS DECOMPRESS\)
4425 "Find an inline transfer compress command that works.
4426 Goes through the list `tramp-inline-compress-commands'."
4431 item compress decompress found)
4438 vec 5
4439 "Checking local compress commands `%s', `%s' for sanity"
4440 compress decompress)
4445 ;; Windows shells need the program file name after
4446 ;; the pipe symbol be quoted if they use forward
4447 ;; slashes as directory separators.
4454 vec 5
4455 "Checking remote compress commands `%s', `%s' for sanity"
4456 compress decompress)
4462 ;; Did we find something?
4465 ;; Set connection properties. Since the commands are
4466 ;; risky (due to output direction), we cache them in the
4467 ;; process cache.
4481 "Expands VEC according to `tramp-default-proxies-alist'.
4482 Gateway hops are already opened."
4486 choices proxy)
4488 ;; Ad-hoc proxy definitions.
4493 tramp-prefix-format proxy tramp-postfix-host-format)))
4498 proxy)
4499 ;; Add the hop.
4501 'tramp-default-proxies-alist
4504 proxy))
4506 ;; Save the new value.
4511 ;; Look for proxy hosts to be passed.
4517 ;; Host.
4520 ;; User.
4524 ;; No more hops needed.
4526 ;; Replace placeholders.
4529 proxy
4534 ;; Add the hop.
4536 ;; Start next search.
4539 ;; Handle gateways.
4547 ;; Is the method prepared for gateways?
4550 vec 'file-error
4552 ;; Open the gateway connection.
4557 target-alist)
4558 ;; For the password prompt, we need the correct values.
4559 ;; Therefore, we must remember the gateway vector. But we
4560 ;; cannot do it as connection property, because it shouldn't
4561 ;; be persistent. And we have no started process yet either.
4565 ;; Foreign and out-of-band methods are not supported for multi-hops.
4572 vec 'file-error
4573 "Method `%s' is not supported for multi-hops."
4576 ;; In case the host name is not used for the remote shell
4577 ;; command, the user could be misguided by applying a random
4578 ;; host name.
4584 ;; There are multi-hops.
4586 ;; The host name is used for the remote shell command.
4588 ;; The host is local. We cannot use `tramp-local-host-p'
4589 ;; here, because it opens a connection as well.
4592 v 'file-error
4593 "Host `%s' looks like a remote host, `%s' can only use the local host"
4594 host method)))
4596 ;; Result.
4597 target-alist))
4600 "Return the Control* arguments of the local ssh."
4602 ;; No options to be computed.
4607 ;; There is already a value to be used.
4610 ;; Determine the options.
4622 ;; We use a non-existing IP address, in order to avoid
4623 ;; useless connections, and DNS timeouts.
4630 " -o ControlPath='tramp.%%r@%%h:%%p'"
4639 tramp-ssh-controlmaster-options)))
4642 "Maybe open a connection VEC.
4643 Does not do anything if a connection is already open, but re-opens the
4644 connection if a previous connection has died for some reason."
4652 ;; If Tramp opens the same connection within a short time frame,
4653 ;; there is a problem. We shall signal this.
4662 ;; If too much time has passed since last command was sent, look
4663 ;; whether process is still alive. If it isn't, kill it. When
4664 ;; using ssh, it can sometimes happen that the remote end has hung
4665 ;; up but the local ssh client doesn't recognize this until it
4666 ;; tries to send some data to the remote end. So that's why we
4667 ;; try to send a command from time to time, then look again
4668 ;; whether the process is really alive.
4679 ;; The error will be caught locally.
4685 ;; New connection must be opened.
4689 ;; If `non-essential' is non-nil, don't reopen a new connection.
4694 vec 3
4705 ;; Start new process.
4720 ;; We will apply `tramp-ssh-controlmaster-options'
4721 ;; only for the first hop.
4726 ;; This must be done in order to avoid our file
4727 ;; name handler.
4731 'start-process
4736 tramp-encoding-command-interactive)
4739 ;; Set sentinel and query flag.
4750 ;; Check whether process is alive.
4752 p 10
4755 ;; Now do all the connections as specified.
4781 ;; We don't create the temporary file. In
4782 ;; fact, it is just a prefix for the
4783 ;; ControlPath option of ssh; the real
4784 ;; temporary file has another name, and it is
4785 ;; created and protected by ssh. It is also
4786 ;; removed by ssh when the connection is
4787 ;; closed. The temporary file name is cached
4788 ;; in the main connection process, therefore
4789 ;; we cannot use `tramp-get-connection-process'.
4795 tramp-temp-name-prefix
4797 spec r-shell)
4799 ;; Add arguments for asynchronous processes.
4803 ;; Add gateway arguments if necessary.
4809 ;; Check for port number. Until now, there's no
4810 ;; need for handling like method, user, host.
4815 ;; Check, whether there is a restricted shell.
4820 ;; Set variables for computing the prompt for
4821 ;; reading password. They can also be derived
4822 ;; from a gateway.
4827 ;; Add login environment.
4830 login-env
4835 login-env))
4839 "%s=%s %s"
4842 command)))
4845 ;; Replace `login-args' place holders.
4853 ?h l-host ?u l-user ?p l-port ?c options)
4854 command
4856 ;; We do not want to see the trailing local
4857 ;; prompt in `start-file-process'.
4859 command " "
4865 ;; Local shell could be a Windows COMSPEC. It
4866 ;; doesn't know the ";" syntax, but we must exit
4867 ;; always for `start-file-process'. It could
4868 ;; also be a restricted shell, which does not
4869 ;; allow "exec".
4872 ;; Send the command.
4876 p vec pos tramp-actions-before-shell
4880 ;; Next hop.
4884 ;; Make initial shell settings.
4887 ;; When the user did interrupt, we must cleanup.
4890 ;; Propagate the quit signal.
4894 "Send the COMMAND to connection VEC.
4895 Erases temporary buffer before sending the command. If optional
4896 arg NEVEROPEN is non-nil, never try to open the connection. This
4897 is meant to be used from `tramp-maybe-open-connection' only. The
4898 function waits for output unless NOOUTPUT is set."
4902 ;; We mark the command string that it can be erased in the output buffer.
4904 ;; If we put `tramp-echo-mark' after a trailing newline (which
4905 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4906 ;; that newline and adds `tramp-rsh-end-of-line' right after
4907 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4908 ;; trailing line endings and sends two prompts after executing
4909 ;; the command, which confuses `tramp-wait-for-output'.
4913 ;; No need to restore a trailing newline here since `tramp-send-string'
4914 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4916 ;; Send the command.
4922 "Wait for output from remote command."
4928 ;; be leading escape sequences, which must be ignored.
4930 ;; Sometimes, the commands do not return a newline but a
4931 ;; null byte before the shell prompt, for example "git
4932 ;; ls-files -c -z ...".
4937 ;; A simple-minded busybox has sent " ^H" sequences.
4938 ;; Delete them.
4943 ;; Delete the prompt.
4949 proc 'file-error
4950 "[[Remote prompt `%s' not found in %d secs]]"
4951 tramp-end-of-output timeout)
4953 proc 'file-error
4955 ;; Return value is whether end-of-output sentinel was found.
4956 found)))
4960 "Run COMMAND and check its exit status.
4961 Sends `echo $?' along with the COMMAND for checking the exit status.
4962 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4963 status is 0, and nil otherwise.
4965 If the optional argument SUBSHELL is non-nil, the command is
4966 executed in a subshell, ie surrounded by parentheses. If
4967 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4969 vec
4971 command
4973 "echo tramp_exit_status $?"
4987 "Run COMMAND, check exit status, throw error if exit status not okay.
4988 Similar to `tramp-send-command-and-check' but accepts two more arguments
4989 FMT and ARGS which are passed to `error'."
4994 "Run COMMAND and return the output, which must be a Lisp expression.
4995 If MARKER is a regexp, read the output after that string.
4996 In case there is no valid Lisp expression and NOERROR is nil, it
4997 raises an error."
5004 ;; Read the marker.
5010 vec 'file-error
5011 "`%s' does not return the marker `%s': `%s'"
5013 ;; Read the expression.
5016 ;; Error handling.
5021 vec 'file-error
5022 "`%s' does not return a valid Lisp expression: `%s'"
5026 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5027 Convert file mode bits to string and set virtual device number.
5028 Return ATTR."
5030 ;; Remove color escape sequences from symlink.
5034 ;; Convert uid and gid. Use -1 as indication of unusable value.
5045 ;; Convert last access time.
5050 ;; Convert last modification time.
5055 ;; Convert last status change time.
5060 ;; Convert file size.
5066 ;; Convert file mode bits to string.
5071 ;; Convert directory indication bit.
5074 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5080 ;; Set file's gid change bit.
5088 ;; Convert inode.
5094 ;; Inodes can be incredible huge. We must hide this.
5096 ;; Set virtual device number.
5099 attr))
5102 "Converts STRING to shell glob pattern which ignores case."
5108 string
5112 "Create a file name suitable for `scp', `pscp', or `nc' and workalikes."
5123 localname)
5129 "Return t if this is an out-of-band method, nil otherwise."
5131 ;; It shall be an out-of-band method.
5133 ;; There must be a size, otherwise the file doesn't exist.
5135 ;; Either the file size is large enough, or (in rare cases) there
5136 ;; does not exist a remote encoding.
5141 ;; Variables local to connection.
5145 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5146 ;; cache the result for the session only. Otherwise, the result
5147 ;; is cached persistently.
5150 vec)
5151 "remote-path"
5160 ;; Default if "getconf" is not available.
5163 vec 3
5168 ;; The login shell could return more than just the $PATH
5169 ;; string. So we use `tramp-end-of-heredoc' as marker.
5172 vec
5177 'identity
5181 'identity
5187 ;; Replace place holder `tramp-default-remote-path'.
5195 ;; Replace place holder `tramp-own-remote-path'.
5203 ;; Remove double entries.
5210 ;; Remove non-existing directories.
5212 nil
5222 x))
5223 x))
5224 remote-path)))))
5230 locale)
5237 candidates nil)
5239 ;; Return value.
5249 result)
5251 ;; Check parameters. On busybox, "ls" output coloring is
5252 ;; enabled by default sometimes. So we try to disable it
5253 ;; when possible. $LS_COLORING is not supported there.
5254 ;; Some "ls" versions are sensible wrt the order of
5255 ;; arguments, they fail when "-al" is after the
5256 ;; "--color=never" argument (for example on FreeBSD).
5271 ;; Some "ls" versions are sensible wrt the order of arguments,
5272 ;; they fail when "-al" is after the "--dired" argument (for
5273 ;; example on FreeBSD).
5281 ;; Some "ls" versions are sensible wrt the order of arguments,
5282 ;; they fail when "-al" is after the "--dired" argument (for
5283 ;; example on FreeBSD).
5292 "test"
5296 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5297 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5298 ;; for otherwise the shell crashes.
5310 vec
5333 ;; We must check also for some Perl modules.
5341 result)))
5348 tmp)
5349 ;; Check whether stat(1) returns usable syntax. "%s" does not
5350 ;; work on older AIX systems.
5359 result)))
5369 result))))
5385 ;; Busyboxes do support the "-t" option only when they have been
5386 ;; built with the DESKTOP config option. Let's check it.
5389 vec "touch-t"
5391 vec
5393 "%s -t %s %s"
5394 result
5398 result)))
5417 result)
5419 ;; Check POSIX parameter.
5426 vec
5435 vec
5439 "print $>"
5451 vec
5455 "import os; print (os.getuid())"
5469 ;; Ensure there is a valid result.
5477 vec
5486 vec
5495 vec
5499 "import os; print (os.getgid())"
5513 ;; Ensure there is a valid result.
5519 ;; Some predefined connection properties.
5521 "Return the compress command related to PROP.
5522 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5523 the length of the file to be compressed.
5525 If no corresponding command is found, nil is returned."
5534 "Return the coding command related to PROP.
5535 PROP is either `remote-encoding', `remote-decoding',
5536 `local-encoding' or `local-decoding'.
5538 SIZE is the length of the file to be coded. Depending on SIZE,
5539 compression might be applied.
5541 If no corresponding command is found, nil is returned.
5542 Otherwise, either a string is returned which contains a `%s' mark
5543 to be used for the respective input or output file; or a Lisp
5544 function cell is returned to be applied on a buffer."
5545 ;; We must catch the errors, because we want to return nil, when
5546 ;; no inline coding is found.
5556 compress)
5557 ;; The connection property might have been cached. So we must
5558 ;; send the script to the remote side - maybe.
5566 ;; Check for the `compress' command.
5568 ;; Return the value.
5593 coding)
5596 ;; Windows shells need the program file name after
5597 ;; the pipe symbol be quoted if they use forward
5598 ;; slashes as directory separators.
5605 coding compress))
5608 ;; Windows shells need the program file name after
5609 ;; the pipe symbol be quoted if they use forward
5610 ;; slashes as directory separators.
5615 compress coding))
5629 ;;; TODO:
5631 ;; * Don't use globbing for directories with many files, as this is
5632 ;; likely to produce long command lines, and some shells choke on
5633 ;; long command lines.
5634 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5635 ;; then look if it's the right version (with `perl -v').
5636 ;; * When editing a remote CVS controlled file as a different user, VC
5637 ;; gets confused about the file locking status. Try to find out why
5638 ;; the workaround doesn't work.
5639 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5640 ;; until the last but one hop via `start-file-process'. Apply it
5641 ;; also for ftp and smb.
5642 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5643 ;; some shell with root privileges, it would be nice if I could
5644 ;; just call
5645 ;; trampclient filename.c
5646 ;; as an editor, and the _current_ shell would connect to an Emacs
5647 ;; server and would be used in an existing non-privileged Emacs
5648 ;; session for doing the editing in question.
5649 ;; That way, I need not tell Emacs my password again and be afraid
5650 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5651 ;; once display a just typed password in the context of a keyboard
5652 ;; sequence prompt for a question immediately following in a shell
5653 ;; script run within Emacs -- nasty).
5654 ;; And if I have some ssh session running to a different computer,
5655 ;; having the possibility of passing a local file there to a local
5656 ;; Emacs session (in case I can arrange for a connection back) would
5657 ;; be nice.
5658 ;; Likely the corresponding Tramp server should not allow the
5659 ;; equivalent of the emacsclient -eval option in order to make this
5660 ;; reasonably unproblematic. And maybe trampclient should have some
5661 ;; way of passing credentials, like by using an SSL socket or
5662 ;; something. (David Kastrup)
5663 ;; * Reconnect directly to a compliant shell without first going
5664 ;; through the user's default shell. (Pete Forman)
5665 ;; * How can I interrupt the remote process with a signal
5666 ;; (interrupt-process seems not to work)? (Markus Triska)
5667 ;; * Avoid the local shell entirely for starting remote processes. If
5668 ;; so, I think even a signal, when delivered directly to the local
5669 ;; SSH instance, would correctly be propagated to the remote process
5670 ;; automatically; possibly SSH would have to be started with
5671 ;; "-t". (Markus Triska)
5672 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5673 ;; isn't on the remote host. (Mark A. Hershberger)
5674 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5675 ;; * Optimize out-of-band copying when both methods are scp-like (not
5676 ;; rsync).
5677 ;; * Keep a second connection open for out-of-band methods like scp or
5678 ;; rsync.
5680 ;;; tramp-sh.el ends here