| blob | 90b84b27950017974b4dbd36f85de814b85d99cc |
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.
884 while read file; do
887 else
889 fi
892 else
894 fi
895 done
897 "Script to check existence of VC related files.
898 It must be send formatted with two strings; the tests for file
899 existence, and file readability. Input shall be read via
900 here-document, otherwise the command could exceed maximum length
903 ;; New handlers should be added here.
907 ;; `byte-compiler-base-file-name' performed by default handler.
912 ;; `diff-latest-backup-file' performed by default handler.
916 . tramp-sh-handle-directory-files-and-attributes)
917 ;; `dired-call-process' performed by default handler.
920 . tramp-sh-handle-dired-recursive-delete-directory)
927 ;; `file-equal-p' performed by default handler.
930 ;; `file-in-directory-p' performed by default handler.
938 ;; `file-name-sans-versions' performed by default handler.
951 ;; `find-file-noselect' performed by default handler.
952 ;; `get-file-buffer' performed by default handler.
956 . tramp-sh-handle-insert-file-contents-literally)
975 "Alist of handler functions.
978 ;; This must be the last entry, because `identity' always matches.
979 ;;;###tramp-autoload
983 ;;; File Name Handler Functions:
987 "Like `make-symbolic-link' for Tramp files.
988 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
989 the symlink. If LINKNAME is a Tramp file, only the localname component is
990 used as the target of the symlink.
992 If LINKNAME is a Tramp file and the localname component is relative, then
993 it is expanded first, before the localname component is taken. Note that
994 this can give surprising results if the user/host for the source and
995 target of the symlink differ."
1002 l 'file-error
1005 ;; Do the 'confirm if exists' thing.
1007 ;; What to do?
1012 "File %s already exists; make it a link anyway? "
1013 l-localname)))))
1018 ;; If FILENAME is a Tramp name, use just the localname component.
1027 ;; Right, they are on the same host, regardless of user, method,
1028 ;; etc. We now make the link on the remote machine. This will
1029 ;; occur as the user that FILENAME belongs to.
1031 l
1033 "cd %s && %s -sf %s %s"
1035 ln
1038 t))))
1041 "Like `file-truename' for Tramp files."
1043 "%s%s"
1046 method user host
1051 ;; Use GNU readlink --canonicalize-missing where available.
1054 v
1062 ;; Use Perl implementation.
1070 v
1074 ;; Do it yourself. We bind `directory-sep-char' here for
1075 ;; XEmacs on Windows, which would otherwise use backslash.
1083 ;; Don't make the following value larger than
1084 ;; necessary. People expect an error message in
1085 ;; a timely fashion when something is wrong;
1086 ;; otherwise they might think that Emacs is hung.
1087 ;; Of course, correctness has to come first.
1089 symlink-target)
1100 method user host
1112 ;; It's a symlink, follow it.
1118 ;; If the symlink was absolute, we'll get a
1119 ;; string like "/user@host:/some/target";
1120 ;; extract the "/some/target" part from it.
1124 v 'file-error
1125 "Symlink target `%s' on wrong host"
1126 symlink-target))
1131 steps)))
1133 ;; It's a file.
1137 v 'file-error
1140 ;; Combine list to form string.
1151 result))))
1153 ;; Preserve trailing "/".
1156 ;; Basic functions.
1159 "Like `file-exists-p' for Tramp files."
1167 v
1169 "%s %s"
1174 "Like `file-attributes' for Tramp files."
1177 ;; Don't modify `last-coding-system-used' by accident.
1184 v
1192 ;; The scripts could fail, for example with huge file size.
1196 "Implement `file-attributes' for Tramp files using the ls(1) command."
1198 res-inode res-filemodes res-numlinks
1199 res-uid res-gid res-size res-symlink-target)
1202 vec
1209 ;; On systems which have no quoting style, file names
1210 ;; with special characters could fail.
1215 ;; Parse `ls -l' output ...
1219 ;; ... inode
1235 ;; ... file mode flags
1237 ;; ... number links
1239 ;; ... uid and gid
1249 ;; ... size
1251 ;; From the file modes, figure out other stuff.
1254 ;; If symlink, find out file name pointed to.
1261 ;; Return data gathered.
1263 ;; 0. t for directory, string (name linked to) for symbolic
1264 ;; link, or nil.
1266 ;; 1. Number of links to file.
1267 res-numlinks
1268 ;; 2. File uid.
1269 res-uid
1270 ;; 3. File gid.
1271 res-gid
1272 ;; 4. Last access time, as a list of integers. Normally this
1273 ;; would be in the same format as `current-time', but the
1274 ;; subseconds part is not currently implemented, and (0 0)
1275 ;; denotes an unknown time.
1276 ;; 5. Last modification time, likewise.
1277 ;; 6. Last status change time, likewise.
1279 ;; 7. Size in bytes (-1, if number is out of range).
1280 res-size
1281 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1282 res-filemodes
1283 ;; 9. t if file's gid would change if file were deleted and
1284 ;; recreated. Will be set in `tramp-convert-file-attributes'.
1285 t
1286 ;; 10. Inode number.
1287 res-inode
1288 ;; 11. Device number. Will be replaced by a virtual device number.
1289 -1
1290 )))))
1294 "Implement `file-attributes' for Tramp files using a Perl script."
1299 vec
1305 "Implement `file-attributes' for Tramp files using stat(1) command."
1308 vec
1311 ;; On Opsware, pdksh (which is the true name of ksh there)
1312 ;; doesn't parse correctly the sequence "((". Therefore, we add
1313 ;; a space. Apostrophes in the stat output are masked as
1314 ;; `tramp-stat-marker', in order to make a proper shell escape of
1315 ;; them in file names.
1316 "( (%s %s || %s -h %s) && (%s -c "
1317 "'((%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1324 tramp-stat-marker tramp-stat-marker
1329 tramp-stat-marker tramp-stat-marker
1331 tramp-stat-quoted-marker)))
1334 "Like `set-visited-file-modtime' for Tramp files."
1341 coding-system-used)
1345 ;; '(-1 65535) means file doesn't exists yet.
1349 ;; We use '(0 0) as a don't-know value. See also
1350 ;; `tramp-do-file-attributes-with-ls'.
1355 v
1364 nil)))))
1366 ;; This function makes the same assumption as
1367 ;; `tramp-sh-handle-set-visited-file-modtime'.
1369 "Like `verify-visited-file-modtime' for Tramp files.
1370 At the time `verify-visited-file-modtime' calls this function, we
1371 already know that the buffer is visiting a file and that
1372 `visited-file-modtime' does not return 0. Do not call this
1373 function directly, unless those two cases are already taken care
1374 of."
1377 ;; There is no file visiting the buffer, or the buffer has no
1378 ;; recorded last modification time, or there is no established
1379 ;; connection.
1383 t
1391 ;; File exists, and has a known modtime.
1394 modtime
1395 ;; For compatibility, deal with both the old
1396 ;; (HIGH . LOW) and the new (HIGH LOW) return
1397 ;; values of `visited-file-modtime'.
1400 mt)))
1402 ;; Modtime has the don't know value.
1405 v
1412 attr
1415 ;; If file does not exist, say it is not modified if and
1416 ;; only if that agrees with the buffer's record.
1420 "Like `set-file-modes' for Tramp files."
1424 ;; FIXME: extract the proper text from chmod's stderr.
1426 v
1433 "Like `set-file-times' for Tramp files."
1441 time))
1442 ;; With GNU Emacs, `format-time-string' has an
1443 ;; optional parameter UNIVERSAL. This is preferred,
1444 ;; because we could handle the case when the remote
1445 ;; host is located in a different time zone as the
1446 ;; local host.
1450 "%s %s %s %s"
1461 ;; We handle also the local part, because in older Emacsen,
1462 ;; without `set-file-times', this function is an alias for this.
1463 ;; We are local, so we don't need the UTC settings.
1471 "Set the ownership for FILENAME.
1472 If UID and GID are provided, these values are used; otherwise uid
1473 and gid of the corresponding user is taken. Both parameters must
1474 be non-negative integers."
1475 ;; Modern Unices allow chown only for root. So we might need
1476 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1477 ;; working with su(do)? when it is needed, so it shall succeed in
1478 ;; the majority of cases.
1479 ;; Don't modify `last-coding-system-used' by accident.
1484 ;; If we are root on the local host, we can do it directly.
1492 "chown %d:%d %s" uid gid
1495 ;; We handle also the local part, because there doesn't exist
1496 ;; `set-file-uid-gid'. On W32 "chown" might not work. We add a
1497 ;; timeout for this.
1502 nil "chown" nil nil nil
1506 "Check, whether SELINUX is enabled on the remote host."
1511 "Like `file-selinux-context' for Tramp files."
1520 "%s -d -Z %s"
1528 ;; Return the context.
1529 context))))
1532 "Like `set-file-selinux-context' for Tramp files."
1552 t)))))
1555 "Check, whether ACL is enabled on the remote host."
1560 "Like `file-acl' for Tramp files."
1566 "getfacl -ac %s"
1576 "Like `set-file-acl' for Tramp files."
1583 tramp-end-of-heredoc
1584 acl-string
1585 tramp-end-of-heredoc))
1587 ;; Success.
1590 t)
1591 ;; In case of errors, we return nil.
1593 nil)))
1595 ;; Simple functions using the `test' command.
1598 "Like `file-executable-p' for Tramp files."
1601 ;; Examine `file-attributes' cache to see if request can be
1602 ;; satisfied without remote operation.
1607 "Like `file-readable-p' for Tramp files."
1610 ;; Examine `file-attributes' cache to see if request can be
1611 ;; satisfied without remote operation.
1615 ;; When the remote shell is started, it looks for a shell which groks
1616 ;; tilde expansion. Here, we assume that all shells which grok tilde
1617 ;; expansion will also provide a `test' command which groks `-nt' (for
1618 ;; newer than). If this breaks, tell me about it and I'll try to do
1619 ;; something smarter about it.
1621 "Like `file-newer-than-file-p' for Tramp files."
1623 nil)
1625 t)
1626 ;; We are sure both files exist at this point.
1629 ;; We try to get the mtime of both files. If they are not
1630 ;; equal to the "dont-know" value, then we subtract the times
1631 ;; and obtain the result.
1637 ;; If one of them is the dont-know value, then we can
1638 ;; still try to run a shell command on the remote host.
1639 ;; However, this only works if both files are Tramp
1640 ;; files and both have the same method, same user, same
1641 ;; host.
1646 v 'file-error
1647 "Files %s and %s must have same method, user, host"
1648 file1 file2)))
1653 ;; Functions implemented using the basic functions above.
1656 "Like `file-directory-p' for Tramp files."
1658 ;; `file-directory-p' is used as predicate for file name completion.
1659 ;; Sometimes, when a connection is not established yet, it is
1660 ;; desirable to return t immediately for "/method:foo:". It can
1661 ;; be expected that this is always a directory.
1667 "Like `file-writable-p' for Tramp files."
1671 ;; Examine `file-attributes' cache to see if request can be
1672 ;; satisfied without remote operation.
1675 ;; If file doesn't exist, check if directory is writable.
1680 "Like `file-ownership-preserved-p' for Tramp files."
1684 ;; Return t if the file doesn't exist, since it's true that no
1685 ;; information would be lost by an (attempted) delete and create.
1692 ;; Directory listings.
1696 "Like `directory-files-and-attributes' for Tramp files."
1704 v localname
1715 v localname id-format))
1718 v localname id-format))
1720 result item)
1730 result
1732 ;; The scripts could fail, for example with huge file size.
1734 directory full match nosort id-format)))))
1738 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1741 vec tramp-perl-directory-files-and-attributes
1745 vec
1749 object))
1753 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1756 vec
1759 ;; We must care about file names with spaces, or starting with
1760 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1761 ;; but it does not work on all remote systems. Apostrophes in
1762 ;; the stat output are masked as `tramp-stat-marker', in order to
1763 ;; make a proper shell escape of them in file names.
1765 "xargs %s -c "
1766 "'(%s%%n%s (%s%%N%s) %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 %s%%A%s t %%ie0 -1)' "
1770 ;; On systems which have no quoting style, file names with
1771 ;; special characters could fail.
1775 tramp-stat-marker tramp-stat-marker
1776 tramp-stat-marker tramp-stat-marker
1781 tramp-stat-marker tramp-stat-marker
1782 tramp-stat-quoted-marker)))
1784 ;; This function should return "foo/" for directories and "bar" for
1785 ;; files.
1787 "Like `file-name-all-completions' for Tramp files."
1792 filename
1794 'list
1796 ;; Try cache entries for `filename', `filename' with last
1797 ;; character removed, `filename' with last two characters
1798 ;; removed, ..., and finally the empty string - all
1799 ;; concatenated to the local directory name.
1802 tramp-completion-reread-directory-timeout)))
1804 ;; This is inefficient for very long file names, pity
1805 ;; `reduce' is not available...
1808 'append
1813 v
1815 "file-name-all-completions"
1816 nil)))
1818 ;; We cannot use a length of 0, because file properties
1819 ;; for "foo" and "foo/" are identical.
1822 ;; Cache expired or no matching cache entry found so we need
1823 ;; to perform a remote operation.
1825 ;; Get a list of directories and files, including reliably
1826 ;; tagging the directories with a trailing '/'. Because I
1827 ;; rock. --daniel@danann.net
1829 ;; Changed to perform `cd' in the same remote op and only
1830 ;; get entries starting with `filename'. Capture any `cd'
1831 ;; error messages. Ensure any `cd' and `echo' aliases are
1832 ;; ignored.
1834 v
1838 v tramp-perl-file-name-all-completions
1844 ;; `read-file-name-completion-ignore-case'
1845 ;; is introduced with Emacs 22.1.
1848 'read-file-name-completion-ignore-case
1853 "(cd %s 2>&1 && (%s -a %s 2>/dev/null"
1854 ;; `ls' with wildcard might fail with `Argument
1855 ;; list too long' error in some corner cases; if
1856 ;; `ls' fails after `cd' succeeded, chances are
1857 ;; that's the case, so let's retry without
1858 ;; wildcard. This will return "too many" entries
1859 ;; but that isn't harmful.
1860 " || %s -a 2>/dev/null)"
1861 " | while IFS= read f; do"
1867 ;; When `filename' is empty, just `ls' without
1868 ;; `filename' argument is more efficient than `ls *'
1869 ;; for very large directories and might avoid the
1870 ;; `Argument list too long' error.
1871 ;;
1872 ;; With and only with wildcard, we need to add
1873 ;; `-d' to prevent `ls' from descending into
1874 ;; sub-directories.
1876 "."
1881 ;; Now grab the output.
1885 ;; Check result code, found in last line of output.
1889 ;; Grab error message from line before last line
1890 ;; (it was put there by `cd 2>&1').
1893 v 'file-error
1894 "tramp-sh-handle-file-name-all-completions: %s"
1896 ;; For peace of mind, if buffer doesn't end in `fail'
1897 ;; then it should end in `ok'. If neither are in the
1898 ;; buffer something went seriously wrong on the remote
1899 ;; side.
1902 v 'file-error
1903 "\
1904 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1910 ;; Because the remote op went through OK we know the
1911 ;; directory we `cd'-ed to exists.
1914 ;; Because the remote op went through OK we know every
1915 ;; file listed by `ls' exists.
1919 result)
1921 ;; Store result in the cache.
1926 ;; cp, mv and ln
1930 "Like `add-name-to-file' for Tramp files."
1935 v 'file-error
1936 "add-name-to-file: %s"
1945 "File %s already exists; make it a new name anyway? "
1946 newname)))
1953 v1
1957 "error with add-name-to-file, see buffer `%s' for details"
1962 preserve-uid-gid preserve-extended-attributes)
1963 "Like `copy-file' for Tramp files."
1967 ;; At least one file a Tramp file?
1971 'copy filename newname ok-if-already-exists keep-date
1972 preserve-uid-gid preserve-extended-attributes))
1973 ;; Compat section.
1976 'copy-file
1978 preserve-uid-gid preserve-extended-attributes)))
1981 'copy-file
1989 "Like `copy-directory' for Tramp files."
1995 ;; When DIRNAME and NEWNAME are remote, they must have
1996 ;; the same method.
2002 ;; scp or rsync DTRT.
2016 ;; We must do it file-wise.
2018 'copy-directory
2023 ;; When newname did exist, we have wrong cached values.
2031 "Like `rename-file' for Tramp files."
2032 ;; Check if both files are local -- invoke normal rename-file.
2033 ;; Otherwise, use Tramp from local system.
2036 ;; At least one file a Tramp file?
2046 preserve-uid-gid preserve-extended-attributes)
2047 "Copy or rename a remote file.
2048 OP must be `copy' or `rename' and indicates the operation to perform.
2049 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2050 the new file (for copy) or the new name of the file (for rename).
2051 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2052 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2053 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2054 the uid and gid if both files are on the same host.
2055 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2057 This function is invoked by `tramp-sh-handle-copy-file' and
2058 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2059 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2060 file names."
2077 filename newname)
2080 ;; Both are Tramp files.
2085 ;; Shortcut: if method, host, user are the same for
2086 ;; both files, we invoke `cp' or `mv' on the remote
2087 ;; host directly.
2090 op filename newname
2091 ok-if-already-exists keep-date preserve-uid-gid))
2093 ;; Try out-of-band operation.
2098 op filename newname keep-date))
2100 ;; No shortcut was possible. So we copy the file
2101 ;; first. If the operation was `rename', we go back
2102 ;; and delete the original file (if the copy was
2103 ;; successful). The approach is simple-minded: we
2104 ;; create a new buffer, insert the contents of the
2105 ;; source file into it, then write out the buffer to
2106 ;; the target file. The advantage is that it doesn't
2107 ;; matter which file name handlers are used for the
2108 ;; source and target file.
2111 op filename newname keep-date))))))
2113 ;; One file is a Tramp file, the other one is local.
2116 ;; Fast track on local machine.
2119 op filename newname
2120 ok-if-already-exists keep-date preserve-uid-gid))
2122 ;; If the Tramp file has an out-of-band method, the
2123 ;; corresponding copy-program can be invoked.
2126 op filename newname keep-date))
2128 ;; Use the inline method via a Tramp buffer.
2130 op filename newname keep-date))))
2133 ;; One of them must be a Tramp file.
2136 ;; Handle `preserve-extended-attributes'. We ignore possible
2137 ;; errors, because ACL strings could be incompatible.
2142 ;; In case of `rename', we must flush the cache of the source file.
2148 ;; When newname did exist, we have wrong cached values.
2155 "Use an Emacs buffer to copy or rename a file.
2156 First arg OP is either `copy' or `rename' and indicates the operation.
2157 FILENAME is the source file, NEWNAME the target file.
2158 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2159 ;; We must disable multibyte, because binary data shall not be
2160 ;; converted. We don't want the target file to be compressed, so we
2161 ;; let-bind `jka-compr-inhibit' to t. `epa-file-handler' shall not
2162 ;; be called either. We remove `tramp-file-name-handler' from
2163 ;; `inhibit-file-name-handlers'; otherwise the file name handler for
2164 ;; `insert-file-contents' might be deactivated in some corner cases.
2175 ;; KEEP-DATE handling.
2177 ;; Set the mode.
2179 ;; If the operation was `rename', delete the original file.
2184 "Invokes `cp' or `mv' on the remote system.
2185 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2186 respectively. FILENAME specifies the file to copy or rename,
2187 NEWNAME is the name of the new file (for copy) or the new name of
2188 the file (for rename). Both files must reside on the same host.
2189 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2190 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2191 the uid and gid from FILENAME."
2201 v 'file-error
2202 "Unknown operation `%s', must be `copy' or `rename'"
2203 op))))
2207 filename))
2211 newname))
2213 cmd-result)
2216 ;; Both files are on a remote host, with same user.
2228 ;; Mask cp -f error.
2230 tramp-operation-not-permitted-regexp nil t))
2231 cmd-result)
2233 nil v 'file-error
2234 "Copying directly failed, see buffer `%s' for details."
2237 ;; We are on the local host.
2240 ;; We can do it directly.
2243 ;; No sticky bit when renaming.
2254 localname1 localname2 ok-if-already-exists
2255 keep-date preserve-uid-gid)
2259 ;; We can do it directly with `tramp-send-command'
2267 ok-if-already-exists keep-date t)
2268 ;; We must change the ownership to the local user.
2274 ;; We need a temporary file in between.
2276 ;; Create the temporary file.
2284 "%s %s %s" cmd
2287 "Copying directly failed, see buffer `%s' for details."
2289 ;; We must change the ownership as remote user.
2290 ;; Since this does not work reliable, we also
2291 ;; give read permissions.
2302 localname1 tmpfile t
2303 keep-date preserve-uid-gid)
2305 'rename-file
2307 ;; We must change the ownership as local user.
2308 ;; Since this does not work reliable, we also
2309 ;; give read permissions.
2313 tmpfile
2317 ;; Move the temporary file to its destination.
2322 "cp -f -p %s %s"
2325 "Copying directly failed, see buffer `%s' for details."
2329 'rename-file
2332 ;; Save exit.
2335 ;; Set the time and mode. Mask possible errors.
2342 "Invoke `scp' program to copy.
2343 The method used must be an out-of-band method."
2347 copy-program copy-args copy-env copy-keep-date port listener spec
2348 options source target remote-copy-program remote-copy-args)
2353 ;; Both are Tramp files. We shall optimize it when the
2354 ;; methods for FILENAME and NEWNAME are the same.
2364 op filename tmpfile keep-date)
2367 ;; Save exit.
2374 ;; Set variables for computing the prompt for reading
2375 ;; password.
2382 ;; Expand hops. Might be necessary for gateway methods.
2386 ;; Check which ones of source and target are Tramp files.
2395 'file-name-directory
2401 ;; Check for host and port number. We cannot use
2402 ;; `tramp-file-name-port', because this returns also
2403 ;; `tramp-default-port', which might clash with settings in
2404 ;; "~/.ssh/config".
2411 ;; Check for user. There might be an interactive setting.
2415 ;; Check for listener port.
2422 ;; Compose copy command.
2431 ?h host ?u user ?p port ?r listener ?c options
2437 copy-args
2439 ;; " " has either been a replacement of "%k" (when
2440 ;; keep-date argument is non-nil), or a replacement
2441 ;; for the whole keep-date sublist.
2442 " "
2447 copy-args
2451 copy-env
2453 nil
2460 remote-copy-program
2466 remote-copy-args
2470 ;; Check for local copy program.
2475 ;; Install listener on the remote side. The prompt must be
2476 ;; consumed later on, when the process does not listen anymore.
2483 v 'file-error
2487 'identity
2495 v 'file-error
2496 "Listener process not running on remote host: `%s'"
2497 remote-copy-program))
2505 ;; The default directory must be remote.
2509 ;; Set the transfer process properties.
2519 copy-args
2521 copy-args
2526 ;; Use an asynchronous process. By this, password can
2527 ;; be handled. We don't set a timeout, because the
2528 ;; copying of large files can last longer than 60
2529 ;; secs.
2533 copy-program
2535 copy-args
2544 ;; We must adapt `tramp-local-end-of-line' for
2545 ;; sending the password.
2548 p v nil tramp-actions-copy-out-of-band))
2550 ;; Check the return code.
2555 orig-vec 'file-error
2556 "Couldn't find exit status of `%s'"
2562 orig-vec 'file-error
2563 "Error copying: `%s'"
2566 ;; Reset the transfer process properties.
2569 ;; Clear the remote prompt.
2572 ;; Houston, we have a problem! Likely, the listener is
2573 ;; still running, so let's clear everything (but the
2574 ;; cached password).
2577 ;; Handle KEEP-DATE argument.
2581 ;; Set the mode.
2586 ;; If the operation was `rename', delete the original file.
2593 "Like `make-directory' for Tramp files."
2605 "Like `delete-directory' for Tramp files."
2617 "Like `delete-file' for Tramp files."
2628 ;; Dired.
2630 ;; CCC: This does not seem to be enough. Something dies when
2631 ;; we try and delete two directories under Tramp :/
2633 "Recursively delete the directory given.
2634 This is like `dired-recursive-delete-directory' for Tramp files."
2636 ;; Run a shell command 'rm -r <localname>'.
2637 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2640 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2642 v
2644 ;; Don't read the output, do it explicitly.
2645 nil t)
2646 ;; Wait for the remote system to return to us...
2647 ;; This might take a while, allow it plenty of time.
2649 ;; Make sure that it worked...
2657 "Like `dired-compress-file' for Tramp files."
2658 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2659 ;; Code stolen mainly from dired-aux.el.
2665 ;; Emacs case
2667 ;; XEmacs has `dired-compression-method-alist', which is
2668 ;; transformed into `dired-compress-file-suffixes' structure.
2672 nil
2675 suffix)
2676 ;; See if any suffix rule matches this file name.
2684 nil)
2686 ;; We found an uncompression rule.
2692 ;; `dired-remove-file' is not defined in XEmacs.
2697 ;; We don't recognize the file as compressed, so compress it.
2698 ;; Try gzip.
2703 ;; `dired-remove-file' is not defined in XEmacs.
2713 "Like `insert-directory' for Tramp files."
2720 filename switches wildcard full-directory-p)
2740 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2741 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2744 v
2747 switches
2749 localname
2752 v
2756 "Couldn't `cd %s'"
2760 v
2763 switches
2768 ""
2776 ;; We cannot use `insert-buffer-substring' because the Tramp
2777 ;; buffer changes its contents before insertion due to calling
2778 ;; `expand-file' and alike.
2783 ;; Check for "--dired" output.
2790 ;; Now read the numeric positions of file names.
2796 ;; End is followed by \n or by " -> ".
2798 ;; Remove trailing lines.
2804 ;; Some busyboxes are reluctant to discard colors.
2811 ;; Decode the output, it could be multibyte.
2818 ;; The inserted file could be from somewhere else.
2825 "."
2832 ;; Canonicalization of file names.
2835 "Like `expand-file-name' for Tramp files.
2837 the result will be a local, non-Tramp, file name."
2838 ;; If DIR is not given, use `default-directory' or "/".
2840 ;; Unless NAME is absolute, concat DIR and NAME.
2843 ;; If NAME is not a Tramp file, run the real handler.
2846 ;; Dissect NAME.
2850 ;; Tilde expansion if necessary. This needs a shell which
2851 ;; groks tilde expansion! The function `tramp-find-shell' is
2852 ;; supposed to find such a shell on the remote host. Please
2853 ;; tell me about it when this doesn't work on your system.
2857 ;; We cannot simply apply "~/", because under sudo "~/" is
2858 ;; expanded to the local user home directory but to the
2859 ;; root home directory. On the other hand, using always
2860 ;; the default user name for tilde expansion is not
2861 ;; appropriate either, because ssh and companions might
2862 ;; use a user name from the config file.
2874 ;; There might be a double slash, for example when "~/"
2875 ;; expands to "/". Remove this.
2878 ;; No tilde characters in file name, do normal
2879 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2880 ;; `directory-sep-char' here for XEmacs on Windows, which would
2881 ;; otherwise use backslash. `default-directory' is bound,
2882 ;; because on Windows there would be problems with UNC shares or
2883 ;; Cygwin mounts.
2887 method user host
2891 hop)))))
2893 ;;; Remote commands:
2896 "Flush file caches."
2904 ;; We use BUFFER also as connection buffer during setup. Because of
2905 ;; this, its original contents must be saved, and restored once
2906 ;; connection has been setup.
2908 "Like `start-file-process' for Tramp files."
2911 ;; it might be that the arguments exceed the command line
2912 ;; length. Therefore, we modify the command.
2917 ;; When PROGRAM is nil, we just provide a tty.
2923 args
2927 ;; Use a human-friendly prompt, for example for `shell'.
2928 ;; We discard hops, if existing, that's why we cannot use
2929 ;; `file-remote-p'.
2936 tramp-initial-end-of-output))
2937 ;; We use as environment the difference to toplevel
2938 ;; `process-environment'.
2939 env
2944 env)
2963 ;; We do not want to raise an error when
2964 ;; `start-file-process' has been started several times in
2965 ;; `eshell' and friends.
2969 ;; BUFFER can be nil. We use a temporary buffer.
2972 ;; NAME must be unique as process name.
2976 ;; Set the new process properties.
2982 ;; We catch this event. Otherwise, `start-process' could
2983 ;; be called on the local host.
2986 ;; Activate narrowing in order to save BUFFER
2987 ;; contents. Clear also the modification time;
2988 ;; otherwise we might be interrupted by
2989 ;; `verify-visited-file-modtime'.
2995 ;; We call `tramp-maybe-open-connection', in order
2996 ;; to cleanup the prompt afterwards.
3002 ;; Now do it.
3004 ;; Send the command.
3006 ;; Check, whether a pty is associated.
3010 v 'file-error
3013 ;; Set query flag and process marker for this
3014 ;; process. We ignore errors, because the process
3015 ;; could have finished already.
3019 ;; Return process.
3020 p))))
3022 ;; Save exit.
3033 "Like `process-file' for Tramp files."
3034 ;; The implementation is not complete yet.
3040 ;; Compute command.
3043 ;; We use as environment the difference to toplevel `process-environment'.
3051 "env %s %s"
3053 ;; Determine input.
3058 ;; INFILE is on the same remote host.
3060 ;; INFILE must be copied to remote host.
3066 ;; Determine output.
3068 ;; Just a buffer.
3071 ;; A buffer name.
3074 ;; (REAL-DESTINATION ERROR-DESTINATION)
3076 ;; output.
3084 ;; stderr.
3089 ;; stderr is on the same remote host.
3092 ;; stderr must be copied to remote host. The temporary
3093 ;; file must be deleted after execution.
3096 method user host stderr))))
3097 ;; stderr to be discarded.
3100 ;; 't
3105 ;; Send the command. It might not return in time, so we protect
3106 ;; it. Call it in a subshell, in order to preserve working
3107 ;; directory.
3114 command)
3115 t t)
3117 ;; We should add the output anyway.
3124 ;; When the user did interrupt, we should do it also. We use
3125 ;; return code -1 as marker.
3129 ;; Handle errors.
3134 ;; Provide error file.
3137 ;; Cleanup. We remove all file cache values for the connection,
3138 ;; because the remote process could have changed them.
3141 ;; `process-file-side-effects' has been introduced with GNU
3142 ;; Emacs 23.2. If set to nil, no remote file will be changed
3143 ;; by `program'. If it doesn't exist, we assume its default
3144 ;; value t.
3149 ;; Return exit status.
3152 ret))))
3155 "Like `file-local-copy' for Tramp files."
3159 v 'file-error
3169 ;; `copy-file' handles direct copy and out-of-band methods.
3174 ;; Use inline encoding for file transfer.
3178 v 3
3186 tmpfile loc-dec)
3188 ;; If local decoding is a function, we call it.
3189 ;; We must disable multibyte, because
3190 ;; `uudecode-decode-region' doesn't handle it
3191 ;; correctly. Unset `file-name-handler-alist'.
3192 ;; Otherwise, epa-file gets confused.
3200 ;; If tramp-decoding-function is not defined for this
3201 ;; method, we invoke tramp-decoding-command instead.
3203 ;; Unset `file-name-handler-alist'. Otherwise,
3204 ;; epa-file gets confused.
3212 loc-dec tmpfile2 tmpfile)
3215 ;; Set proper permissions.
3217 ;; Set local user ownership.
3220 ;; Oops, I don't know what to do.
3224 ;; Error handling.
3230 tmpfile)))
3232 ;; This is needed for XEmacs only. Code stolen from files.el.
3235 "Like `insert-file-contents-literally' for Tramp files."
3243 nil))
3251 ;; Save exit.
3256 ;; CCC grok LOCKNAME
3259 "Like `write-region' for Tramp files."
3262 ;; Following part commented out because we don't know what to do about
3263 ;; file locking, and it does not appear to be a problem to ignore it.
3264 ;; Ange-ftp ignores it, too.
3265 ;; (when (and lockname (stringp lockname))
3266 ;; (setq lockname (expand-file-name lockname)))
3267 ;; (unless (or (eq lockname nil)
3268 ;; (string= lockname filename))
3269 ;; (error
3270 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3272 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3283 ;; `file-writable-p' calls `file-expand-file-name'. We
3284 ;; cannot use `tramp-run-real-handler' therefore.
3290 ;; Short track: if we are on the local host, we can run directly.
3292 'write-region
3296 ;; We use this to save the value of
3297 ;; `last-coding-system-used' after writing the tmp
3298 ;; file. At the end of the function, we set
3299 ;; `last-coding-system-used' to this saved value. This
3300 ;; way, any intermediary coding systems used while
3301 ;; talking to the remote shell or suchlike won't hose
3302 ;; this variable. This approach was snarfed from
3303 ;; ange-ftp.el.
3304 coding-system-used
3305 ;; Write region into a tmp file. This isn't really
3306 ;; needed if we use an encoding function, but currently
3307 ;; we use it always because this makes the logic
3308 ;; simpler. We must also set `temporary-file-directory',
3309 ;; because it could point to a remote directory.
3315 ;; If `append' is non-nil, we copy the file locally, and let
3316 ;; the native `write-region' implementation do the job.
3319 ;; We say `no-message' here because we don't want the
3320 ;; visited file modtime data to be clobbered from the temp
3321 ;; file. We call `set-visited-file-modtime' ourselves later
3322 ;; on. We must ensure that `file-coding-system-alist'
3323 ;; matches `tmpfile'.
3329 'write-region
3336 ;; Now, `last-coding-system-used' has the right value. Remember it.
3341 ;; The permissions of the temporary file should be set. If
3342 ;; FILENAME does not exist (eq modes nil) it has been
3343 ;; renamed to the backup file. This case `save-buffer'
3344 ;; handles permissions.
3345 ;; Ensure that it is still readable.
3348 tmpfile
3351 ;; This is a bit lengthy due to the different methods
3352 ;; possible for file transfer. First, we check whether the
3353 ;; method uses an scp program. If so, we call it.
3354 ;; Otherwise, both encoding and decoding command must be
3355 ;; specified. However, if the method _also_ specifies an
3356 ;; encoding function, then that is used for encoding the
3357 ;; contents of the tmp file.
3362 ;; `copy-file' handles direct copy and out-of-band methods.
3372 ;; We keep the local file for performance
3373 ;; reasons, useful for "rsync".
3380 ;; Don't rename, in order to keep context in SELinux.
3385 ;; Use inline file transfer.
3387 ;; Encode tmpfile.
3391 ;; Use encoding function or command.
3394 tmpfile loc-enc)
3396 ;; The following `let' is a workaround for
3397 ;; the base64.el that comes with pgnus-0.84.
3398 ;; If both of the following conditions are
3399 ;; satisfied, it tries to write to a local
3400 ;; file in default-directory, but at this
3401 ;; point, default-directory is remote.
3402 ;; (`call-process-region' can't write to
3403 ;; remote files, it seems.) The file in
3404 ;; question is a tmp file anyway.
3412 loc-enc tmpfile t))
3414 v 'file-error
3417 filename loc-enc))))
3419 ;; Send buffer into remote decoding command which
3420 ;; writes to remote file. Because this happens on
3421 ;; the remote host, we cannot use the function.
3424 filename rem-dec)
3428 v
3432 tramp-end-of-heredoc
3434 tramp-end-of-heredoc))
3436 v nil
3437 "Couldn't write region to `%s', decode using `%s' failed"
3438 filename rem-dec)
3439 ;; When `file-precious-flag' is set, the region is
3440 ;; written to a temporary file. Check that the
3441 ;; checksum is equal to that from the local tmpfile.
3445 ;; cksum runs locally, if possible.
3447 ;; cksum runs remotely.
3449 v
3452 ;; ... they are different.
3459 v 'file-error
3462 filename rem-dec)))))
3464 ;; Save exit.
3467 ;; That's not expected.
3470 v 'file-error
3473 method))))
3475 ;; Make `last-coding-system-used' have the right value.
3482 ;; We must protect `last-coding-system-used', now we have set it
3483 ;; to its correct value.
3485 ;; Set file modification time.
3489 ;; We must pass modtime explicitly, because FILENAME can
3490 ;; be different from (buffer-file-name), f.e. if
3491 ;; `file-precious-flag' is set.
3497 ;; Set the ownership.
3507 ;; VC backends check for the existence of various different special
3508 ;; files. This is very time consuming, because every single check
3509 ;; requires a remote command (the file cache must be invalidated).
3510 ;; Therefore, we apply a kind of optimization. We install the file
3511 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3512 ;; remembers all file names for which `file-exists-p' or
3513 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3514 ;; is performed. Afterwards, a script is applied for all collected
3515 ;; file names, using just one remote command. The result of this
3516 ;; script is used to fill the file cache with actual values. Now we
3517 ;; can reset the file name handlers, and we make a second run of
3518 ;; `vc-registered', which returns the expected result without sending
3519 ;; any other remote command.
3521 "Like `vc-registered' for Tramp files."
3527 ;; There could be new files, created by the vc backend. We
3528 ;; cannot reuse the old cache entries, therefore. In
3529 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3530 ;; could also be a timestamp as `current-time' returns. This
3531 ;; means invalidate all cache entries with an older timestamp.
3537 ;; Here we collect only file names, which need an operation.
3541 ;; Send just one command, in order to fill the cache.
3544 v
3553 ;; We cannot use `tramp-send-command-and-read',
3554 ;; because this does not cooperate well with
3555 ;; heredoc documents.
3557 v
3560 tramp-end-of-heredoc
3562 tramp-vc-registered-file-names
3564 tramp-end-of-heredoc))
3566 ;; Read the expression.
3573 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3574 ;; calls shall be answered from the file cache. We unset
3575 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3576 ;; in order to keep the cache.
3578 remote-file-name-inhibit-cache process-file-side-effects)
3579 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3598 ;; Run.
3602 ;;;###tramp-autoload
3604 "Invoke remote-shell Tramp file name handler.
3605 Fall back to normal file name handler if no Tramp handler exists."
3623 "Invoke special file name handler, which collects files to be handled."
3631 ;; That's what we want: file names, for which checks are
3632 ;; applied. We assume that VC uses only `file-exists-p' and
3633 ;; `file-readable-p' checks; otherwise we must extend the
3634 ;; list. We do not perform any action, but return nil, in
3635 ;; order to keep `vc-registered' running.
3638 nil)
3639 ;; `process-file' and `start-file-process' shall be ignored.
3642 ;; Tramp file name handlers like `expand-file-name'. They
3643 ;; must still work.
3645 ;; Default file name handlers, we don't care.
3649 "Like `file-notify-add-watch' for Tramp files."
3653 command events filter p sequence)
3655 ;; gvfs-monitor-dir.
3659 ;; inotifywait.
3662 events
3669 ;; None.
3671 v 'file-notify-error
3672 "No file notification program found on %s"
3674 ;; Start process.
3676 'start-file-process
3680 sequence))
3681 ;; Return the process object as watch-descriptor.
3684 v 'file-notify-error
3685 "`%s' failed to start on remote host"
3691 p))))
3703 ;; Attribute change is returned in unused wording.
3713 string)
3716 proc
3720 ;; File names are returned as absolute paths. We must
3721 ;; add the remote prefix.
3726 ;; Usually, we would add an Emacs event now. Unfortunately,
3727 ;; `unread-command-events' does not accept several events at
3728 ;; once. Therefore, we apply the callback directly.
3731 ;; Save rest of the string.
3740 ;; Check, whether there is a problem.
3746 line)
3751 proc
3758 ;; Usually, we would add an Emacs event now. Unfortunately,
3759 ;; `unread-command-events' does not accept several events at
3760 ;; once. Therefore, we apply the callback directly.
3763 ;;; Internal Functions:
3766 "Define in remote shell function NAME implemented as SCRIPT.
3767 Only send the definition if it has not already been done."
3768 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3769 ;; might be nil.
3774 ;; In bash, leading TABs like in `tramp-vc-registered-read-file-names'
3775 ;; could result in unwanted command expansion. Avoid this.
3778 ;; The script could contain a call of Perl. This is masked with `%s'.
3783 vec
3791 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3792 Returns the exit code of the `test' program."
3795 v
3797 "%s %s %s"
3799 switch
3803 "Run `test'-like program on the remote system, given FILE1, FILE2.
3804 FORMAT-STRING contains the program name, switches, and place holders.
3805 Returns the exit code of the `test' program. Barfs if the methods,
3806 hosts, or files, disagree."
3810 v 'file-error
3815 v1
3822 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3823 First arg VEC specifies the connection, PROGNAME is the program
3824 to search for, and DIRLIST gives the list of directories to
3825 search. If IGNORE-TILDE is non-nil, directory names starting
3826 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3827 only in DIRLIST.
3829 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3831 This function expects to be in the right *tramp* buffer."
3834 ;; Check whether the executable is in $PATH. "which(1)" does not
3835 ;; report always a correct error code; therefore we check the
3836 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3837 ;; 5.11") have problems with this command, we disable the call
3838 ;; therefore.
3849 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3850 ;; `remove' is in CL, and we want to avoid CL dependencies.
3859 vec
3861 "do if test -x $d/%s && test -f $d/%s; "
3862 "then echo tramp_executable $d/%s; "
3865 progname progname progname
3866 tramp-end-of-heredoc
3868 tramp-end-of-heredoc))
3874 result)))
3877 "Sets the remote environment PATH to existing directories.
3878 I.e., for each directory in `tramp-remote-path', it is tested
3879 whether it exists and if so, it is added to the environment
3880 variable PATH."
3886 ;; ------------------------------------------------------------
3887 ;; -- Communication with external shell --
3888 ;; ------------------------------------------------------------
3891 "Find a command on the remote host for checking if a file exists.
3892 Here, we are looking for a command which has zero exit status if the
3893 file exists and nonzero exit status otherwise."
3897 result)
3898 ;; The algorithm is as follows: we try a list of several commands.
3899 ;; For each command, we first run `$cmd /' -- this should return
3900 ;; true, as the root directory always exists. And then we run
3901 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3902 ;; does not exist. This should return false. We use the first
3903 ;; command we find that seems to work.
3904 ;; The list of commands to try is as follows:
3905 ;; `ls -d' This works on most systems, but NetBSD 1.4
3906 ;; has a bug: `ls' always returns zero exit
3907 ;; status, even for files which don't exist.
3908 ;; `test -e' Some Bourne shells have a `test' builtin
3909 ;; which does not know the `-e' option.
3910 ;; `/bin/test -e' For those, the `test' binary on disk normally
3911 ;; provides the option. Alas, the binary
3912 ;; is sometimes `/bin/test' and sometimes it's
3913 ;; `/usr/bin/test'.
3914 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3942 result))
3945 "Opens shell SHELL."
3948 ;; Find arguments for this shell.
3950 item extra-args)
3955 ;; It is useful to set the prompt in the following command
3956 ;; because some people have a setting for $PS1 which /bin/sh
3957 ;; doesn't know about and thus /bin/sh will display a strange
3958 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3959 ;; ksh will display the current working directory but /bin/sh
3960 ;; will display a dollar sign. The following command line sets
3961 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3962 ;; well as csh-like shells. We also unset the variable $ENV
3963 ;; because that is read by some sh implementations (eg, bash
3964 ;; when called as sh) on startup; this way, we avoid the startup
3965 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3966 ;; the prompt in /bin/bash, it must be discarded as well.
3967 ;; $HISTFILE is set according to `tramp-histfile-override'.
3970 "exec env ENV='' %s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3975 "HISTFILE='' HISTFILESIZE=0 HISTSIZE=0"
3979 t))
3984 "Opens a shell on the remote host which groks tilde expansion."
3987 shell)
3990 ;; CCC: "root" does not exist always, see QNAP 459.
3991 ;; Which check could we apply instead?
3994 ;; The default shell (ksh93) of OpenSolaris and
3995 ;; Solaris is buggy. We've got reports for
3996 ;; "SunOS 5.10" and "SunOS 5.11" so far.
4005 ;; Maybe it works at least for some other commands.
4007 default-shell
4009 vec 2
4011 "Couldn't find a remote shell which groks tilde "
4013 default-shell)))
4015 default-shell)))
4017 ;; Open a new shell if needed.
4023 ;; Utility functions.
4026 "Wait for shell prompt and barf if none appears.
4027 Looks at process PROC to see if a shell prompt appears in TIMEOUT
4028 seconds. If not, it produces an error message with the given ERROR-ARGS."
4032 proc timeout
4041 "Set up an interactive shell.
4042 Mainly sets the prompt and the echo correctly. PROC is the shell
4043 process to set up. VEC specifies the connection."
4047 ;; Disable tab and echo expansion.
4050 ;; Check whether the echo has really been disabled. Some
4051 ;; implementations, like busybox of embedded GNU/Linux, don't
4052 ;; support disabling.
4059 ;; Make sure backspaces and their echo are enabled and no line
4060 ;; width magic interferes with them.
4068 ;; Try to set up the coding system correctly.
4069 ;; CCC this can't be the right way to do it. Hm.
4073 ;; Use MULE to select the right EOL convention for communicating
4074 ;; with the process.
4080 cs-decode cs-encode)
4097 ;; Look for ^M and do something useful if found.
4099 ;; We have found a ^M but cannot frob the process coding system
4100 ;; because we're running on a non-MULE Emacs. Let's try
4101 ;; stty, instead.
4106 ;; Check whether the output of "uname -sr" has been changed. If
4107 ;; yes, this is a strong indication that we must expire all
4108 ;; connection properties. We start again with
4109 ;; `tramp-maybe-open-connection', it will be caught there.
4114 vec "uname"
4118 vec 3
4119 "Connection reset, because remote host changed from `%s' to `%s'"
4120 old-uname new-uname)
4121 ;; We want to keep the password.
4125 ;; Check whether the remote host suffers from buggy
4126 ;; `send-process-string'. This is known for FreeBSD (see comment in
4127 ;; `send_process', file process.c). I've tested sending 624 bytes
4128 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4129 ;; this host type is detected locally. It cannot handle remote
4130 ;; hosts, though.
4134 tramp-chunksize)
4142 ;; Set remote PATH variable.
4145 ;; Search for a good shell before searching for a command which
4146 ;; checks if a file exists. This is done because Tramp wants to use
4147 ;; "test foo; echo $?" to check if various conditions hold, and
4148 ;; there are buggy /bin/sh implementations which don't execute the
4149 ;; "echo $?" part if the "test" part has an error. In particular,
4150 ;; the OpenSolaris /bin/sh is a problem. There are also other
4151 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4152 ;; in function declarations, or changing HISTFILE in place.
4153 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4154 ;; detected.
4157 ;; Disable unexpected output.
4160 ;; IRIX64 bash expands "!" even when in single quotes. This
4161 ;; destroys our shell functions, we must disable it. See
4162 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4166 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4171 ;; Set `remote-tty' process property.
4176 ;; Dump stty settings in the traces.
4180 ;; Set the environment.
4185 unset vars item)
4195 vec
4197 tramp-end-of-heredoc
4199 tramp-end-of-heredoc)
4200 t))
4205 ;; Old text from documentation of tramp-methods:
4206 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4207 ;; of the base64 methods instead since base64 encoding is much more
4208 ;; reliable and the commands are more standardized between the different
4209 ;; Unix versions. But if you can't use base64 for some reason, please
4210 ;; note that the default uudecode command does not work well for some
4211 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4212 ;; the following command for uudecode:
4213 ;;
4214 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4215 ;;
4216 ;; For Irix, no solution is known yet.
4224 "List of local coding commands for inline transfer.
4225 Each item is a list that looks like this:
4227 \(FORMAT ENCODING DECODING\)
4229 FORMAT is symbol describing the encoding/decoding format. It can be
4230 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4232 ENCODING and DECODING can be strings, giving commands, or symbols,
4233 giving functions. If they are strings, then they can contain
4235 file name will be put into the command line at that spot. If the
4236 specifier is not present, the input should be read from standard
4237 input.
4239 If they are functions, they will be called with two arguments, start
4240 and end of region, and are expected to replace the region contents
4245 ;; "-i" is more robust with older base64 from GNU coreutils.
4246 ;; However, I don't know whether all base64 versions do supports
4247 ;; this option.
4259 "List of remote coding commands for inline transfer.
4260 Each item is a list that looks like this:
4262 \(FORMAT ENCODING DECODING [TEST]\)
4264 FORMAT is a symbol describing the encoding/decoding format. It can be
4265 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4267 ENCODING and DECODING can be strings, giving commands, or symbols,
4268 giving variables. If they are strings, then they can contain
4270 file name will be put into the command line at that spot. If the
4271 specifier is not present, the input should be read from standard
4272 input.
4274 If they are variables, this variable is a string containing a
4275 Perl or Shell implementation for this functionality. This
4276 program will be transferred to the remote host, and it is
4278 specifier in the variable value denotes a temporary file.
4280 The optional TEST command can be used for further tests, whether
4284 "Find an inline transfer encoding that works.
4285 Goes through the list `tramp-local-coding-commands' and
4286 `tramp-remote-coding-commands'."
4291 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4299 ;; If the local encoder or decoder is a string, the
4300 ;; corresponding command has to work locally.
4307 loc-enc nil nil))
4315 loc-dec nil nil))
4317 ;; Search for remote coding commands with the same format
4325 ;; Check the remote test command if exists.
4331 ;; Check if remote perl exists when necessary.
4335 ;; Check if remote encoding and decoding commands can be
4336 ;; called remotely with null input and output. This makes
4337 ;; sure there are no syntax errors and the command is really
4338 ;; found. Note that we do not redirect stdout to /dev/null,
4339 ;; for two reasons: when checking the decoding command, we
4340 ;; actually check the output it gives. And also, when
4341 ;; redirecting "mimencode" output to /dev/null, then as root
4342 ;; it might change the permissions of /dev/null!
4350 vec 5
4359 tmpfile)
4366 tramp-temp-name-prefix
4368 value
4370 value
4372 ?t
4378 vec 5
4381 vec
4383 t)
4391 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4397 ;; Set connection properties. Since the commands are risky
4398 ;; (due to output direction), we cache them in the process cache.
4409 "Call the local encoding or decoding command.
4411 Otherwise, INPUT is passed via standard input.
4412 INPUT can also be nil which means `/dev/null'.
4413 OUTPUT can be a string (which specifies a file name), or t (which
4414 means standard output and thus the current buffer), or nil (which
4415 means discard it)."
4417 nil tramp-encoding-shell
4420 nil
4421 tramp-encoding-command-switch
4431 "List of compress and decompress commands for inline transfer.
4432 Each item is a list that looks like this:
4434 \(COMPRESS DECOMPRESS\)
4439 "Find an inline transfer compress command that works.
4440 Goes through the list `tramp-inline-compress-commands'."
4445 item compress decompress found)
4452 vec 5
4453 "Checking local compress commands `%s', `%s' for sanity"
4454 compress decompress)
4459 ;; Windows shells need the program file name after
4460 ;; the pipe symbol be quoted if they use forward
4461 ;; slashes as directory separators.
4468 vec 5
4469 "Checking remote compress commands `%s', `%s' for sanity"
4470 compress decompress)
4476 ;; Did we find something?
4479 ;; Set connection properties. Since the commands are
4480 ;; risky (due to output direction), we cache them in the
4481 ;; process cache.
4495 "Expands VEC according to `tramp-default-proxies-alist'.
4496 Gateway hops are already opened."
4500 choices proxy)
4502 ;; Ad-hoc proxy definitions.
4507 tramp-prefix-format proxy tramp-postfix-host-format)))
4512 proxy)
4513 ;; Add the hop.
4515 'tramp-default-proxies-alist
4518 proxy))
4520 ;; Save the new value.
4525 ;; Look for proxy hosts to be passed.
4531 ;; Host.
4534 ;; User.
4538 ;; No more hops needed.
4540 ;; Replace placeholders.
4543 proxy
4548 ;; Add the hop.
4550 ;; Start next search.
4553 ;; Handle gateways.
4561 ;; Is the method prepared for gateways?
4564 vec 'file-error
4566 ;; Open the gateway connection.
4571 target-alist)
4572 ;; For the password prompt, we need the correct values.
4573 ;; Therefore, we must remember the gateway vector. But we
4574 ;; cannot do it as connection property, because it shouldn't
4575 ;; be persistent. And we have no started process yet either.
4579 ;; Foreign and out-of-band methods are not supported for multi-hops.
4586 vec 'file-error
4587 "Method `%s' is not supported for multi-hops."
4590 ;; In case the host name is not used for the remote shell
4591 ;; command, the user could be misguided by applying a random
4592 ;; host name.
4598 ;; There are multi-hops.
4600 ;; The host name is used for the remote shell command.
4602 ;; The host is local. We cannot use `tramp-local-host-p'
4603 ;; here, because it opens a connection as well.
4606 v 'file-error
4607 "Host `%s' looks like a remote host, `%s' can only use the local host"
4608 host method)))
4610 ;; Result.
4611 target-alist))
4614 "Return the Control* arguments of the local ssh."
4616 ;; No options to be computed.
4621 ;; There is already a value to be used.
4624 ;; Determine the options.
4636 ;; We use a non-existing IP address, in order to avoid
4637 ;; useless connections, and DNS timeouts.
4644 " -o ControlPath='tramp.%%r@%%h:%%p'"
4653 tramp-ssh-controlmaster-options)))
4656 "Maybe open a connection VEC.
4657 Does not do anything if a connection is already open, but re-opens the
4658 connection if a previous connection has died for some reason."
4666 ;; If Tramp opens the same connection within a short time frame,
4667 ;; there is a problem. We shall signal this.
4676 ;; If too much time has passed since last command was sent, look
4677 ;; whether process is still alive. If it isn't, kill it. When
4678 ;; using ssh, it can sometimes happen that the remote end has hung
4679 ;; up but the local ssh client doesn't recognize this until it
4680 ;; tries to send some data to the remote end. So that's why we
4681 ;; try to send a command from time to time, then look again
4682 ;; whether the process is really alive.
4693 ;; The error will be caught locally.
4699 ;; New connection must be opened.
4703 ;; If `non-essential' is non-nil, don't reopen a new connection.
4708 vec 3
4719 ;; Start new process.
4734 ;; We will apply `tramp-ssh-controlmaster-options'
4735 ;; only for the first hop.
4740 ;; This must be done in order to avoid our file
4741 ;; name handler.
4745 'start-process
4750 tramp-encoding-command-interactive)
4753 ;; Set sentinel and query flag.
4764 ;; Check whether process is alive.
4766 p 10
4769 ;; Now do all the connections as specified.
4795 ;; We don't create the temporary file. In
4796 ;; fact, it is just a prefix for the
4797 ;; ControlPath option of ssh; the real
4798 ;; temporary file has another name, and it is
4799 ;; created and protected by ssh. It is also
4800 ;; removed by ssh when the connection is
4801 ;; closed. The temporary file name is cached
4802 ;; in the main connection process, therefore
4803 ;; we cannot use `tramp-get-connection-process'.
4809 tramp-temp-name-prefix
4811 spec r-shell)
4813 ;; Add arguments for asynchronous processes.
4817 ;; Add gateway arguments if necessary.
4823 ;; Check for port number. Until now, there's no
4824 ;; need for handling like method, user, host.
4829 ;; Check, whether there is a restricted shell.
4834 ;; Set variables for computing the prompt for
4835 ;; reading password. They can also be derived
4836 ;; from a gateway.
4841 ;; Add login environment.
4844 login-env
4849 login-env))
4853 "%s=%s %s"
4856 command)))
4859 ;; Replace `login-args' place holders.
4867 ?h l-host ?u l-user ?p l-port ?c options)
4868 command
4870 ;; We do not want to see the trailing local
4871 ;; prompt in `start-file-process'.
4873 command " "
4879 ;; Local shell could be a Windows COMSPEC. It
4880 ;; doesn't know the ";" syntax, but we must exit
4881 ;; always for `start-file-process'. It could
4882 ;; also be a restricted shell, which does not
4883 ;; allow "exec".
4886 ;; Send the command.
4890 p vec pos tramp-actions-before-shell
4894 ;; Next hop.
4898 ;; Make initial shell settings.
4901 ;; When the user did interrupt, we must cleanup.
4904 ;; Propagate the quit signal.
4908 "Send the COMMAND to connection VEC.
4909 Erases temporary buffer before sending the command. If optional
4910 arg NEVEROPEN is non-nil, never try to open the connection. This
4911 is meant to be used from `tramp-maybe-open-connection' only. The
4912 function waits for output unless NOOUTPUT is set."
4916 ;; We mark the command string that it can be erased in the output buffer.
4918 ;; If we put `tramp-echo-mark' after a trailing newline (which
4919 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4920 ;; that newline and adds `tramp-rsh-end-of-line' right after
4921 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4922 ;; trailing line endings and sends two prompts after executing
4923 ;; the command, which confuses `tramp-wait-for-output'.
4927 ;; No need to restore a trailing newline here since `tramp-send-string'
4928 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4930 ;; Send the command.
4936 "Wait for output from remote command."
4942 ;; be leading escape sequences, which must be ignored.
4944 ;; Sometimes, the commands do not return a newline but a
4945 ;; null byte before the shell prompt, for example "git
4946 ;; ls-files -c -z ...".
4951 ;; A simple-minded busybox has sent " ^H" sequences.
4952 ;; Delete them.
4957 ;; Delete the prompt.
4963 proc 'file-error
4964 "[[Remote prompt `%s' not found in %d secs]]"
4965 tramp-end-of-output timeout)
4967 proc 'file-error
4969 ;; Return value is whether end-of-output sentinel was found.
4970 found)))
4974 "Run COMMAND and check its exit status.
4975 Sends `echo $?' along with the COMMAND for checking the exit status.
4976 If COMMAND is nil, just sends `echo $?'. Returns t if the exit
4977 status is 0, and nil otherwise.
4979 If the optional argument SUBSHELL is non-nil, the command is
4980 executed in a subshell, ie surrounded by parentheses. If
4981 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4983 vec
4985 command
4987 "echo tramp_exit_status $?"
5001 "Run COMMAND, check exit status, throw error if exit status not okay.
5002 Similar to `tramp-send-command-and-check' but accepts two more arguments
5003 FMT and ARGS which are passed to `error'."
5008 "Run COMMAND and return the output, which must be a Lisp expression.
5009 If MARKER is a regexp, read the output after that string.
5010 In case there is no valid Lisp expression and NOERROR is nil, it
5011 raises an error."
5018 ;; Read the marker.
5024 vec 'file-error
5025 "`%s' does not return the marker `%s': `%s'"
5027 ;; Read the expression.
5030 ;; Error handling.
5035 vec 'file-error
5036 "`%s' does not return a valid Lisp expression: `%s'"
5040 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
5041 Convert file mode bits to string and set virtual device number.
5042 Return ATTR."
5044 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
5050 ;; Remove color escape sequences and double slashes from symlink.
5056 ;; Convert uid and gid. Use -1 as indication of unusable value.
5067 ;; Convert last access time.
5072 ;; Convert last modification time.
5077 ;; Convert last status change time.
5082 ;; Convert file size.
5088 ;; Convert file mode bits to string.
5093 ;; Convert directory indication bit.
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 for `scp', `pscp', or `nc' and workalikes."
5139 localname)
5145 "Return t if this is an out-of-band method, nil otherwise."
5147 ;; It shall be an out-of-band method.
5149 ;; There must be a size, otherwise the file doesn't exist.
5151 ;; Either the file size is large enough, or (in rare cases) there
5152 ;; does not exist a remote encoding.
5157 ;; Variables local to connection.
5161 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5162 ;; cache the result for the session only. Otherwise, the result
5163 ;; is cached persistently.
5166 vec)
5167 "remote-path"
5176 ;; Default if "getconf" is not available.
5179 vec 3
5184 ;; The login shell could return more than just the $PATH
5185 ;; string. So we use `tramp-end-of-heredoc' as marker.
5188 vec
5193 'identity
5197 'identity
5203 ;; Replace place holder `tramp-default-remote-path'.
5211 ;; Replace place holder `tramp-own-remote-path'.
5219 ;; Remove double entries.
5226 ;; Remove non-existing directories.
5228 nil
5238 x))
5239 x))
5240 remote-path)))))
5246 locale)
5253 candidates nil)
5255 ;; Return value.
5265 result)
5267 ;; Check parameters. On busybox, "ls" output coloring is
5268 ;; enabled by default sometimes. So we try to disable it
5269 ;; when possible. $LS_COLORING is not supported there.
5270 ;; Some "ls" versions are sensible wrt the order of
5271 ;; arguments, they fail when "-al" is after the
5272 ;; "--color=never" argument (for example on FreeBSD).
5287 ;; Some "ls" versions are sensible wrt the order of arguments,
5288 ;; they fail when "-al" is after the "--dired" argument (for
5289 ;; example on FreeBSD).
5297 ;; Some "ls" versions are sensible wrt the order of arguments,
5298 ;; they fail when "-al" is after the "--dired" argument (for
5299 ;; example on FreeBSD).
5308 "test"
5312 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5313 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5314 ;; for otherwise the shell crashes.
5326 vec
5349 ;; We must check also for some Perl modules.
5357 result)))
5364 tmp)
5365 ;; Check whether stat(1) returns usable syntax. "%s" does not
5366 ;; work on older AIX systems.
5375 result)))
5385 result))))
5401 ;; Busyboxes do support the "-t" option only when they have been
5402 ;; built with the DESKTOP config option. Let's check it.
5405 vec "touch-t"
5407 vec
5409 "%s -t %s %s"
5410 result
5414 result)))
5433 result)
5435 ;; Check POSIX parameter.
5442 vec
5451 vec
5455 "print $>"
5467 vec
5471 "import os; print (os.getuid())"
5485 ;; Ensure there is a valid result.
5493 vec
5502 vec
5511 vec
5515 "import os; print (os.getgid())"
5529 ;; Ensure there is a valid result.
5535 ;; Some predefined connection properties.
5537 "Return the compress command related to PROP.
5538 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5539 the length of the file to be compressed.
5541 If no corresponding command is found, nil is returned."
5550 "Return the coding command related to PROP.
5551 PROP is either `remote-encoding', `remote-decoding',
5552 `local-encoding' or `local-decoding'.
5554 SIZE is the length of the file to be coded. Depending on SIZE,
5555 compression might be applied.
5557 If no corresponding command is found, nil is returned.
5558 Otherwise, either a string is returned which contains a `%s' mark
5559 to be used for the respective input or output file; or a Lisp
5560 function cell is returned to be applied on a buffer."
5561 ;; We must catch the errors, because we want to return nil, when
5562 ;; no inline coding is found.
5572 compress)
5573 ;; The connection property might have been cached. So we must
5574 ;; send the script to the remote side - maybe.
5582 ;; Check for the `compress' command.
5584 ;; Return the value.
5609 coding)
5612 ;; Windows shells need the program file name after
5613 ;; the pipe symbol be quoted if they use forward
5614 ;; slashes as directory separators.
5621 coding compress))
5624 ;; Windows shells need the program file name after
5625 ;; the pipe symbol be quoted if they use forward
5626 ;; slashes as directory separators.
5631 compress coding))
5645 ;;; TODO:
5647 ;; * Don't use globbing for directories with many files, as this is
5648 ;; likely to produce long command lines, and some shells choke on
5649 ;; long command lines.
5650 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5651 ;; then look if it's the right version (with `perl -v').
5652 ;; * When editing a remote CVS controlled file as a different user, VC
5653 ;; gets confused about the file locking status. Try to find out why
5654 ;; the workaround doesn't work.
5655 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5656 ;; until the last but one hop via `start-file-process'. Apply it
5657 ;; also for ftp and smb.
5658 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5659 ;; some shell with root privileges, it would be nice if I could
5660 ;; just call
5661 ;; trampclient filename.c
5662 ;; as an editor, and the _current_ shell would connect to an Emacs
5663 ;; server and would be used in an existing non-privileged Emacs
5664 ;; session for doing the editing in question.
5665 ;; That way, I need not tell Emacs my password again and be afraid
5666 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5667 ;; once display a just typed password in the context of a keyboard
5668 ;; sequence prompt for a question immediately following in a shell
5669 ;; script run within Emacs -- nasty).
5670 ;; And if I have some ssh session running to a different computer,
5671 ;; having the possibility of passing a local file there to a local
5672 ;; Emacs session (in case I can arrange for a connection back) would
5673 ;; be nice.
5674 ;; Likely the corresponding Tramp server should not allow the
5675 ;; equivalent of the emacsclient -eval option in order to make this
5676 ;; reasonably unproblematic. And maybe trampclient should have some
5677 ;; way of passing credentials, like by using an SSL socket or
5678 ;; something. (David Kastrup)
5679 ;; * Reconnect directly to a compliant shell without first going
5680 ;; through the user's default shell. (Pete Forman)
5681 ;; * How can I interrupt the remote process with a signal
5682 ;; (interrupt-process seems not to work)? (Markus Triska)
5683 ;; * Avoid the local shell entirely for starting remote processes. If
5684 ;; so, I think even a signal, when delivered directly to the local
5685 ;; SSH instance, would correctly be propagated to the remote process
5686 ;; automatically; possibly SSH would have to be started with
5687 ;; "-t". (Markus Triska)
5688 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5689 ;; isn't on the remote host. (Mark A. Hershberger)
5690 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5691 ;; * Optimize out-of-band copying when both methods are scp-like (not
5692 ;; rsync).
5693 ;; * Keep a second connection open for out-of-band methods like scp or
5694 ;; rsync.
5696 ;;; tramp-sh.el ends here