| blob | 55ac778858cb21edf72d6c14da76653779409e6e |
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
143 ;;;###tramp-autoload
153 ;;;###tramp-autoload
170 ;;;###tramp-autoload
188 ;;;###tramp-autoload
203 ;;;###tramp-autoload
210 ;;;###tramp-autoload
217 ;;;###tramp-autoload
230 ;;;###tramp-autoload
243 ;;;###tramp-autoload
251 ;;;###tramp-autoload
259 ;; We use "-v" for better error tracking.
262 ;; We use "-p" as required for newer busyboxes. For older
263 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
264 ;; can be achieved by tweaking `tramp-connection-properties'.
267 ;;;###tramp-autoload
275 ;;;###tramp-autoload
280 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
285 ;;;###tramp-autoload
293 ;;;###tramp-autoload
300 ;;;###tramp-autoload
304 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
308 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
309 tramp-terminal-type
310 tramp-initial-end-of-output))
315 ;;;###tramp-autoload
321 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
322 tramp-terminal-type
323 tramp-initial-end-of-output))
327 ;;;###tramp-autoload
334 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
335 tramp-terminal-type
336 tramp-initial-end-of-output))
346 ;;;###tramp-autoload
353 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
354 tramp-terminal-type
355 tramp-initial-end-of-output))
364 ;;;###tramp-autoload
375 ;;;###tramp-autoload
379 ;;;###tramp-autoload
383 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
384 ;; Do not add "plink" based methods, they ask interactively for the user.
385 ;;;###tramp-autoload
394 ;;;###tramp-autoload
400 ;;;###tramp-autoload
416 ;;;###tramp-autoload
421 ;;;###tramp-autoload
426 ;;;###tramp-autoload
434 ;;;###tramp-autoload
461 ;; "getconf PATH" yields:
462 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
463 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
464 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
465 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
466 ;; IRIX64: /usr/bin
467 ;;;###tramp-autoload
473 "List of directories to search for executables on remote host.
474 For every remote host, this variable will be set buffer local,
475 keeping the list of existing directories on that host.
477 You can use `~' in this list, but when searching for a shell which groks
478 tilde expansion, all directory names starting with `~' will be ignored.
480 `Default Directories' represent the list of directories given by
482 entry on top of this list, because these are the default
483 directories for POSIX compatible commands. On remote hosts which
484 do not offer the getconf command (like cygwin), the value
487 `Private Directories' are the settings of the $PATH environment,
488 as given in your `~/.profile'."
495 ;;;###tramp-autoload
502 "List of environment variables to be set on the remote host.
504 Each element should be a string of the form ENVVARNAME=VALUE. An
505 entry ENVVARNAME= disables the corresponding environment variable,
506 which might have been set in the init files like ~/.profile.
508 Special handling is applied to the PATH environment, which should
509 not be set here. Instead, it should be set via `tramp-remote-path'."
514 ;;;###tramp-autoload
516 "Alist specifying extra arguments to pass to the remote shell.
517 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
518 matching the shell file name and ARGS is a string specifying the
519 arguments.
521 This variable is only used when Tramp needs to start up another shell
522 for tilde expansion. The extra arguments should typically prevent the
523 shell from reading its init file."
525 ;; This might be the wrong way to test whether the widget type
526 ;; `alist' is available. Who knows the right way to test it?
541 "List of pattern/action pairs.
542 Whenever a pattern matches, the corresponding action is performed.
543 Each item looks like (PATTERN ACTION).
545 The PATTERN should be a symbol, a variable. The value of this
546 variable gives the regular expression to search for. Note that the
548 appended to it.
550 The ACTION should also be a symbol, but a function. When the
558 "List of pattern/action pairs.
559 This list is used for copying/renaming with out-of-band methods.
564 "(echo begin 600 %t; tail -n +2) | uudecode
565 cat %t
566 rm -f %t"
567 "Shell function to implement `uudecode' to standard output.
568 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
569 for this or `uudecode -p', but some systems don't, and for them
573 "%s -e '
574 use File::Spec;
577 sub recursive {
578 my ($volume, @dirs) = @_;
579 my $real = realpath(File::Spec->catpath(
581 if ($real) {
582 my ($vol, $dir) = File::Spec->splitpath($real, 1);
583 return ($vol, File::Spec->splitdir($dir));
584 }
585 else {
586 my $last = pop(@dirs);
587 ($volume, @dirs) = recursive($volume, @dirs);
588 push(@dirs, $last);
589 return ($volume, @dirs);
590 }
591 }
593 $result = realpath($ARGV[0]);
594 if (!$result) {
595 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
596 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
599 }
603 }
607 "Perl script to produce output suitable for use with `file-truename'
608 on the remote file system.
609 Escape sequence %s is replaced with name of Perl binary.
613 "%s -e 'sub case {
614 my $str = shift;
615 if ($ARGV[2]) {
616 return lc($str);
617 }
618 else {
619 return $str;
620 }
621 }
623 @files = readdir(d); closedir(d);
624 foreach $f (@files) {
625 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
628 }
629 else {
631 }
632 }
633 }
636 "Perl script to produce output suitable for use with
637 `file-name-all-completions' on the remote file system. Escape
638 sequence %s is replaced with name of Perl binary. This string is
641 ;; Perl script to implement `file-attributes' in a Lisp `read'able
642 ;; output. If you are hacking on this, note that you get *no* output
643 ;; unless this spits out a complete line, including the '\n' at the
644 ;; end.
645 ;; The device number is returned as "-1", because there will be a virtual
646 ;; device number set in `tramp-sh-handle-file-attributes'.
648 "%s -e '
649 @stat = lstat($ARGV[0]);
650 if (!@stat) {
652 exit 0;
653 }
654 if (($stat[2] & 0170000) == 0120000)
655 {
656 $type = readlink($ARGV[0]);
659 }
660 elsif (($stat[2] & 0170000) == 040000)
661 {
663 }
664 else
665 {
667 };
670 printf(
672 $type,
673 $stat[3],
674 $uid,
675 $gid,
676 $stat[8] >> 16 & 0xffff,
677 $stat[8] & 0xffff,
678 $stat[9] >> 16 & 0xffff,
679 $stat[9] & 0xffff,
680 $stat[10] >> 16 & 0xffff,
681 $stat[10] & 0xffff,
682 $stat[7],
683 $stat[2],
684 $stat[1] >> 16 & 0xffff,
685 $stat[1] & 0xffff
687 "Perl script to produce output suitable for use with `file-attributes'
688 on the remote file system.
689 Escape sequence %s is replaced with name of Perl binary.
693 "%s -e '
696 @list = readdir(DIR);
697 closedir(DIR);
698 $n = scalar(@list);
700 for($i = 0; $i < $n; $i++)
701 {
702 $filename = $list[$i];
703 @stat = lstat($filename);
704 if (($stat[2] & 0170000) == 0120000)
705 {
706 $type = readlink($filename);
709 }
710 elsif (($stat[2] & 0170000) == 040000)
711 {
713 }
714 else
715 {
717 };
721 printf(
722 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
723 $filename,
724 $type,
725 $stat[3],
726 $uid,
727 $gid,
728 $stat[8] >> 16 & 0xffff,
729 $stat[8] & 0xffff,
730 $stat[9] >> 16 & 0xffff,
731 $stat[9] & 0xffff,
732 $stat[10] >> 16 & 0xffff,
733 $stat[10] & 0xffff,
734 $stat[7],
735 $stat[2],
736 $stat[1] >> 16 & 0xffff,
737 $stat[1] & 0xffff,
738 $stat[0] >> 16 & 0xffff,
739 $stat[0] & 0xffff);
740 }
742 "Perl script implementing `directory-files-attributes' as Lisp `read'able
743 output.
744 Escape sequence %s is replaced with name of Perl binary.
747 ;; These two use base64 encoding.
749 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
750 "Perl program to use for encoding a file.
751 Escape sequence %s is replaced with name of Perl binary.
752 This string is passed to `format', so percent characters need to be doubled.
753 This implementation requires the MIME::Base64 Perl module to be installed
757 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
758 "Perl program to use for decoding a file.
759 Escape sequence %s is replaced with name of Perl binary.
760 This string is passed to `format', so percent characters need to be doubled.
761 This implementation requires the MIME::Base64 Perl module to be installed
765 "%s -e '
766 # This script contributed by Juanma Barranquero <lektu@terra.es>.
767 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
768 use strict;
770 my %%trans = do {
771 my $i = 0;
772 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
773 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
774 };
775 my $data;
777 # We read in chunks of 54 bytes, to generate output lines
778 # of 72 chars (plus end of line)
779 while (read STDIN, $data, 54) {
780 my $pad = q();
782 # Only for the last chunk, and only if did not fill the last three-byte packet
783 if (eof) {
784 my $mod = length($data) %% 3;
785 $pad = q(=) x (3 - $mod) if $mod;
786 }
788 # Not the fastest method, but it is simple: unpack to binary string, split
789 # by groups of 6 bits and convert back from binary to byte; then map into
790 # the translation table
791 print
792 join q(),
793 map($trans{$_},
794 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
795 $pad,
797 }' 2>/dev/null"
798 "Perl program to use for encoding a file.
799 Escape sequence %s is replaced with name of Perl binary.
803 "%s -e '
804 # This script contributed by Juanma Barranquero <lektu@terra.es>.
805 # Copyright (C) 2002-2015 Free Software Foundation, Inc.
806 use strict;
808 my %%trans = do {
809 my $i = 0;
810 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
811 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
812 };
814 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
818 # We are going to accumulate into $pending to accept any line length
819 # (we do not check they are <= 76 chars as the RFC says)
820 my $pending = q();
822 while (my $data = <STDIN>) {
823 chomp $data;
825 # If we find one or two =, we have reached the end and
826 # any following data is to be discarded
827 my $finished = $data =~ s/(==?).*/$1/;
828 $pending .= $data;
830 my $len = length($pending);
831 my $chunk = substr($pending, 0, $len & ~3);
832 $pending = substr($pending, $len & ~3 + 1);
834 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
835 # split in 8-bit chunks and convert back to char.
836 print join q(),
837 map $bytes{$_},
838 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
840 last if $finished;
841 }' 2>/dev/null"
842 "Perl program to use for decoding a file.
843 Escape sequence %s is replaced with name of Perl binary.
847 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
848 "Perl program to use for encoding a file.
852 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
853 "Perl program to use for decoding a file.
858 while read file; do
861 else
863 fi
866 else
868 fi
869 done
871 "Script to check existence of VC related files.
872 It must be send formatted with two strings; the tests for file
873 existence, and file readability. Input shall be read via
874 here-document, otherwise the command could exceed maximum length
877 ;; New handlers should be added here.
881 ;; `byte-compiler-base-file-name' performed by default handler.
886 ;; `diff-latest-backup-file' performed by default handler.
890 . tramp-sh-handle-directory-files-and-attributes)
891 ;; `dired-call-process' performed by default handler.
894 . tramp-sh-handle-dired-recursive-delete-directory)
901 ;; `file-equal-p' performed by default handler.
904 ;; `file-in-directory-p' performed by default handler.
912 ;; `file-name-sans-versions' performed by default handler.
925 ;; `find-file-noselect' performed by default handler.
926 ;; `get-file-buffer' performed by default handler.
930 . tramp-sh-handle-insert-file-contents-literally)
949 "Alist of handler functions.
952 ;; This must be the last entry, because `identity' always matches.
953 ;;;###tramp-autoload
957 ;;; File Name Handler Functions:
961 "Like `make-symbolic-link' for Tramp files.
962 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
963 the symlink. If LINKNAME is a Tramp file, only the localname component is
964 used as the target of the symlink.
966 If LINKNAME is a Tramp file and the localname component is relative, then
967 it is expanded first, before the localname component is taken. Note that
968 this can give surprising results if the user/host for the source and
969 target of the symlink differ."
976 l 'file-error
979 ;; Do the 'confirm if exists' thing.
981 ;; What to do?
986 "File %s already exists; make it a link anyway? "
987 l-localname)))))
992 ;; If FILENAME is a Tramp name, use just the localname component.
1001 ;; Right, they are on the same host, regardless of user, method,
1002 ;; etc. We now make the link on the remote machine. This will
1003 ;; occur as the user that FILENAME belongs to.
1005 l
1007 "cd %s && %s -sf %s %s"
1009 ln
1012 t))))
1015 "Like `file-truename' for Tramp files."
1017 "%s%s"
1020 method user host
1025 ;; Use GNU readlink --canonicalize-missing where available.
1028 v
1036 ;; Use Perl implementation.
1044 v
1048 ;; Do it yourself. We bind `directory-sep-char' here for
1049 ;; XEmacs on Windows, which would otherwise use backslash.
1057 ;; Don't make the following value larger than
1058 ;; necessary. People expect an error message in
1059 ;; a timely fashion when something is wrong;
1060 ;; otherwise they might think that Emacs is hung.
1061 ;; Of course, correctness has to come first.
1063 symlink-target)
1074 method user host
1086 ;; It's a symlink, follow it.
1092 ;; If the symlink was absolute, we'll get a
1093 ;; string like "/user@host:/some/target";
1094 ;; extract the "/some/target" part from it.
1098 v 'file-error
1099 "Symlink target `%s' on wrong host"
1100 symlink-target))
1105 steps)))
1107 ;; It's a file.
1111 v 'file-error
1114 ;; Combine list to form string.
1125 result))))
1127 ;; Preserve trailing "/".
1130 ;; Basic functions.
1133 "Like `file-exists-p' for Tramp files."
1141 v
1143 "%s %s"
1148 "Like `file-attributes' for Tramp files."
1151 ;; Don't modify `last-coding-system-used' by accident.
1158 v
1166 ;; The scripts could fail, for example with huge file size.
1170 "Implement `file-attributes' for Tramp files using the ls(1) command."
1172 res-inode res-filemodes res-numlinks
1173 res-uid res-gid res-size res-symlink-target)
1176 vec
1183 ;; On systems which have no quoting style, file names
1184 ;; with special characters could fail.
1189 ;; Parse `ls -l' output ...
1193 ;; ... inode
1209 ;; ... file mode flags
1211 ;; ... number links
1213 ;; ... uid and gid
1223 ;; ... size
1225 ;; From the file modes, figure out other stuff.
1228 ;; If symlink, find out file name pointed to.
1235 ;; Return data gathered.
1237 ;; 0. t for directory, string (name linked to) for symbolic
1238 ;; link, or nil.
1240 ;; 1. Number of links to file.
1241 res-numlinks
1242 ;; 2. File uid.
1243 res-uid
1244 ;; 3. File gid.
1245 res-gid
1246 ;; 4. Last access time, as a list of integers. Normally this
1247 ;; would be in the same format as `current-time', but the
1248 ;; subseconds part is not currently implemented, and (0 0)
1249 ;; denotes an unknown time.
1250 ;; 5. Last modification time, likewise.
1251 ;; 6. Last status change time, likewise.
1253 ;; 7. Size in bytes (-1, if number is out of range).
1254 res-size
1255 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1256 res-filemodes
1257 ;; 9. t if file's gid would change if file were deleted and
1258 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1259 t
1260 ;; 10. Inode number.
1261 res-inode
1262 ;; 11. Device number. Will be replaced by a virtual device number.
1263 -1
1264 )))))
1268 "Implement `file-attributes' for Tramp files using a Perl script."
1273 vec
1279 "Implement `file-attributes' for Tramp files using stat(1) command."
1282 vec
1285 ;; On Opsware, pdksh (which is the true name of ksh there)
1286 ;; doesn't parse correctly the sequence "((". Therefore, we add
1287 ;; a space. Apostrophes in the stat output are masked as "//",
1288 ;; in order to make a proper shell escape of them in file names.
1289 "( (%s %s || %s -h %s) && (%s -c "
1290 "'((//%%N//) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 //%%A// t %%ie0 -1)' "
1302 "Like `set-visited-file-modtime' for Tramp files."
1309 coding-system-used)
1313 ;; '(-1 65535) means file doesn't exists yet.
1317 ;; We use '(0 0) as a don't-know value. See also
1318 ;; `tramp-do-file-attributes-with-ls'.
1323 v
1332 nil)))))
1334 ;; This function makes the same assumption as
1335 ;; `tramp-sh-handle-set-visited-file-modtime'.
1337 "Like `verify-visited-file-modtime' for Tramp files.
1338 At the time `verify-visited-file-modtime' calls this function, we
1339 already know that the buffer is visiting a file and that
1340 `visited-file-modtime' does not return 0. Do not call this
1341 function directly, unless those two cases are already taken care
1342 of."
1345 ;; There is no file visiting the buffer, or the buffer has no
1346 ;; recorded last modification time, or there is no established
1347 ;; connection.
1351 t
1359 ;; File exists, and has a known modtime.
1362 modtime
1363 ;; For compatibility, deal with both the old
1364 ;; (HIGH . LOW) and the new (HIGH LOW) return
1365 ;; values of `visited-file-modtime'.
1368 mt)))
1370 ;; Modtime has the don't know value.
1373 v
1380 attr
1383 ;; If file does not exist, say it is not modified if and
1384 ;; only if that agrees with the buffer's record.
1388 "Like `set-file-modes' for Tramp files."
1391 ;; FIXME: extract the proper text from chmod's stderr.
1393 v
1400 "Like `set-file-times' for Tramp files."
1407 time))
1408 ;; With GNU Emacs, `format-time-string' has an
1409 ;; optional parameter UNIVERSAL. This is preferred,
1410 ;; because we could handle the case when the remote
1411 ;; host is located in a different time zone as the
1412 ;; local host.
1416 "%s %s %s %s"
1427 ;; We handle also the local part, because in older Emacsen,
1428 ;; without `set-file-times', this function is an alias for this.
1429 ;; We are local, so we don't need the UTC settings.
1437 "Set the ownership for FILENAME.
1438 If UID and GID are provided, these values are used; otherwise uid
1439 and gid of the corresponding user is taken. Both parameters must
1440 be non-negative integers."
1441 ;; Modern Unices allow chown only for root. So we might need
1442 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1443 ;; working with su(do)? when it is needed, so it shall succeed in
1444 ;; the majority of cases.
1445 ;; Don't modify `last-coding-system-used' by accident.
1450 ;; If we are root on the local host, we can do it directly.
1458 "chown %d:%d %s" uid gid
1461 ;; We handle also the local part, because there doesn't exist
1462 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1466 nil "chown" nil nil nil
1470 "Check, whether SELINUX is enabled on the remote host."
1482 "Like `file-selinux-context' for Tramp files."
1491 "%s -d -Z %s"
1499 ;; Return the context.
1500 context))))
1503 "Like `set-file-selinux-context' for Tramp files."
1520 t)
1522 nil)))
1525 "Check, whether ACL is enabled on the remote host."
1530 "Like `file-acl' for Tramp files."
1536 "getfacl -ac %s 2>/dev/null"
1546 "Like `set-file-acl' for Tramp files."
1553 tramp-end-of-heredoc
1554 acl-string
1555 tramp-end-of-heredoc))
1557 ;; Success.
1560 t)
1561 ;; In case of errors, we return nil.
1563 nil)))
1565 ;; Simple functions using the `test' command.
1568 "Like `file-executable-p' for Tramp files."
1571 ;; Examine `file-attributes' cache to see if request can be
1572 ;; satisfied without remote operation.
1577 "Like `file-readable-p' for Tramp files."
1580 ;; Examine `file-attributes' cache to see if request can be
1581 ;; satisfied without remote operation.
1585 ;; When the remote shell is started, it looks for a shell which groks
1586 ;; tilde expansion. Here, we assume that all shells which grok tilde
1587 ;; expansion will also provide a `test' command which groks `-nt' (for
1588 ;; newer than). If this breaks, tell me about it and I'll try to do
1589 ;; something smarter about it.
1591 "Like `file-newer-than-file-p' for Tramp files."
1593 nil)
1595 t)
1596 ;; We are sure both files exist at this point.
1599 ;; We try to get the mtime of both files. If they are not
1600 ;; equal to the "dont-know" value, then we subtract the times
1601 ;; and obtain the result.
1607 ;; If one of them is the dont-know value, then we can
1608 ;; still try to run a shell command on the remote host.
1609 ;; However, this only works if both files are Tramp
1610 ;; files and both have the same method, same user, same
1611 ;; host.
1616 v 'file-error
1617 "Files %s and %s must have same method, user, host"
1618 file1 file2)))
1623 ;; Functions implemented using the basic functions above.
1626 "Like `file-directory-p' for Tramp files."
1628 ;; `file-directory-p' is used as predicate for file name completion.
1629 ;; Sometimes, when a connection is not established yet, it is
1630 ;; desirable to return t immediately for "/method:foo:". It can
1631 ;; be expected that this is always a directory.
1637 "Like `file-writable-p' for Tramp files."
1641 ;; Examine `file-attributes' cache to see if request can be
1642 ;; satisfied without remote operation.
1645 ;; If file doesn't exist, check if directory is writable.
1650 "Like `file-ownership-preserved-p' for Tramp files."
1654 ;; Return t if the file doesn't exist, since it's true that no
1655 ;; information would be lost by an (attempted) delete and create.
1662 ;; Directory listings.
1666 "Like `directory-files-and-attributes' for Tramp files."
1674 v localname
1685 v localname id-format))
1688 v localname id-format))
1690 result item)
1700 result
1702 ;; The scripts could fail, for example with huge file size.
1704 directory full match nosort id-format)))))
1708 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1711 vec tramp-perl-directory-files-and-attributes
1715 vec
1719 object))
1723 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1726 vec
1729 ;; We must care about file names with spaces, or starting with
1730 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1731 ;; but it does not work on all remote systems. Apostrophes in
1732 ;; the stat output are masked as "//", in order to make a proper
1733 ;; shell escape of them in file names.
1735 "xargs %s -c "
1736 "'(//%%n// (//%%N//) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 //%%A// t %%ie0 -1)' "
1740 ;; On systems which have no quoting style, file names with
1741 ;; special characters could fail.
1748 ;; This function should return "foo/" for directories and "bar" for
1749 ;; files.
1751 "Like `file-name-all-completions' for Tramp files."
1756 filename
1758 'list
1760 ;; Try cache entries for `filename', `filename' with last
1761 ;; character removed, `filename' with last two characters
1762 ;; removed, ..., and finally the empty string - all
1763 ;; concatenated to the local directory name.
1766 tramp-completion-reread-directory-timeout)))
1768 ;; This is inefficient for very long file names, pity
1769 ;; `reduce' is not available...
1772 'append
1777 v
1779 "file-name-all-completions"
1780 nil)))
1782 ;; We cannot use a length of 0, because file properties
1783 ;; for "foo" and "foo/" are identical.
1786 ;; Cache expired or no matching cache entry found so we need
1787 ;; to perform a remote operation.
1789 ;; Get a list of directories and files, including reliably
1790 ;; tagging the directories with a trailing '/'. Because I
1791 ;; rock. --daniel@danann.net
1793 ;; Changed to perform `cd' in the same remote op and only
1794 ;; get entries starting with `filename'. Capture any `cd'
1795 ;; error messages. Ensure any `cd' and `echo' aliases are
1796 ;; ignored.
1798 v
1802 v tramp-perl-file-name-all-completions
1808 ;; `read-file-name-completion-ignore-case'
1809 ;; is introduced with Emacs 22.1.
1812 'read-file-name-completion-ignore-case
1817 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1818 ;; `ls' with wildcard might fail with `Argument
1819 ;; list too long' error in some corner cases; if
1820 ;; `ls' fails after `cd' succeeded, chances are
1821 ;; that's the case, so let's retry without
1822 ;; wildcard. This will return "too many" entries
1823 ;; but that isn't harmful.
1824 " || %s -a 2>/dev/null)"
1825 " | while IFS= read f; do"
1831 ;; When `filename' is empty, just `ls' without
1832 ;; `filename' argument is more efficient than `ls *'
1833 ;; for very large directories and might avoid the
1834 ;; `Argument list too long' error.
1835 ;;
1836 ;; With and only with wildcard, we need to add
1837 ;; `-d' to prevent `ls' from descending into
1838 ;; sub-directories.
1840 "."
1845 ;; Now grab the output.
1849 ;; Check result code, found in last line of output.
1853 ;; Grab error message from line before last line
1854 ;; (it was put there by `cd 2>&1').
1857 v 'file-error
1858 "tramp-sh-handle-file-name-all-completions: %s"
1860 ;; For peace of mind, if buffer doesn't end in `fail'
1861 ;; then it should end in `ok'. If neither are in the
1862 ;; buffer something went seriously wrong on the remote
1863 ;; side.
1866 v 'file-error
1867 "\
1868 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1874 ;; Because the remote op went through OK we know the
1875 ;; directory we `cd'-ed to exists.
1878 ;; Because the remote op went through OK we know every
1879 ;; file listed by `ls' exists.
1883 result)
1885 ;; Store result in the cache.
1890 ;; cp, mv and ln
1894 "Like `add-name-to-file' for Tramp files."
1899 v 'file-error
1900 "add-name-to-file: %s"
1909 "File %s already exists; make it a new name anyway? "
1910 newname)))
1917 v1
1921 "error with add-name-to-file, see buffer `%s' for details"
1926 preserve-uid-gid preserve-extended-attributes)
1927 "Like `copy-file' for Tramp files."
1931 ;; At least one file a Tramp file?
1935 'copy filename newname ok-if-already-exists keep-date
1936 preserve-uid-gid preserve-extended-attributes))
1937 ;; Compat section.
1940 'copy-file
1942 preserve-uid-gid preserve-extended-attributes)))
1945 'copy-file
1953 "Like `copy-directory' for Tramp files."
1959 ;; When DIRNAME and NEWNAME are remote, they must have
1960 ;; the same method.
1966 ;; scp or rsync DTRT.
1980 ;; We must do it file-wise.
1982 'copy-directory
1987 ;; When newname did exist, we have wrong cached values.
1995 "Like `rename-file' for Tramp files."
1996 ;; Check if both files are local -- invoke normal rename-file.
1997 ;; Otherwise, use Tramp from local system.
2000 ;; At least one file a Tramp file?
2010 preserve-uid-gid preserve-extended-attributes)
2011 "Copy or rename a remote file.
2012 OP must be `copy' or `rename' and indicates the operation to perform.
2013 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2014 the new file (for copy) or the new name of the file (for rename).
2015 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2016 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2017 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2018 the uid and gid if both files are on the same host.
2019 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2021 This function is invoked by `tramp-sh-handle-copy-file' and
2022 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2023 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2024 file names."
2041 filename newname)
2044 ;; Both are Tramp files.
2049 ;; Shortcut: if method, host, user are the same for
2050 ;; both files, we invoke `cp' or `mv' on the remote
2051 ;; host directly.
2054 op filename newname
2055 ok-if-already-exists keep-date preserve-uid-gid))
2057 ;; Try out-of-band operation.
2062 op filename newname keep-date))
2064 ;; No shortcut was possible. So we copy the file
2065 ;; first. If the operation was `rename', we go back
2066 ;; and delete the original file (if the copy was
2067 ;; successful). The approach is simple-minded: we
2068 ;; create a new buffer, insert the contents of the
2069 ;; source file into it, then write out the buffer to
2070 ;; the target file. The advantage is that it doesn't
2071 ;; matter which file name handlers are used for the
2072 ;; source and target file.
2075 op filename newname keep-date))))))
2077 ;; One file is a Tramp file, the other one is local.
2080 ;; Fast track on local machine.
2083 op filename newname
2084 ok-if-already-exists keep-date preserve-uid-gid))
2086 ;; If the Tramp file has an out-of-band method, the
2087 ;; corresponding copy-program can be invoked.
2090 op filename newname keep-date))
2092 ;; Use the inline method via a Tramp buffer.
2094 op filename newname keep-date))))
2097 ;; One of them must be a Tramp file.
2100 ;; Handle `preserve-extended-attributes'. We ignore possible
2101 ;; errors, because ACL strings could be incompatible.
2106 ;; In case of `rename', we must flush the cache of the source file.
2112 ;; When newname did exist, we have wrong cached values.
2119 "Use an Emacs buffer to copy or rename a file.
2120 First arg OP is either `copy' or `rename' and indicates the operation.
2121 FILENAME is the source file, NEWNAME the target file.
2122 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2123 ;; We must disable multibyte, because binary data shall not be
2124 ;; converted. We don't want the target file to be compressed, so we
2125 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2126 ;; be called either. We remove `tramp-file-name-handler' from
2127 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2128 ;; `insert-file-contents' might be deactivated in some corner cases.
2138 ;; KEEP-DATE handling.
2140 ;; Set the mode.
2142 ;; If the operation was `rename', delete the original file.
2147 "Invokes `cp' or `mv' on the remote system.
2148 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2149 respectively. FILENAME specifies the file to copy or rename,
2150 NEWNAME is the name of the new file (for copy) or the new name of
2151 the file (for rename). Both files must reside on the same host.
2152 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2153 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2154 the uid and gid from FILENAME."
2164 v 'file-error
2165 "Unknown operation `%s', must be `copy' or `rename'"
2166 op))))
2170 filename))
2174 newname))
2176 cmd-result)
2179 ;; Both files are on a remote host, with same user.
2191 ;; Mask cp -f error.
2193 tramp-operation-not-permitted-regexp nil t))
2194 cmd-result)
2196 nil v 'file-error
2197 "Copying directly failed, see buffer `%s' for details."
2200 ;; We are on the local host.
2203 ;; We can do it directly.
2206 ;; No sticky bit when renaming.
2217 localname1 localname2 ok-if-already-exists
2218 keep-date preserve-uid-gid)
2222 ;; We can do it directly with `tramp-send-command'
2230 ok-if-already-exists keep-date t)
2231 ;; We must change the ownership to the local user.
2237 ;; We need a temporary file in between.
2239 ;; Create the temporary file.
2247 "%s %s %s" cmd
2250 "Copying directly failed, see buffer `%s' for details."
2252 ;; We must change the ownership as remote user.
2253 ;; Since this does not work reliable, we also
2254 ;; give read permissions.
2265 localname1 tmpfile t
2266 keep-date preserve-uid-gid)
2268 'rename-file
2270 ;; We must change the ownership as local user.
2271 ;; Since this does not work reliable, we also
2272 ;; give read permissions.
2276 tmpfile
2280 ;; Move the temporary file to its destination.
2285 "cp -f -p %s %s"
2288 "Copying directly failed, see buffer `%s' for details."
2292 'rename-file
2295 ;; Save exit.
2298 ;; Set the time and mode. Mask possible errors.
2305 "Invoke `scp' program to copy.
2306 The method used must be an out-of-band method."
2310 copy-program copy-args copy-env copy-keep-date port listener spec
2311 options source target remote-copy-program remote-copy-args)
2316 ;; Both are Tramp files. We shall optimize it when the
2317 ;; methods for FILENAME and NEWNAME are the same.
2327 op filename tmpfile keep-date)
2330 ;; Save exit.
2337 ;; Set variables for computing the prompt for reading
2338 ;; password.
2345 ;; Expand hops. Might be necessary for gateway methods.
2349 ;; Check which ones of source and target are Tramp files.
2358 'file-name-directory
2364 ;; Check for host and port number. We cannot use
2365 ;; `tramp-file-name-port', because this returns also
2366 ;; `tramp-default-port', which might clash with settings in
2367 ;; "~/.ssh/config".
2374 ;; Check for user. There might be an interactive setting.
2378 ;; Check for listener port.
2385 ;; Compose copy command.
2394 ?h host ?u user ?p port ?r listener ?c options
2401 copy-args
2403 ;; " " has either been a replacement of "%k" (when
2404 ;; keep-date argument is non-nil), or a replacement
2405 ;; for the whole keep-date sublist.
2406 " "
2410 copy-args)
2413 copy-args
2417 copy-env
2419 nil
2426 remote-copy-program
2436 remote-copy-args
2440 ;; Check for local copy program.
2445 ;; Install listener on the remote side. The prompt must be
2446 ;; consumed later on, when the process does not listen anymore.
2453 v 'file-error
2457 'identity
2465 v 'file-error
2466 "Listener process not running on remote host: `%s'"
2467 remote-copy-program))
2475 ;; The default directory must be remote.
2479 ;; Set the transfer process properties.
2489 copy-args
2491 copy-args
2496 ;; Use an asynchronous process. By this, password can
2497 ;; be handled. We don't set a timeout, because the
2498 ;; copying of large files can last longer than 60
2499 ;; secs.
2503 copy-program
2505 copy-args
2514 ;; We must adapt `tramp-local-end-of-line' for
2515 ;; sending the password.
2518 p v nil tramp-actions-copy-out-of-band))
2520 ;; Check the return code.
2525 orig-vec 'file-error
2526 "Couldn't find exit status of `%s'"
2532 orig-vec 'file-error
2533 "Error copying: `%s'"
2536 ;; Reset the transfer process properties.
2539 ;; Clear the remote prompt.
2542 ;; Houston, we have a problem! Likely, the listener is
2543 ;; still running, so let's clear everything (but the
2544 ;; cached password).
2547 ;; Handle KEEP-DATE argument.
2551 ;; Set the mode.
2556 ;; If the operation was `rename', delete the original file.
2563 "Like `make-directory' for Tramp files."
2575 "Like `delete-directory' for Tramp files."
2587 "Like `delete-file' for Tramp files."
2598 ;; Dired.
2600 ;; CCC: This does not seem to be enough. Something dies when
2601 ;; we try and delete two directories under Tramp :/
2603 "Recursively delete the directory given.
2604 This is like `dired-recursive-delete-directory' for Tramp files."
2606 ;; Run a shell command 'rm -r <localname>'.
2607 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2610 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2612 v
2614 ;; Don't read the output, do it explicitly.
2615 nil t)
2616 ;; Wait for the remote system to return to us...
2617 ;; This might take a while, allow it plenty of time.
2619 ;; Make sure that it worked...
2627 "Like `dired-compress-file' for Tramp files."
2628 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2629 ;; Code stolen mainly from dired-aux.el.
2635 ;; Emacs case
2637 ;; XEmacs has `dired-compression-method-alist', which is
2638 ;; transformed into `dired-compress-file-suffixes' structure.
2642 nil
2645 suffix)
2646 ;; See if any suffix rule matches this file name.
2654 nil)
2656 ;; We found an uncompression rule.
2662 ;; `dired-remove-file' is not defined in XEmacs.
2667 ;; We don't recognize the file as compressed, so compress it.
2668 ;; Try gzip.
2673 ;; `dired-remove-file' is not defined in XEmacs.
2683 "Like `insert-directory' for Tramp files."
2690 filename switches wildcard full-directory-p)
2710 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2711 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2714 v
2717 switches
2719 localname
2722 v
2726 "Couldn't `cd %s'"
2730 v
2733 switches
2738 ""
2746 ;; We cannot use `insert-buffer-substring' because the Tramp
2747 ;; buffer changes its contents before insertion due to calling
2748 ;; `expand-file' and alike.
2753 ;; Check for "--dired" output.
2760 ;; Now read the numeric positions of file names.
2766 ;; End is followed by \n or by " -> ".
2768 ;; Remove trailing lines.
2774 ;; Some busyboxes are reluctant to discard colors.
2781 ;; Decode the output, it could be multibyte.
2788 ;; The inserted file could be from somewhere else.
2795 "."
2802 ;; Canonicalization of file names.
2805 "Like `expand-file-name' for Tramp files.
2807 the result will be a local, non-Tramp, file name."
2808 ;; If DIR is not given, use `default-directory' or "/".
2810 ;; Unless NAME is absolute, concat DIR and NAME.
2813 ;; If NAME is not a Tramp file, run the real handler.
2816 ;; Dissect NAME.
2820 ;; Tilde expansion if necessary. This needs a shell which
2821 ;; groks tilde expansion! The function `tramp-find-shell' is
2822 ;; supposed to find such a shell on the remote host. Please
2823 ;; tell me about it when this doesn't work on your system.
2827 ;; We cannot simply apply "~/", because under sudo "~/" is
2828 ;; expanded to the local user home directory but to the
2829 ;; root home directory. On the other hand, using always
2830 ;; the default user name for tilde expansion is not
2831 ;; appropriate either, because ssh and companions might
2832 ;; use a user name from the config file.
2844 ;; There might be a double slash, for example when "~/"
2845 ;; expands to "/". Remove this.
2848 ;; No tilde characters in file name, do normal
2849 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2850 ;; `directory-sep-char' here for XEmacs on Windows, which would
2851 ;; otherwise use backslash. `default-directory' is bound,
2852 ;; because on Windows there would be problems with UNC shares or
2853 ;; Cygwin mounts.
2857 method user host
2861 hop)))))
2863 ;;; Remote commands:
2866 "Flush file caches."
2874 ;; We use BUFFER also as connection buffer during setup. Because of
2875 ;; this, its original contents must be saved, and restored once
2876 ;; connection has been setup.
2878 "Like `start-file-process' for Tramp files."
2881 ;; it might be that the arguments exceed the command line
2882 ;; length. Therefore, we modify the command.
2887 ;; When PROGRAM is nil, we just provide a tty.
2893 args
2897 ;; Use a human-friendly prompt, for example for `shell'.
2901 tramp-initial-end-of-output)))
2902 ;; We use as environment the difference to toplevel
2903 ;; `process-environment'.
2904 env
2909 env)
2928 ;; We do not want to raise an error when
2929 ;; `start-file-process' has been started several times in
2930 ;; `eshell' and friends.
2934 ;; BUFFER can be nil. We use a temporary buffer.
2937 ;; NAME must be unique as process name.
2941 ;; Set the new process properties.
2947 ;; We catch this event. Otherwise, `start-process' could
2948 ;; be called on the local host.
2951 ;; Activate narrowing in order to save BUFFER
2952 ;; contents. Clear also the modification time;
2953 ;; otherwise we might be interrupted by
2954 ;; `verify-visited-file-modtime'.
2960 ;; We call `tramp-maybe-open-connection', in order
2961 ;; to cleanup the prompt afterwards.
2967 ;; Now do it.
2969 ;; Send the command.
2971 ;; Check, whether a pty is associated.
2975 v 'file-error
2978 ;; Set query flag and process marker for this
2979 ;; process. We ignore errors, because the process
2980 ;; could have finished already.
2984 ;; Return process.
2985 p))))
2987 ;; Save exit.
2998 "Like `process-file' for Tramp files."
2999 ;; The implementation is not complete yet.
3005 ;; Compute command.
3008 ;; We use as environment the difference to toplevel `process-environment'.
3016 "env %s %s"
3018 ;; Determine input.
3023 ;; INFILE is on the same remote host.
3025 ;; INFILE must be copied to remote host.
3031 ;; Determine output.
3033 ;; Just a buffer.
3036 ;; A buffer name.
3039 ;; (REAL-DESTINATION ERROR-DESTINATION)
3041 ;; output.
3049 ;; stderr.
3054 ;; stderr is on the same remote host.
3057 ;; stderr must be copied to remote host. The temporary
3058 ;; file must be deleted after execution.
3061 method user host stderr))))
3062 ;; stderr to be discarded.
3065 ;; 't
3070 ;; Send the command. It might not return in time, so we protect
3071 ;; it. Call it in a subshell, in order to preserve working
3072 ;; directory.
3079 command)
3080 t t)
3082 ;; We should add the output anyway.
3089 ;; When the user did interrupt, we should do it also. We use
3090 ;; return code -1 as marker.
3094 ;; Handle errors.
3099 ;; Provide error file.
3102 ;; Cleanup. We remove all file cache values for the connection,
3103 ;; because the remote process could have changed them.
3106 ;; `process-file-side-effects' has been introduced with GNU
3107 ;; Emacs 23.2. If set to nil, no remote file will be changed
3108 ;; by `program'. If it doesn't exist, we assume its default
3109 ;; value t.
3114 ;; Return exit status.
3117 ret))))
3120 "Like `file-local-copy' for Tramp files."
3124 v 'file-error
3134 ;; `copy-file' handles direct copy and out-of-band methods.
3139 ;; Use inline encoding for file transfer.
3143 v 3
3151 tmpfile loc-dec)
3153 ;; If local decoding is a function, we call it.
3154 ;; We must disable multibyte, because
3155 ;; `uudecode-decode-region' doesn't handle it
3156 ;; correctly. Unset `file-name-handler-alist'.
3157 ;; Otherwise, epa-file gets confused.
3165 ;; If tramp-decoding-function is not defined for this
3166 ;; method, we invoke tramp-decoding-command instead.
3168 ;; Unset `file-name-handler-alist'. Otherwise,
3169 ;; epa-file gets confused.
3177 loc-dec tmpfile2 tmpfile)
3180 ;; Set proper permissions.
3182 ;; Set local user ownership.
3185 ;; Oops, I don't know what to do.
3189 ;; Error handling.
3195 tmpfile)))
3197 ;; This is needed for XEmacs only. Code stolen from files.el.
3200 "Like `insert-file-contents-literally' for Tramp files."
3208 nil))
3216 ;; Save exit.
3221 ;; CCC grok LOCKNAME
3224 "Like `write-region' for Tramp files."
3227 ;; Following part commented out because we don't know what to do about
3228 ;; file locking, and it does not appear to be a problem to ignore it.
3229 ;; Ange-ftp ignores it, too.
3230 ;; (when (and lockname (stringp lockname))
3231 ;; (setq lockname (expand-file-name lockname)))
3232 ;; (unless (or (eq lockname nil)
3233 ;; (string= lockname filename))
3234 ;; (error
3235 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3237 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3248 ;; `file-writable-p' calls `file-expand-file-name'. We
3249 ;; cannot use `tramp-run-real-handler' therefore.
3255 ;; Short track: if we are on the local host, we can run directly.
3257 'write-region
3261 ;; We use this to save the value of
3262 ;; `last-coding-system-used' after writing the tmp
3263 ;; file. At the end of the function, we set
3264 ;; `last-coding-system-used' to this saved value. This
3265 ;; way, any intermediary coding systems used while
3266 ;; talking to the remote shell or suchlike won't hose
3267 ;; this variable. This approach was snarfed from
3268 ;; ange-ftp.el.
3269 coding-system-used
3270 ;; Write region into a tmp file. This isn't really
3271 ;; needed if we use an encoding function, but currently
3272 ;; we use it always because this makes the logic
3273 ;; simpler. We must also set `temporary-file-directory',
3274 ;; because it could point to a remote directory.
3280 ;; If `append' is non-nil, we copy the file locally, and let
3281 ;; the native `write-region' implementation do the job.
3284 ;; We say `no-message' here because we don't want the
3285 ;; visited file modtime data to be clobbered from the temp
3286 ;; file. We call `set-visited-file-modtime' ourselves later
3287 ;; on. We must ensure that `file-coding-system-alist'
3288 ;; matches `tmpfile'.
3294 'write-region
3301 ;; Now, `last-coding-system-used' has the right value. Remember it.
3306 ;; The permissions of the temporary file should be set. If
3307 ;; FILENAME does not exist (eq modes nil) it has been
3308 ;; renamed to the backup file. This case `save-buffer'
3309 ;; handles permissions.
3310 ;; Ensure that it is still readable.
3313 tmpfile
3316 ;; This is a bit lengthy due to the different methods
3317 ;; possible for file transfer. First, we check whether the
3318 ;; method uses an scp program. If so, we call it.
3319 ;; Otherwise, both encoding and decoding command must be
3320 ;; specified. However, if the method _also_ specifies an
3321 ;; encoding function, then that is used for encoding the
3322 ;; contents of the tmp file.
3327 ;; `copy-file' handles direct copy and out-of-band methods.
3338 ;; We keep the local file for performance
3339 ;; reasons, useful for "rsync".
3346 ;; Don't rename, in order to keep context in SELinux.
3351 ;; Use inline file transfer.
3353 ;; Encode tmpfile.
3357 ;; Use encoding function or command.
3360 tmpfile loc-enc)
3362 ;; The following `let' is a workaround for
3363 ;; the base64.el that comes with pgnus-0.84.
3364 ;; If both of the following conditions are
3365 ;; satisfied, it tries to write to a local
3366 ;; file in default-directory, but at this
3367 ;; point, default-directory is remote.
3368 ;; (`call-process-region' can't write to
3369 ;; remote files, it seems.) The file in
3370 ;; question is a tmp file anyway.
3378 loc-enc tmpfile t))
3380 v 'file-error
3383 filename loc-enc))))
3385 ;; Send buffer into remote decoding command which
3386 ;; writes to remote file. Because this happens on
3387 ;; the remote host, we cannot use the function.
3390 filename rem-dec)
3394 v
3398 tramp-end-of-heredoc
3400 tramp-end-of-heredoc))
3402 v nil
3403 "Couldn't write region to `%s', decode using `%s' failed"
3404 filename rem-dec)
3405 ;; When `file-precious-flag' is set, the region is
3406 ;; written to a temporary file. Check that the
3407 ;; checksum is equal to that from the local tmpfile.
3411 ;; cksum runs locally, if possible.
3413 ;; cksum runs remotely.
3415 v
3418 ;; ... they are different.
3425 v 'file-error
3428 filename rem-dec)))))
3430 ;; Save exit.
3433 ;; That's not expected.
3436 v 'file-error
3439 method))))
3441 ;; Make `last-coding-system-used' have the right value.
3448 ;; We must protect `last-coding-system-used', now we have set it
3449 ;; to its correct value.
3451 ;; Set file modification time.
3455 ;; We must pass modtime explicitly, because FILENAME can
3456 ;; be different from (buffer-file-name), f.e. if
3457 ;; `file-precious-flag' is set.
3463 ;; Set the ownership.
3473 ;; VC backends check for the existence of various different special
3474 ;; files. This is very time consuming, because every single check
3475 ;; requires a remote command (the file cache must be invalidated).
3476 ;; Therefore, we apply a kind of optimization. We install the file
3477 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3478 ;; remembers all file names for which `file-exists-p' or
3479 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3480 ;; is performed. Afterwards, a script is applied for all collected
3481 ;; file names, using just one remote command. The result of this
3482 ;; script is used to fill the file cache with actual values. Now we
3483 ;; can reset the file name handlers, and we make a second run of
3484 ;; `vc-registered', which returns the expected result without sending
3485 ;; any other remote command.
3487 "Like `vc-registered' for Tramp files."
3493 ;; There could be new files, created by the vc backend. We
3494 ;; cannot reuse the old cache entries, therefore. In
3495 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3496 ;; could also be a timestamp as `current-time' returns. This
3497 ;; means invalidate all cache entries with an older timestamp.
3503 ;; Here we collect only file names, which need an operation.
3507 ;; Send just one command, in order to fill the cache.
3510 v
3519 ;; We cannot use `tramp-send-command-and-read',
3520 ;; because this does not cooperate well with
3521 ;; heredoc documents.
3523 v
3526 tramp-end-of-heredoc
3528 tramp-vc-registered-file-names
3530 tramp-end-of-heredoc))
3532 ;; Read the expression.
3539 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3540 ;; calls shall be answered from the file cache. We unset
3541 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3542 ;; in order to keep the cache.
3544 remote-file-name-inhibit-cache process-file-side-effects)
3545 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3564 ;; Run.
3568 ;;;###tramp-autoload
3570 "Invoke remote-shell Tramp file name handler.
3571 Fall back to normal file name handler if no Tramp handler exists."
3589 "Invoke special file name handler, which collects files to be handled."
3597 ;; That's what we want: file names, for which checks are
3598 ;; applied. We assume that VC uses only `file-exists-p' and
3599 ;; `file-readable-p' checks; otherwise we must extend the
3600 ;; list. We do not perform any action, but return nil, in
3601 ;; order to keep `vc-registered' running.
3604 nil)
3605 ;; `process-file' and `start-file-process' shall be ignored.
3608 ;; Tramp file name handlers like `expand-file-name'. They
3609 ;; must still work.
3611 ;; Default file name handlers, we don't care.
3615 "Like `file-notify-add-watch' for Tramp files."
3619 command events filter p sequence)
3621 ;; gvfs-monitor-dir.
3625 ;; inotifywait.
3628 events
3635 ;; None.
3637 v 'file-notify-error
3638 "No file notification program found on %s"
3640 ;; Start process.
3642 'start-file-process
3646 sequence))
3647 ;; Return the process object as watch-descriptor.
3650 v 'file-notify-error
3651 "`%s' failed to start on remote host"
3657 p))))
3669 ;; Attribute change is returned in unused wording.
3679 string)
3682 proc
3686 ;; File names are returned as absolute paths. We must
3687 ;; add the remote prefix.
3692 ;; Usually, we would add an Emacs event now. Unfortunately,
3693 ;; `unread-command-events' does not accept several events at
3694 ;; once. Therefore, we apply the callback directly.
3697 ;; Save rest of the string.
3706 ;; Check, whether there is a problem.
3712 line)
3717 proc
3724 ;; Usually, we would add an Emacs event now. Unfortunately,
3725 ;; `unread-command-events' does not accept several events at
3726 ;; once. Therefore, we apply the callback directly.
3729 ;;; Internal Functions:
3732 "Define in remote shell function NAME implemented as SCRIPT.
3733 Only send the definition if it has not already been done."
3734 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3735 ;; might be nil.
3740 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3741 ;; could result in unwanted command expansion. Avoid this.
3744 ;; The script could contain a call of Perl. This is masked with `%s'.
3749 vec
3760 auto-save-default)
3768 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3769 Returns the exit code of the `test' program."
3772 v
3774 "%s %s %s"
3776 switch
3780 "Run `test'-like program on the remote system, given FILE1, FILE2.
3781 FORMAT-STRING contains the program name, switches, and place holders.
3782 Returns the exit code of the `test' program. Barfs if the methods,
3783 hosts, or files, disagree."
3787 v 'file-error
3792 v1
3799 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3800 First arg VEC specifies the connection, PROGNAME is the program
3801 to search for, and DIRLIST gives the list of directories to
3802 search. If IGNORE-TILDE is non-nil, directory names starting
3803 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3804 only in DIRLIST.
3806 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3808 This function expects to be in the right *tramp* buffer."
3811 ;; Check whether the executable is in $PATH. "which(1)" does not
3812 ;; report always a correct error code; therefore we check the
3813 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3814 ;; 5.11") have problems with this command, we disable the call
3815 ;; therefore.
3826 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3827 ;; `remove' is in CL, and we want to avoid CL dependencies.
3836 vec
3838 "do if test -x $d/%s && test -f $d/%s; "
3839 "then echo tramp_executable $d/%s; "
3842 progname progname progname
3843 tramp-end-of-heredoc
3845 tramp-end-of-heredoc))
3851 result)))
3854 "Sets the remote environment PATH to existing directories.
3855 I.e., for each directory in `tramp-remote-path', it is tested
3856 whether it exists and if so, it is added to the environment
3857 variable PATH."
3863 ;; ------------------------------------------------------------
3864 ;; -- Communication with external shell --
3865 ;; ------------------------------------------------------------
3868 "Find a command on the remote host for checking if a file exists.
3869 Here, we are looking for a command which has zero exit status if the
3870 file exists and nonzero exit status otherwise."
3874 result)
3875 ;; The algorithm is as follows: we try a list of several commands.
3876 ;; For each command, we first run `$cmd /' -- this should return
3877 ;; true, as the root directory always exists. And then we run
3878 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3879 ;; does not exist. This should return false. We use the first
3880 ;; command we find that seems to work.
3881 ;; The list of commands to try is as follows:
3882 ;; `ls -d' This works on most systems, but NetBSD 1.4
3883 ;; has a bug: `ls' always returns zero exit
3884 ;; status, even for files which don't exist.
3885 ;; `test -e' Some Bourne shells have a `test' builtin
3886 ;; which does not know the `-e' option.
3887 ;; `/bin/test -e' For those, the `test' binary on disk normally
3888 ;; provides the option. Alas, the binary
3889 ;; is sometimes `/bin/test' and sometimes it's
3890 ;; `/usr/bin/test'.
3891 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3919 result))
3922 "Opens shell SHELL."
3925 ;; Find arguments for this shell.
3927 item extra-args)
3932 ;; It is useful to set the prompt in the following command
3933 ;; because some people have a setting for $PS1 which /bin/sh
3934 ;; doesn't know about and thus /bin/sh will display a strange
3935 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3936 ;; ksh will display the current working directory but /bin/sh
3937 ;; will display a dollar sign. The following command line sets
3938 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3939 ;; well as csh-like shells. We also unset the variable $ENV
3940 ;; because that is read by some sh implementations (eg, bash
3941 ;; when called as sh) on startup; this way, we avoid the startup
3942 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3943 ;; the prompt in /bin/bash, it must be discarded as well.
3944 ;; $HISTFILE is set according to `tramp-histfile-override'.
3947 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3952 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3956 t))
3961 "Opens a shell on the remote host which groks tilde expansion."
3969 shell)
3972 ;; CCC: "root" does not exist always, see QNAP 459.
3973 ;; Which check could we apply instead?
3976 ;; The default shell (ksh93) of OpenSolaris and
3977 ;; Solaris is buggy. We've got reports for
3978 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3987 ;; Maybe it works at least for some other commands.
3989 default-shell
3991 vec 2
3993 "Couldn't find a remote shell which groks tilde "
3995 default-shell)))
3997 default-shell)))
3999 ;; Open a new shell if needed.
4005 ;; Utility functions.
4008 "Wait for shell prompt and barf if none appears.
4009 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4010 seconds. If not, it produces an error message with the given ERROR-ARGS."
4014 proc timeout
4023 "Set up an interactive shell.
4024 Mainly sets the prompt and the echo correctly. PROC is the shell
4025 process to set up. VEC specifies the connection."
4028 vec
4033 ;; Disable echo.
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.
4578 vec 'file-error
4579 "Method `%s' is not supported for multi-hops."
4582 ;; In case the host name is not used for the remote shell
4583 ;; command, the user could be misguided by applying a random
4584 ;; host name.
4590 ;; There are multi-hops.
4592 ;; The host name is used for the remote shell command.
4595 ;; The host is local. We cannot use `tramp-local-host-p'
4596 ;; here, because it opens a connection as well.
4599 v 'file-error
4600 "Host `%s' looks like a remote host, `%s' can only use the local host"
4601 host method)))
4603 ;; Result.
4604 target-alist))
4607 "Return the Control* arguments of the local ssh."
4609 ;; No options to be computed.
4615 ;; There is already a value to be used.
4618 ;; Determine the options.
4630 ;; When we use a non-existing host name, we could run
4631 ;; into DNS timeouts. So we use "localhost" with an
4632 ;; improper port, expecting nobody runs sshd on the
4633 ;; telnet port.
4635 vec "ssh" nil t nil
4651 tramp-ssh-controlmaster-options)))
4654 "Maybe open a connection VEC.
4655 Does not do anything if a connection is already open, but re-opens the
4656 connection if a previous connection has died for some reason."
4664 ;; If Tramp opens the same connection within a short time frame,
4665 ;; there is a problem. We shall signal this.
4674 ;; If too much time has passed since last command was sent, look
4675 ;; whether process is still alive. If it isn't, kill it. When
4676 ;; using ssh, it can sometimes happen that the remote end has hung
4677 ;; up but the local ssh client doesn't recognize this until it
4678 ;; tries to send some data to the remote end. So that's why we
4679 ;; try to send a command from time to time, then look again
4680 ;; whether the process is really alive.
4691 ;; The error will be caught locally.
4697 ;; New connection must be opened.
4701 ;; If `non-essential' is non-nil, don't reopen a new connection.
4706 vec 3
4717 ;; Start new process.
4732 ;; We will apply `tramp-ssh-controlmaster-options'
4733 ;; only for the first hop.
4738 ;; This must be done in order to avoid our file
4739 ;; name handler.
4743 'start-process
4748 tramp-encoding-command-interactive)
4751 ;; Set sentinel and query flag.
4762 ;; Check whether process is alive.
4764 p 10
4767 ;; Now do all the connections as specified.
4797 ;; We don't create the temporary file. In
4798 ;; fact, it is just a prefix for the
4799 ;; ControlPath option of ssh; the real
4800 ;; temporary file has another name, and it is
4801 ;; created and protected by ssh. It is also
4802 ;; removed by ssh when the connection is
4803 ;; closed. The temporary file name is cached
4804 ;; in the main connection process, therefore
4805 ;; we cannot use `tramp-get-connection-process'.
4811 tramp-temp-name-prefix
4813 spec r-shell)
4815 ;; Add arguments for asynchronous processes.
4819 ;; Add gateway arguments if necessary.
4825 ;; Check for port number. Until now, there's no
4826 ;; need for handling like method, user, host.
4831 ;; Check, whether there is a restricted shell.
4836 ;; Set variables for computing the prompt for
4837 ;; reading password. They can also be derived
4838 ;; from a gateway.
4843 ;; Add login environment.
4846 login-env
4851 login-env))
4855 "%s=%s %s"
4858 command)))
4861 ;; Replace `login-args' place holders.
4869 ?h l-host ?u l-user ?p l-port ?c options)
4870 command
4872 ;; We do not want to see the trailing local
4873 ;; prompt in `start-file-process'.
4875 command " "
4881 ;; Local shell could be a Windows COMSPEC. It
4882 ;; doesn't know the ";" syntax, but we must exit
4883 ;; always for `start-file-process'. It could
4884 ;; also be a restricted shell, which does not
4885 ;; allow "exec".
4888 ;; Send the command.
4892 p vec pos tramp-actions-before-shell
4896 ;; Next hop.
4900 ;; Make initial shell settings.
4903 ;; When the user did interrupt, we must cleanup.
4906 ;; Propagate the quit signal.
4910 "Send the COMMAND to connection VEC.
4911 Erases temporary buffer before sending the command. If optional
4912 arg NEVEROPEN is non-nil, never try to open the connection. This
4913 is meant to be used from `tramp-maybe-open-connection' only. The
4914 function waits for output unless NOOUTPUT is set."
4918 ;; We mark the command string that it can be erased in the output buffer.
4920 ;; If we put `tramp-echo-mark' after a trailing newline (which
4921 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4922 ;; that newline and adds `tramp-rsh-end-of-line' right after
4923 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4924 ;; trailing line endings and sends two prompts after executing
4925 ;; the command, which confuses `tramp-wait-for-output'.
4929 ;; No need to restore a trailing newline here since `tramp-send-string'
4930 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4932 ;; Send the command.
4938 "Wait for output from remote command."
4944 ;; be leading escape sequences, which must be ignored.
4946 ;; Sometimes, the commands do not return a newline but a
4947 ;; null byte before the shell prompt, for example "git
4948 ;; ls-files -c -z ...".
4953 ;; A simple-minded busybox has sent " ^H" sequences.
4954 ;; Delete them.
4959 ;; Delete the prompt.
4965 proc 'file-error
4966 "[[Remote prompt `%s' not found in %d secs]]"
4967 tramp-end-of-output timeout)
4969 proc 'file-error
4971 ;; Return value is whether end-of-output sentinel was found.
4972 found)))
4976 "Run COMMAND and check its exit status.
4977 Sends `echo $?' along with the COMMAND for checking the exit status.
4978 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4979 status is 0, and nil otherwise.
4981 If the optional argument SUBSHELL is non-nil, the command is
4982 executed in a subshell, ie surrounded by parentheses. If
4983 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4985 vec
4987 command
4989 "echo tramp_exit_status $?"
5003 "Run COMMAND, check exit status, throw error if exit status not okay.
5004 Similar to `tramp-send-command-and-check' but accepts two more arguments
5005 FMT and ARGS which are passed to `error'."
5010 "Run COMMAND and return the output, which must be a Lisp expression.
5011 If MARKER is a regexp, read the output after that string.
5012 In case there is no valid Lisp expression and NOERROR is nil, it
5013 raises an error."
5020 ;; Read the marker.
5026 vec 'file-error
5027 "`%s' does not return the marker `%s': `%s'"
5029 ;; Read the expression.
5032 ;; Error handling.
5037 vec 'file-error
5038 "`%s' does not return a valid Lisp expression: `%s'"
5042 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5043 Convert file mode bits to string and set virtual device number.
5044 Return ATTR."
5046 ;; Remove color escape sequences from symlink.
5050 ;; Convert uid and gid. Use -1 as indication of unusable value.
5061 ;; Convert last access time.
5066 ;; Convert last modification time.
5071 ;; Convert last status change time.
5076 ;; Convert file size.
5082 ;; Convert file mode bits to string.
5087 ;; Convert directory indication bit.
5090 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5096 ;; Set file's gid change bit.
5104 ;; Convert inode.
5110 ;; Inodes can be incredible huge. We must hide this.
5112 ;; Set virtual device number.
5115 attr))
5118 "Converts STRING to shell glob pattern which ignores case."
5124 string
5128 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
5136 localname)
5142 "Return t if this is an out-of-band method, nil otherwise."
5144 ;; It shall be an out-of-band method.
5146 ;; There must be a size, otherwise the file doesn't exist.
5148 ;; Either the file size is large enough, or (in rare cases) there
5149 ;; does not exist a remote encoding.
5154 ;; Variables local to connection.
5158 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5159 ;; cache the result for the session only. Otherwise, the result
5160 ;; is cached persistently.
5163 vec)
5164 "remote-path"
5173 ;; Default if "getconf" is not available.
5176 vec 3
5181 ;; The login shell could return more than just the $PATH
5182 ;; string. So we use `tramp-end-of-heredoc' as marker.
5185 vec
5191 'identity
5198 ;; Replace place holder `tramp-default-remote-path'.
5206 ;; Replace place holder `tramp-own-remote-path'.
5214 ;; Remove double entries.
5221 ;; Remove non-existing directories.
5223 nil
5233 x))
5234 x))
5235 remote-path)))))
5241 locale)
5248 candidates nil)
5250 ;; Return value.
5260 result)
5262 ;; Check parameters. On busybox, "ls" output coloring is
5263 ;; enabled by default sometimes. So we try to disable it
5264 ;; when possible. $LS_COLORING is not supported there.
5265 ;; Some "ls" versions are sensible wrt the order of
5266 ;; arguments, they fail when "-al" is after the
5267 ;; "--color=never" argument (for example on FreeBSD).
5282 ;; Some "ls" versions are sensible wrt the order of arguments,
5283 ;; they fail when "-al" is after the "--dired" argument (for
5284 ;; example on FreeBSD).
5292 ;; Some "ls" versions are sensible wrt the order of arguments,
5293 ;; they fail when "-al" is after the "--dired" argument (for
5294 ;; example on FreeBSD).
5303 "test"
5307 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5308 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5309 ;; for otherwise the shell crashes.
5321 vec
5344 ;; We must check also for some Perl modules.
5352 result)))
5359 tmp)
5360 ;; Check whether stat(1) returns usable syntax. "%s" does not
5361 ;; work on older AIX systems.
5370 result)))
5380 result))))
5396 ;; Busyboxes do support the "-t" option only when they have been
5397 ;; built with the DESKTOP config option. Let's check it.
5400 vec "touch-t"
5402 vec
5404 "%s -t %s %s"
5405 result
5409 result)))
5428 result)
5430 ;; Check POSIX parameter.
5437 vec
5446 vec
5450 "print $>"
5462 vec
5466 "import os; print (os.getuid())"
5480 ;; Ensure there is a valid result.
5488 vec
5497 vec
5506 vec
5510 "import os; print (os.getgid())"
5524 ;; Ensure there is a valid result.
5530 ;; Some predefined connection properties.
5532 "Return the compress command related to PROP.
5533 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5534 the length of the file to be compressed.
5536 If no corresponding command is found, nil is returned."
5545 "Return the coding command related to PROP.
5546 PROP is either `remote-encoding', `remote-decoding',
5547 `local-encoding' or `local-decoding'.
5549 SIZE is the length of the file to be coded. Depending on SIZE,
5550 compression might be applied.
5552 If no corresponding command is found, nil is returned.
5553 Otherwise, either a string is returned which contains a `%s' mark
5554 to be used for the respective input or output file; or a Lisp
5555 function cell is returned to be applied on a buffer."
5556 ;; We must catch the errors, because we want to return nil, when
5557 ;; no inline coding is found.
5567 compress)
5568 ;; The connection property might have been cached. So we must
5569 ;; send the script to the remote side - maybe.
5577 ;; Check for the `compress' command.
5579 ;; Return the value.
5599 'call-process-region beg end
5604 coding)
5607 ;; Windows shells need the program file name after
5608 ;; the pipe symbol be quoted if they use forward
5609 ;; slashes as directory separators.
5616 coding compress))
5619 ;; Windows shells need the program file name after
5620 ;; the pipe symbol be quoted if they use forward
5621 ;; slashes as directory separators.
5626 compress coding))
5640 ;;; TODO:
5642 ;; * Don't use globbing for directories with many files, as this is
5643 ;; likely to produce long command lines, and some shells choke on
5644 ;; long command lines.
5645 ;; * Make it work for different encodings, and for different file name
5646 ;; encodings, too. (Daniel Pittman)
5647 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5648 ;; then look if it's the right version (with `perl -v').
5649 ;; * When editing a remote CVS controlled file as a different user, VC
5650 ;; gets confused about the file locking status. Try to find out why
5651 ;; the workaround doesn't work.
5652 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5653 ;; until the last but one hop via `start-file-process'. Apply it
5654 ;; also for ftp and smb.
5655 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5656 ;; some shell with root privileges, it would be nice if I could
5657 ;; just call
5658 ;; trampclient filename.c
5659 ;; as an editor, and the _current_ shell would connect to an Emacs
5660 ;; server and would be used in an existing non-privileged Emacs
5661 ;; session for doing the editing in question.
5662 ;; That way, I need not tell Emacs my password again and be afraid
5663 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5664 ;; once display a just typed password in the context of a keyboard
5665 ;; sequence prompt for a question immediately following in a shell
5666 ;; script run within Emacs -- nasty).
5667 ;; And if I have some ssh session running to a different computer,
5668 ;; having the possibility of passing a local file there to a local
5669 ;; Emacs session (in case I can arrange for a connection back) would
5670 ;; be nice.
5671 ;; Likely the corresponding Tramp server should not allow the
5672 ;; equivalent of the emacsclient -eval option in order to make this
5673 ;; reasonably unproblematic. And maybe trampclient should have some
5674 ;; way of passing credentials, like by using an SSL socket or
5675 ;; something. (David Kastrup)
5676 ;; * Reconnect directly to a compliant shell without first going
5677 ;; through the user's default shell. (Pete Forman)
5678 ;; * How can I interrupt the remote process with a signal
5679 ;; (interrupt-process seems not to work)? (Markus Triska)
5680 ;; * Avoid the local shell entirely for starting remote processes. If
5681 ;; so, I think even a signal, when delivered directly to the local
5682 ;; SSH instance, would correctly be propagated to the remote process
5683 ;; automatically; possibly SSH would have to be started with
5684 ;; "-t". (Markus Triska)
5685 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5686 ;; isn't on the remote host. (Mark A. Hershberger)
5687 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5688 ;; * Optimize out-of-band copying when both methods are scp-like (not
5689 ;; rsync).
5690 ;; * Keep a second connection open for out-of-band methods like scp or
5691 ;; rsync.
5693 ;;; tramp-sh.el ends here