| blob | 1c6f0844be0164e9c7a5b38efddfe1a41961127f |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2011 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:
33 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
34 ;; not sure at all that this is the right way to do it, but let's hope
35 ;; it works for now, and wait for a guru to point out the Right Way to
36 ;; achieve this.
37 ;;(eval-when-compile
38 ;; (unless (fboundp 'dired-insert-set-properties)
39 ;; (fset 'dired-insert-set-properties 'ignore)))
40 ;; Gerd suggests this:
42 ;; Note that dired is required at run-time, too, when it is needed.
43 ;; It is only needed on XEmacs for the function
44 ;; `dired-insert-set-properties'.
47 "*The minimum size of compressing where inline transfer.
48 When inline transfer, compress transfered data of file
49 whose size is this value or above (up to `tramp-copy-size-limit').
50 If it is nil, no compression at all will be applied."
55 "*The maximum file size where inline copying is preferred over an out-of-the-band copy.
56 If it is nil, inline 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."
72 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
73 ;; root users. It uses the `$' character for other users. In order
74 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
78 "///%s#$"
80 "String used to recognize end of output.
81 The '$' character at the end is quoted; the string cannot be
84 ;;;###tramp-autoload
88 ;; Initialize `tramp-methods' with the supported methods.
89 ;;;###tramp-autoload
99 ;;;###tramp-autoload
108 ;;;###tramp-autoload
123 ;;;###tramp-autoload
139 ;;;###tramp-autoload
155 ;;;###tramp-autoload
175 ;;;###tramp-autoload
192 ;;;###tramp-autoload
200 ;;;###tramp-autoload
212 ;;;###tramp-autoload
226 "ssh"
227 " -o ControlPath=%t.%%r@%%h:%%p"
232 ;;;###tramp-autoload
238 ;;;###tramp-autoload
244 ;;;###tramp-autoload
255 ;;;###tramp-autoload
267 ;;;###tramp-autoload
279 ;;;###tramp-autoload
292 ;;;###tramp-autoload
299 ;;;###tramp-autoload
305 ;;;###tramp-autoload
311 ;;;###tramp-autoload
317 ;;;###tramp-autoload
323 ;;;###tramp-autoload
331 ;;;###tramp-autoload
339 ;;;###tramp-autoload
343 ;; ("%h") must be a single element, see
344 ;; `tramp-compute-multi-hops'.
347 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
348 tramp-terminal-type
349 tramp-initial-end-of-output))
352 ;;;###tramp-autoload
365 ;;;###tramp-autoload
377 ;;;###tramp-autoload
387 ;;;###tramp-autoload
391 ;;;###tramp-autoload
395 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
396 ;;;###tramp-autoload
406 ;;;###tramp-autoload
412 ;;;###tramp-autoload
428 ;;;###tramp-autoload
433 ;;;###tramp-autoload
438 ;;;###tramp-autoload
444 ;;;###tramp-autoload
483 ;; "getconf PATH" yields:
484 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
485 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
486 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
487 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
488 ;; IRIX64: /usr/bin
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'."
523 "*List of environment variables to be set on the remote host.
525 Each element should be a string of the form ENVVARNAME=VALUE. An
526 entry ENVVARNAME= diables the corresponding environment variable,
527 which might have been set in the init files like ~/.profile.
529 Special handling is applied to the PATH environment, which should
530 not be set here. Instead, it should be set via `tramp-remote-path'."
535 "*Alist specifying extra arguments to pass to the remote shell.
536 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
537 matching the shell file name and ARGS is a string specifying the
538 arguments.
540 This variable is only used when Tramp needs to start up another shell
541 for tilde expansion. The extra arguments should typically prevent the
542 shell from reading its init file."
544 ;; This might be the wrong way to test whether the widget type
545 ;; `alist' is available. Who knows the right way to test it?
560 "List of pattern/action pairs.
561 Whenever a pattern matches, the corresponding action is performed.
562 Each item looks like (PATTERN ACTION).
564 The PATTERN should be a symbol, a variable. The value of this
565 variable gives the regular expression to search for. Note that the
567 appended to it.
569 The ACTION should also be a symbol, but a function. When the
577 "List of pattern/action pairs.
578 This list is used for copying/renaming with out-of-band methods.
583 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
584 cat /tmp/tramp.$$
585 rm -f /tmp/tramp.$$"
586 "Shell function to implement `uudecode' to standard output.
587 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
588 for this or `uudecode -p', but some systems don't, and for them
592 "%s -e '
593 use File::Spec;
596 sub recursive {
597 my ($volume, @dirs) = @_;
598 my $real = realpath(File::Spec->catpath(
600 if ($real) {
601 my ($vol, $dir) = File::Spec->splitpath($real, 1);
602 return ($vol, File::Spec->splitdir($dir));
603 }
604 else {
605 my $last = pop(@dirs);
606 ($volume, @dirs) = recursive($volume, @dirs);
607 push(@dirs, $last);
608 return ($volume, @dirs);
609 }
610 }
612 $result = realpath($ARGV[0]);
613 if (!$result) {
614 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
615 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
618 }
622 }
626 "Perl script to produce output suitable for use with `file-truename'
627 on the remote file system.
628 Escape sequence %s is replaced with name of Perl binary.
632 "%s -e 'sub case {
633 my $str = shift;
634 if ($ARGV[2]) {
635 return lc($str);
636 }
637 else {
638 return $str;
639 }
640 }
642 @files = readdir(d); closedir(d);
643 foreach $f (@files) {
644 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
647 }
648 else {
650 }
651 }
652 }
655 "Perl script to produce output suitable for use with
656 `file-name-all-completions' on the remote file system. Escape
657 sequence %s is replaced with name of Perl binary. This string is
660 ;; Perl script to implement `file-attributes' in a Lisp `read'able
661 ;; output. If you are hacking on this, note that you get *no* output
662 ;; unless this spits out a complete line, including the '\n' at the
663 ;; end.
664 ;; The device number is returned as "-1", because there will be a virtual
665 ;; device number set in `tramp-sh-handle-file-attributes'.
667 "%s -e '
668 @stat = lstat($ARGV[0]);
669 if (!@stat) {
671 exit 0;
672 }
673 if (($stat[2] & 0170000) == 0120000)
674 {
675 $type = readlink($ARGV[0]);
677 }
678 elsif (($stat[2] & 0170000) == 040000)
679 {
681 }
682 else
683 {
685 };
688 printf(
690 $type,
691 $stat[3],
692 $uid,
693 $gid,
694 $stat[8] >> 16 & 0xffff,
695 $stat[8] & 0xffff,
696 $stat[9] >> 16 & 0xffff,
697 $stat[9] & 0xffff,
698 $stat[10] >> 16 & 0xffff,
699 $stat[10] & 0xffff,
700 $stat[7],
701 $stat[2],
702 $stat[1] >> 16 & 0xffff,
703 $stat[1] & 0xffff
705 "Perl script to produce output suitable for use with `file-attributes'
706 on the remote file system.
707 Escape sequence %s is replaced with name of Perl binary.
711 "%s -e '
714 @list = readdir(DIR);
715 closedir(DIR);
716 $n = scalar(@list);
718 for($i = 0; $i < $n; $i++)
719 {
720 $filename = $list[$i];
721 @stat = lstat($filename);
722 if (($stat[2] & 0170000) == 0120000)
723 {
724 $type = readlink($filename);
726 }
727 elsif (($stat[2] & 0170000) == 040000)
728 {
730 }
731 else
732 {
734 };
737 printf(
738 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
739 $filename,
740 $type,
741 $stat[3],
742 $uid,
743 $gid,
744 $stat[8] >> 16 & 0xffff,
745 $stat[8] & 0xffff,
746 $stat[9] >> 16 & 0xffff,
747 $stat[9] & 0xffff,
748 $stat[10] >> 16 & 0xffff,
749 $stat[10] & 0xffff,
750 $stat[7],
751 $stat[2],
752 $stat[1] >> 16 & 0xffff,
753 $stat[1] & 0xffff,
754 $stat[0] >> 16 & 0xffff,
755 $stat[0] & 0xffff);
756 }
758 "Perl script implementing `directory-files-attributes' as Lisp `read'able
759 output.
760 Escape sequence %s is replaced with name of Perl binary.
763 ;; These two use base64 encoding.
765 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
766 "Perl program to use for encoding a file.
767 Escape sequence %s is replaced with name of Perl binary.
768 This string is passed to `format', so percent characters need to be doubled.
769 This implementation requires the MIME::Base64 Perl module to be installed
773 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
774 "Perl program to use for decoding a file.
775 Escape sequence %s is replaced with name of Perl binary.
776 This string is passed to `format', so percent characters need to be doubled.
777 This implementation requires the MIME::Base64 Perl module to be installed
781 "%s -e '
782 # This script contributed by Juanma Barranquero <lektu@terra.es>.
783 # Copyright (C) 2002-2011 Free Software Foundation, Inc.
784 use strict;
786 my %%trans = do {
787 my $i = 0;
788 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
789 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
790 };
794 # We read in chunks of 54 bytes, to generate output lines
795 # of 72 chars (plus end of line)
798 while (my $data = <STDIN>) {
799 my $pad = q();
801 # Only for the last chunk, and only if did not fill the last three-byte packet
802 if (eof) {
803 my $mod = length($data) %% 3;
804 $pad = q(=) x (3 - $mod) if $mod;
805 }
807 # Not the fastest method, but it is simple: unpack to binary string, split
808 # by groups of 6 bits and convert back from binary to byte; then map into
809 # the translation table
810 print
811 join q(),
812 map($trans{$_},
813 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
814 $pad,
816 }' 2>/dev/null"
817 "Perl program to use for encoding a file.
818 Escape sequence %s is replaced with name of Perl binary.
822 "%s -e '
823 # This script contributed by Juanma Barranquero <lektu@terra.es>.
824 # Copyright (C) 2002-2011 Free Software Foundation, Inc.
825 use strict;
827 my %%trans = do {
828 my $i = 0;
829 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
830 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
831 };
833 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
837 # We are going to accumulate into $pending to accept any line length
838 # (we do not check they are <= 76 chars as the RFC says)
839 my $pending = q();
841 while (my $data = <STDIN>) {
842 chomp $data;
844 # If we find one or two =, we have reached the end and
845 # any following data is to be discarded
846 my $finished = $data =~ s/(==?).*/$1/;
847 $pending .= $data;
849 my $len = length($pending);
850 my $chunk = substr($pending, 0, $len & ~3);
851 $pending = substr($pending, $len & ~3 + 1);
853 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
854 # split in 8-bit chunks and convert back to char.
855 print join q(),
856 map $bytes{$_},
857 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
859 last if $finished;
860 }' 2>/dev/null"
861 "Perl program to use for decoding a file.
862 Escape sequence %s is replaced with name of Perl binary.
867 while read file; do
870 else
872 fi
875 else
877 fi
878 done
880 "Script to check existence of VC related files.
881 It must be send formatted with two strings; the tests for file
882 existence, and file readability. Input shall be read via
883 here-document, otherwise the command could exceed maximum length
902 "A list of file types returned from the `stat' system call.
905 ;; New handlers should be added here. The following operations can be
906 ;; handled using the normal primitives: file-name-sans-versions,
907 ;; get-file-buffer.
928 . tramp-sh-handle-directory-files-and-attributes)
941 ;; `executable-find' is not official yet.
953 . tramp-sh-handle-insert-file-contents-literally)
960 . tramp-sh-handle-dired-recursive-delete-directory)
967 "Alist of handler functions.
970 ;; This must be the last entry, because `identity' always matches.
971 ;;;###tramp-autoload
975 ;;; File Name Handler Functions:
979 "Like `make-symbolic-link' for Tramp files.
980 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
981 the symlink. If LINKNAME is a Tramp file, only the localname component is
982 used as the target of the symlink.
984 If LINKNAME is a Tramp file and the localname component is relative, then
985 it is expanded first, before the localname component is taken. Note that
986 this can give surprising results if the user/host for the source and
987 target of the symlink differ."
994 l 'file-error
997 ;; Do the 'confirm if exists' thing.
999 ;; What to do?
1004 "File %s already exists; make it a link anyway? "
1005 l-localname)))))
1010 ;; If FILENAME is a Tramp name, use just the localname component.
1019 ;; Right, they are on the same host, regardless of user, method, etc.
1020 ;; We now make the link on the remote machine. This will occur as the user
1021 ;; that FILENAME belongs to.
1023 l
1025 "cd %s && %s -sf %s %s"
1027 ln
1030 t))))
1033 "Like `file-truename' for Tramp files."
1039 ;; Use GNU readlink --canonicalize-missing where available.
1043 v
1048 ;; Use Perl implementation.
1056 v
1060 ;; Do it yourself. We bind `directory-sep-char' here for
1061 ;; XEmacs on Windows, which would otherwise use backslash.
1069 ;; Don't make the following value larger than
1070 ;; necessary. People expect an error message in a
1071 ;; timely fashion when something is wrong;
1072 ;; otherwise they might think that Emacs is hung.
1073 ;; Of course, correctness has to come first.
1075 symlink-target)
1086 method user host
1098 ;; It's a symlink, follow it.
1103 ;; If the symlink was absolute, we'll get a string like
1104 ;; "/user@host:/some/target"; extract the
1105 ;; "/some/target" part from it.
1109 v 'file-error
1115 steps)))
1117 ;; It's a file.
1121 v 'file-error
1124 ;; Combine list to form string.
1136 ;; Basic functions.
1139 "Like `file-exists-p' for Tramp files."
1147 v
1149 "%s %s"
1153 ;; CCC: This should check for an error condition and signal failure
1154 ;; when something goes wrong.
1155 ;; Daniel Pittman <daniel@danann.net>
1157 "Like `file-attributes' for Tramp files."
1159 ;; Don't modify `last-coding-system-used' by accident.
1165 v
1173 ;; The scripts could fail, for example with huge file size.
1177 "Implement `file-attributes' for Tramp files using the ls(1) command."
1179 res-inode res-filemodes res-numlinks
1180 res-uid res-gid res-size res-symlink-target)
1183 vec
1192 ;; parse `ls -l' output ...
1196 ;; ... inode
1212 ;; ... file mode flags
1214 ;; ... number links
1216 ;; ... uid and gid
1226 ;; ... size
1228 ;; From the file modes, figure out other stuff.
1231 ;; 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 two integers. First
1247 ;; integer has high-order 16 bits of time, second has low 16
1248 ;; bits.
1249 ;; 5. Last modification time, likewise.
1250 ;; 6. Last status change time, likewise.
1252 ;; 7. Size in bytes (-1, if number is out of range).
1253 res-size
1254 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1255 res-filemodes
1256 ;; 9. t if file's gid would change if file were deleted and
1257 ;; recreated. Will be set in `tramp-convert-file-attributes'
1258 t
1259 ;; 10. inode number.
1260 res-inode
1261 ;; 11. Device number. Will be replaced by a virtual device number.
1262 -1
1263 )))))
1267 "Implement `file-attributes' for Tramp files using a Perl script."
1272 vec
1278 "Implement `file-attributes' for Tramp files using stat(1) command."
1281 vec
1283 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1284 ;; parse correctly the sequence "((". Therefore, we add a space.
1285 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1296 "Like `set-visited-file-modtime' for Tramp files."
1303 coding-system-used)
1306 ;; '(-1 65535) means file doesn't exists yet.
1310 ;; We use '(0 0) as a don't-know value. See also
1311 ;; `tramp-do-file-attributes-with-ls'.
1316 v
1326 nil)))))
1328 ;; This function makes the same assumption as
1329 ;; `tramp-sh-handle-set-visited-file-modtime'.
1331 "Like `verify-visited-file-modtime' for Tramp files.
1332 At the time `verify-visited-file-modtime' calls this function, we
1333 already know that the buffer is visiting a file and that
1334 `visited-file-modtime' does not return 0. Do not call this
1335 function directly, unless those two cases are already taken care
1336 of."
1339 ;; There is no file visiting the buffer, or the buffer has no
1340 ;; recorded last modification time, or there is no established
1341 ;; connection.
1345 t
1353 ;; File exists, and has a known modtime.
1356 modtime
1357 ;; For compatibility, deal with both the old
1358 ;; (HIGH . LOW) and the new (HIGH LOW) return
1359 ;; values of `visited-file-modtime'.
1362 mt)))
1364 ;; Modtime has the don't know value.
1367 v
1375 attr
1378 ;; If file does not exist, say it is not modified if and
1379 ;; only if that agrees with the buffer's record.
1383 "Like `set-file-modes' for Tramp files."
1386 ;; FIXME: extract the proper text from chmod's stderr.
1388 v
1395 "Like `set-file-times' for Tramp files."
1401 time))
1402 ;; With GNU Emacs, `format-time-string' has an optional
1403 ;; parameter UNIVERSAL. This is preferred, because we
1404 ;; could handle the case when the remote host is located
1405 ;; in a different time zone as the local host.
1415 ;; We handle also the local part, because in older Emacsen,
1416 ;; without `set-file-times', this function is an alias for this.
1417 ;; We are local, so we don't need the UTC settings.
1425 "Set the ownership for FILENAME.
1426 If UID and GID are provided, these values are used; otherwise uid
1427 and gid of the corresponding user is taken. Both parameters must be integers."
1428 ;; Modern Unices allow chown only for root. So we might need
1429 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1430 ;; working with su(do)? when it is needed, so it shall succeed in
1431 ;; the majority of cases.
1432 ;; Don't modify `last-coding-system-used' by accident.
1437 ;; If we are root on the local host, we can do it directly.
1445 "chown %d:%d %s" uid gid
1448 ;; We handle also the local part, because there doesn't exist
1449 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1453 "chown" nil nil nil
1457 "Check, whether SELINUX is enabled on the remote host."
1468 "Like `file-selinux-context' for Tramp files."
1477 "%s -d -Z %s"
1485 ;; Return the context.
1486 context))))
1489 "Like `set-file-selinux-context' for Tramp files."
1506 ;; We always return nil.
1507 nil)
1509 ;; Simple functions using the `test' command.
1512 "Like `file-executable-p' for Tramp files."
1515 ;; Examine `file-attributes' cache to see if request can be
1516 ;; satisfied without remote operation.
1521 "Like `file-readable-p' for Tramp files."
1524 ;; Examine `file-attributes' cache to see if request can be
1525 ;; satisfied without remote operation.
1529 ;; When the remote shell is started, it looks for a shell which groks
1530 ;; tilde expansion. Here, we assume that all shells which grok tilde
1531 ;; expansion will also provide a `test' command which groks `-nt' (for
1532 ;; newer than). If this breaks, tell me about it and I'll try to do
1533 ;; something smarter about it.
1535 "Like `file-newer-than-file-p' for Tramp files."
1537 nil)
1539 t)
1540 ;; We are sure both files exist at this point.
1543 ;; We try to get the mtime of both files. If they are not
1544 ;; equal to the "dont-know" value, then we subtract the times
1545 ;; and obtain the result.
1551 ;; If one of them is the dont-know value, then we can
1552 ;; still try to run a shell command on the remote host.
1553 ;; However, this only works if both files are Tramp
1554 ;; files and both have the same method, same user, same
1555 ;; host.
1560 v 'file-error
1561 "Files %s and %s must have same method, user, host"
1562 file1 file2)))
1567 ;; Functions implemented using the basic functions above.
1570 "Like `file-directory-p' for Tramp files."
1571 ;; Care must be taken that this function returns `t' for symlinks
1572 ;; pointing to directories. Surely the most obvious implementation
1573 ;; would be `test -d', but that returns false for such symlinks.
1574 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
1575 ;; I now think he's right. So we could be using `test -d', couldn't
1576 ;; we?
1577 ;;
1578 ;; Alternatives: `cd %s', `test -d %s'
1584 "Like `file-writable-p' for Tramp files."
1588 ;; Examine `file-attributes' cache to see if request can be
1589 ;; satisfied without remote operation.
1592 ;; If file doesn't exist, check if directory is writable.
1597 "Like `file-ownership-preserved-p' for Tramp files."
1601 ;; Return t if the file doesn't exist, since it's true that no
1602 ;; information would be lost by an (attempted) delete and create.
1606 ;; Directory listings.
1610 "Like `directory-files-and-attributes' for Tramp files."
1618 v localname
1628 v localname id-format))
1631 v localname id-format)))))))))
1632 result item)
1642 result
1647 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1650 vec tramp-perl-directory-files-and-attributes
1654 vec
1658 object))
1662 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1665 vec
1668 ;; We must care about filenames with spaces, or starting with
1669 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1670 ;; but it does not work on all remote systems. Therefore, we
1671 ;; quote the filenames via sed.
1681 ;; This function should return "foo/" for directories and "bar" for
1682 ;; files.
1684 "Like `file-name-all-completions' for Tramp files."
1689 filename
1691 'list
1693 ;; Try cache entries for filename, filename with last
1694 ;; character removed, filename with last two characters
1695 ;; removed, ..., and finally the empty string - all
1696 ;; concatenated to the local directory name.
1699 tramp-completion-reread-directory-timeout)))
1701 ;; This is inefficient for very long filenames, pity
1702 ;; `reduce' is not available...
1705 'append
1710 v
1712 "file-name-all-completions"
1713 nil)))
1717 ;; Cache expired or no matching cache entry found so we need
1718 ;; to perform a remote operation.
1720 ;; Get a list of directories and files, including reliably
1721 ;; tagging the directories with a trailing '/'. Because I
1722 ;; rock. --daniel@danann.net
1724 ;; Changed to perform `cd' in the same remote op and only
1725 ;; get entries starting with `filename'. Capture any `cd'
1726 ;; error messages. Ensure any `cd' and `echo' aliases are
1727 ;; ignored.
1729 v
1733 v tramp-perl-file-name-all-completions
1739 ;; `read-file-name-completion-ignore-case'
1740 ;; is introduced with Emacs 22.1.
1743 'read-file-name-completion-ignore-case
1749 ;; `ls' with wildcard might fail with `Argument
1750 ;; list too long' error in some corner cases; if
1751 ;; `ls' fails after `cd' succeeded, chances are
1752 ;; that's the case, so let's retry without
1753 ;; wildcard. This will return "too many" entries
1754 ;; but that isn't harmful.
1755 " || %s -a 2>/dev/null)"
1756 " | while read f; do"
1762 ;; When `filename' is empty, just `ls' without
1763 ;; filename argument is more efficient than `ls *'
1764 ;; for very large directories and might avoid the
1765 ;; `Argument list too long' error.
1766 ;;
1767 ;; With and only with wildcard, we need to add
1768 ;; `-d' to prevent `ls' from descending into
1769 ;; sub-directories.
1771 "."
1776 ;; Now grab the output.
1780 ;; Check result code, found in last line of output
1784 ;; Grab error message from line before last line
1785 ;; (it was put there by `cd 2>&1')
1788 v 'file-error
1789 "tramp-sh-handle-file-name-all-completions: %s"
1791 ;; For peace of mind, if buffer doesn't end in `fail'
1792 ;; then it should end in `ok'. If neither are in the
1793 ;; buffer something went seriously wrong on the remote
1794 ;; side.
1797 v 'file-error
1798 "\
1799 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1805 ;; Because the remote op went through OK we know the
1806 ;; directory we `cd'-ed to exists
1810 ;; Because the remote op went through OK we know every
1811 ;; file listed by `ls' exists.
1815 result)
1817 ;; Store result in the cache
1820 "file-name-all-completions"
1821 result))))))))
1823 ;; cp, mv and ln
1827 "Like `add-name-to-file' for Tramp files."
1832 v 'file-error
1833 "add-name-to-file: %s"
1843 "File %s already exists; make it a new name anyway? "
1844 newname)))
1846 v2 'file-error
1851 v1
1854 "error with add-name-to-file, see buffer `%s' for details"
1859 preserve-uid-gid preserve-selinux-context)
1860 "Like `copy-file' for Tramp files."
1864 ;; At least one file a Tramp file?
1868 'copy filename newname ok-if-already-exists keep-date
1869 preserve-uid-gid preserve-selinux-context))
1870 ;; Compat section.
1873 'copy-file
1875 preserve-uid-gid preserve-selinux-context)))
1878 'copy-file
1886 "Like `copy-directory' for Tramp files."
1891 ;; When DIRNAME and NEWNAME are remote, they must have
1892 ;; the same method.
1897 ;; scp or rsync DTRT.
1911 ;; We must do it file-wise.
1915 ;; When newname did exist, we have wrong cached values.
1923 "Like `rename-file' for Tramp files."
1924 ;; Check if both files are local -- invoke normal rename-file.
1925 ;; Otherwise, use Tramp from local system.
1928 ;; At least one file a Tramp file?
1938 preserve-uid-gid preserve-selinux-context)
1939 "Copy or rename a remote file.
1940 OP must be `copy' or `rename' and indicates the operation to perform.
1941 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1942 the new file (for copy) or the new name of the file (for rename).
1943 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1944 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1945 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1946 the uid and gid if both files are on the same host.
1947 PRESERVE-SELINUX-CONTEXT activates selinux commands.
1949 This function is invoked by `tramp-sh-handle-copy-file' and
1950 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1951 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1952 file names."
1959 pr tm)
1969 filename newname)
1972 ;; Both are Tramp files.
1977 ;; Shortcut: if method, host, user are the same for
1978 ;; both files, we invoke `cp' or `mv' on the remote
1979 ;; host directly.
1982 op filename newname
1983 ok-if-already-exists keep-date preserve-uid-gid))
1985 ;; Try out-of-band operation.
1989 op filename newname keep-date))
1991 ;; No shortcut was possible. So we copy the file
1992 ;; first. If the operation was `rename', we go back
1993 ;; and delete the original file (if the copy was
1994 ;; successful). The approach is simple-minded: we
1995 ;; create a new buffer, insert the contents of the
1996 ;; source file into it, then write out the buffer to
1997 ;; the target file. The advantage is that it doesn't
1998 ;; matter which filename handlers are used for the
1999 ;; source and target file.
2002 op filename newname keep-date))))))
2004 ;; One file is a Tramp file, the other one is local.
2007 ;; Fast track on local machine.
2010 op filename newname
2011 ok-if-already-exists keep-date preserve-uid-gid))
2013 ;; If the Tramp file has an out-of-band method, the
2014 ;; corresponding copy-program can be invoked.
2018 op filename newname keep-date))
2020 ;; Use the inline method via a Tramp buffer.
2022 op filename newname keep-date))))
2025 ;; One of them must be a Tramp file.
2028 ;; Handle `preserve-selinux-context'.
2031 ;; In case of `rename', we must flush the cache of the source file.
2037 ;; When newname did exist, we have wrong cached values.
2044 "Use an Emacs buffer to copy or rename a file.
2045 First arg OP is either `copy' or `rename' and indicates the operation.
2046 FILENAME is the source file, NEWNAME the target file.
2047 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2049 ;; We must disable multibyte, because binary data shall not be
2050 ;; converted.
2055 ;; We don't want the target file to be compressed, so we let-bind
2056 ;; `jka-compr-inhibit' to t.
2060 ;; KEEP-DATE handling.
2062 ;; Set the mode.
2064 ;; If the operation was `rename', delete the original file.
2069 "Invokes `cp' or `mv' on the remote system.
2070 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2071 respectively. FILENAME specifies the file to copy or rename,
2072 NEWNAME is the name of the new file (for copy) or the new name of
2073 the file (for rename). Both files must reside on the same host.
2074 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2075 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2076 the uid and gid from FILENAME."
2086 v 'file-error
2087 "Unknown operation `%s', must be `copy' or `rename'"
2088 op))))
2092 filename))
2096 newname))
2098 cmd-result)
2101 ;; Both files are on a remote host, with same user.
2113 ;; Mask cp -f error.
2115 tramp-operation-not-permitted-regexp nil t))
2116 cmd-result)
2118 nil v 'file-error
2119 "Copying directly failed, see buffer `%s' for details."
2122 ;; We are on the local host.
2125 ;; We can do it directly.
2133 localname1 localname2 ok-if-already-exists
2134 keep-date preserve-uid-gid)
2138 ;; We can do it directly with `tramp-send-command'
2146 ok-if-already-exists keep-date t)
2147 ;; We must change the ownership to the local user.
2153 ;; We need a temporary file in between.
2155 ;; Create the temporary file.
2163 "%s %s %s" cmd
2166 "Copying directly failed, see buffer `%s' for details."
2168 ;; We must change the ownership as remote user.
2169 ;; Since this does not work reliable, we also
2170 ;; give read permissions.
2181 localname1 tmpfile t
2182 keep-date preserve-uid-gid)
2184 'rename-file
2186 ;; We must change the ownership as local user.
2187 ;; Since this does not work reliable, we also
2188 ;; give read permissions.
2192 tmpfile
2196 ;; Move the temporary file to its destination.
2201 "cp -f -p %s %s"
2204 "Copying directly failed, see buffer `%s' for details."
2208 'rename-file
2211 ;; Save exit.
2214 ;; Set the time and mode. Mask possible errors.
2221 "Invoke rcp program to copy.
2222 The method used must be an out-of-band method."
2226 copy-program copy-args copy-env copy-keep-date port spec
2227 source target)
2232 ;; Both are Tramp files. We shall optimize it when the
2233 ;; methods for filename and newname are the same.
2243 op filename tmpfile keep-date)
2246 ;; Save exit.
2253 ;; Set variables for computing the prompt for reading
2254 ;; password.
2259 ;; Expand hops. Might be necessary for gateway methods.
2263 ;; Check which ones of source and target are Tramp files.
2270 'file-name-directory
2274 ;; Check for host and port number. We cannot use
2275 ;; `tramp-file-name-port', because this returns also
2276 ;; `tramp-default-port', which might clash with settings in
2277 ;; "~/.ssh/config".
2284 ;; Compose copy command.
2286 ?h host ?u user ?p port
2294 copy-args
2296 ;; " " has either been a replacement of "%k" (when
2297 ;; keep-date argument is non-nil), or a replacement
2298 ;; for the whole keep-date sublist.
2299 " "
2303 copy-args)
2306 copy-args
2309 copy-env
2311 nil
2318 ;; Check for program.
2327 ;; The default directory must be remote.
2331 ;; Set the transfer process properties.
2341 ;; Use an asynchronous process. By this, password can
2342 ;; be handled. The default directory must be local, in
2343 ;; order to apply the correct `copy-program'. We don't
2344 ;; set a timeout, because the copying of large files can
2345 ;; last longer than 60 secs.
2351 copy-program
2358 p v nil tramp-actions-copy-out-of-band)))
2360 ;; Reset the transfer process properties.
2365 ;; Handle KEEP-DATE argument.
2369 ;; Set the mode.
2374 ;; If the operation was `rename', delete the original file.
2381 "Like `make-directory' for Tramp files."
2393 "Like `delete-directory' for Tramp files."
2405 "Like `delete-file' for Tramp files."
2416 ;; Dired.
2418 ;; CCC: This does not seem to be enough. Something dies when
2419 ;; we try and delete two directories under Tramp :/
2421 "Recursively delete the directory given.
2422 This is like `dired-recursive-delete-directory' for Tramp files."
2424 ;; Run a shell command 'rm -r <localname>'
2425 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2428 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
2430 v
2432 ;; Don't read the output, do it explicitly.
2433 nil t)
2434 ;; Wait for the remote system to return to us...
2435 ;; This might take a while, allow it plenty of time.
2437 ;; Make sure that it worked...
2445 "Like `dired-compress-file' for Tramp files."
2446 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2447 ;; Code stolen mainly from dired-aux.el.
2453 ;; Emacs case
2455 ;; XEmacs has `dired-compression-method-alist', which is
2456 ;; transformed into `dired-compress-file-suffixes' structure.
2460 nil
2463 suffix)
2464 ;; See if any suffix rule matches this file name.
2472 nil)
2474 ;; We found an uncompression rule.
2480 ;; `dired-remove-file' is not defined in XEmacs.
2485 ;; We don't recognize the file as compressed, so compress it.
2486 ;; Try gzip.
2491 ;; `dired-remove-file' is not defined in XEmacs.
2501 "Like `insert-directory' for Tramp files."
2527 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2528 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2531 v
2534 switches
2536 localname
2539 v
2543 "Couldn't `cd %s'"
2547 v
2550 switches
2555 ""
2560 ;; We cannot use `insert-buffer-substring' because the Tramp
2561 ;; buffer changes its contents before insertion due to calling
2562 ;; `expand-file' and alike.
2567 ;; Check for "--dired" output.
2574 ;; Now read the numeric positions of file names.
2580 ;; End is followed by \n or by " -> ".
2582 ;; Remove trailing lines.
2588 ;; Some busyboxes are reluctant to discard colors.
2594 ;; The inserted file could be from somewhere else.
2601 "."
2608 ;; Canonicalization of file names.
2611 "Like `expand-file-name' for Tramp files.
2613 the result will be a local, non-Tramp, filename."
2614 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2616 ;; Unless NAME is absolute, concat DIR and NAME.
2619 ;; If NAME is not a Tramp file, run the real handler.
2622 ;; Dissect NAME.
2626 ;; Tilde expansion if necessary. This needs a shell which
2627 ;; groks tilde expansion! The function `tramp-find-shell' is
2628 ;; supposed to find such a shell on the remote host. Please
2629 ;; tell me about it when this doesn't work on your system.
2633 ;; We cannot simply apply "~/", because under sudo "~/" is
2634 ;; expanded to the local user home directory but to the
2635 ;; root home directory. On the other hand, using always
2636 ;; the default user name for tilde expansion is not
2637 ;; appropriate either, because ssh and companions might
2638 ;; use a user name from the config file.
2650 ;; There might be a double slash, for example when "~/"
2651 ;; expands to "/". Remove this.
2654 ;; No tilde characters in file name, do normal
2655 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2656 ;; `directory-sep-char' here for XEmacs on Windows, which would
2657 ;; otherwise use backslash. `default-directory' is bound,
2658 ;; because on Windows there would be problems with UNC shares or
2659 ;; Cygwin mounts.
2663 method user host
2668 ;;; Remote commands:
2671 "Like `executable-find' for Tramp files."
2676 "Flush file caches."
2684 ;; We use BUFFER also as connection buffer during setup. Because of
2685 ;; this, its original contents must be saved, and restored once
2686 ;; connection has been setup.
2688 "Like `start-file-process' for Tramp files."
2690 ;; When PROGRAM is nil, we just provide a tty.
2695 ;; Use a human-friendly prompt, for example for `shell'.
2699 tramp-initial-end-of-output))
2711 ;; BUFFER can be nil. We use a temporary buffer.
2714 ;; NAME must be unique as process name.
2718 ;; Set the new process properties.
2721 ;; Activate narrowing in order to save BUFFER contents.
2722 ;; Clear also the modification time; otherwise we might
2723 ;; be interrupted by `verify-visited-file-modtime'.
2729 ;; Send the command.
2731 ;; Check, whether a pty is associated.
2736 v 'file-error
2739 ;; Set query flag for this process.
2741 ;; Return process.
2742 p)))
2743 ;; Save exit.
2755 "Like `process-file' for Tramp files."
2756 ;; The implementation is not complete yet.
2762 ;; Compute command.
2765 ;; Determine input.
2770 ;; INFILE is on the same remote host.
2772 ;; INFILE must be copied to remote host.
2778 ;; Determine output.
2780 ;; Just a buffer.
2783 ;; A buffer name.
2786 ;; (REAL-DESTINATION ERROR-DESTINATION)
2788 ;; output.
2796 ;; stderr.
2801 ;; stderr is on the same remote host.
2804 ;; stderr must be copied to remote host. The temporary
2805 ;; file must be deleted after execution.
2808 method user host stderr))))
2809 ;; stderr to be discarded.
2812 ;; 't
2817 ;; Send the command. It might not return in time, so we protect
2818 ;; it. Call it in a subshell, in order to preserve working
2819 ;; directory.
2826 command)
2827 t t)
2829 ;; We should show the output anyway.
2836 ;; When the user did interrupt, we should do it also. We use
2837 ;; return code -1 as marker.
2841 ;; Handle errors.
2846 ;; Provide error file.
2849 ;; Cleanup. We remove all file cache values for the connection,
2850 ;; because the remote process could have changed them.
2853 ;; `process-file-side-effects' has been introduced with GNU
2854 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2855 ;; by `program'. If it doesn't exist, we assume its default
2856 ;; value 't'.
2861 ;; Return exit status.
2864 ret))))
2868 "Like `call-process-region' for Tramp files."
2878 "Like `shell-command' for Tramp files."
2880 ;; We cannot use `shell-file-name' and `shell-command-switch',
2881 ;; they are variables of the local host.
2888 current-buffer-p
2898 "*Async Shell Command*"
2908 output-buffer))
2911 ;; Check whether there is another process running. Tramp does not
2912 ;; support 2 (asynchronous) processes in parallel.
2928 ;; Run the process.
2930 ;; Display output.
2936 ;; Run the process.
2938 ;; Insert error messages if they were separated.
2944 ;; This is like exchange-point-and-mark, but doesn't
2945 ;; activate the mark. It is cleaner to avoid activation,
2946 ;; even though the command loop would deactivate the mark
2947 ;; because we inserted text.
2951 ;; There's some output, display it.
2958 "Like `file-local-copy' for Tramp files."
2962 v 'file-error
2972 ;; `copy-file' handles direct copy and out-of-band methods.
2977 ;; Use inline encoding for file transfer.
2987 ;; If local decoding is a function, we call it. We
2988 ;; must disable multibyte, because
2989 ;; `uudecode-decode-region' doesn't handle it
2990 ;; correctly.
2996 filename loc-dec)
2998 ;; Unset `file-name-handler-alist'. Otherwise,
2999 ;; epa-file gets confused.
3004 ;; If tramp-decoding-function is not defined for this
3005 ;; method, we invoke tramp-decoding-command instead.
3007 ;; Unset `file-name-handler-alist'. Otherwise,
3008 ;; epa-file gets confused.
3014 filename loc-dec)
3017 loc-dec tmpfile2 tmpfile)
3020 ;; Set proper permissions.
3022 ;; Set local user ownership.
3025 ;; Oops, I don't know what to do.
3029 ;; Error handling.
3035 tmpfile)))
3037 ;; This is needed for XEmacs only. Code stolen from files.el.
3040 "Like `insert-file-contents-literally' for Tramp files."
3048 nil))
3055 ;; Save exit.
3061 "Like `make-auto-save-file-name' for Tramp files.
3062 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3073 ;; File name must be unique. This is ensured with Emacs 22 (see
3074 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3075 ;; all other cases we must do it ourselves.
3085 ;; Create directory.
3091 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3092 ;; it is not a magic file name operation (since Emacs 22).
3093 ;; We must deactivate it temporarily.
3096 ;; else
3102 ;; CCC grok LOCKNAME
3105 "Like `write-region' for Tramp files."
3108 ;; Following part commented out because we don't know what to do about
3109 ;; file locking, and it does not appear to be a problem to ignore it.
3110 ;; Ange-ftp ignores it, too.
3111 ;; (when (and lockname (stringp lockname))
3112 ;; (setq lockname (expand-file-name lockname)))
3113 ;; (unless (or (eq lockname nil)
3114 ;; (string= lockname filename))
3115 ;; (error
3116 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3118 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3129 ;; `file-writable-p' calls `file-expand-file-name'. We
3130 ;; cannot use `tramp-run-real-handler' therefore.
3136 ;; Short track: if we are on the local host, we can run directly.
3138 'write-region
3142 ;; We use this to save the value of
3143 ;; `last-coding-system-used' after writing the tmp
3144 ;; file. At the end of the function, we set
3145 ;; `last-coding-system-used' to this saved value. This
3146 ;; way, any intermediary coding systems used while
3147 ;; talking to the remote shell or suchlike won't hose
3148 ;; this variable. This approach was snarfed from
3149 ;; ange-ftp.el.
3150 coding-system-used
3151 ;; Write region into a tmp file. This isn't really
3152 ;; needed if we use an encoding function, but currently
3153 ;; we use it always because this makes the logic
3154 ;; simpler.
3158 ;; If `append' is non-nil, we copy the file locally, and let
3159 ;; the native `write-region' implementation do the job.
3162 ;; We say `no-message' here because we don't want the
3163 ;; visited file modtime data to be clobbered from the temp
3164 ;; file. We call `set-visited-file-modtime' ourselves later
3165 ;; on. We must ensure that `file-coding-system-alist'
3166 ;; matches `tmpfile'.
3172 'write-region
3179 ;; Now, `last-coding-system-used' has the right value. Remember it.
3184 ;; The permissions of the temporary file should be set. If
3185 ;; filename does not exist (eq modes nil) it has been
3186 ;; renamed to the backup file. This case `save-buffer'
3187 ;; handles permissions.
3188 ;; Ensure that it is still readable.
3191 tmpfile
3194 ;; This is a bit lengthy due to the different methods
3195 ;; possible for file transfer. First, we check whether the
3196 ;; method uses an rcp program. If so, we call it.
3197 ;; Otherwise, both encoding and decoding command must be
3198 ;; specified. However, if the method _also_ specifies an
3199 ;; encoding function, then that is used for encoding the
3200 ;; contents of the tmp file.
3205 ;; `copy-file' handles direct copy and out-of-band methods.
3216 ;; We keep the local file for performance
3217 ;; reasons, useful for "rsync".
3224 ;; Don't rename, in order to keep context in SELinux.
3229 ;; Use inline file transfer.
3231 ;; Encode tmpfile.
3235 ;; Use encoding function or command.
3239 loc-enc)
3242 ;; The following `let' is a workaround for the
3243 ;; base64.el that comes with pgnus-0.84. If
3244 ;; both of the following conditions are
3245 ;; satisfied, it tries to write to a local
3246 ;; file in default-directory, but at this
3247 ;; point, default-directory is remote.
3248 ;; (`call-process-region' can't write to
3249 ;; remote files, it seems.) The file in
3250 ;; question is a tmp file anyway.
3257 loc-enc)
3259 loc-enc tmpfile t))
3261 v 'file-error
3264 filename loc-enc))))
3266 ;; Send buffer into remote decoding command which
3267 ;; writes to remote file. Because this happens on
3268 ;; the remote host, we cannot use the function.
3270 v 3
3275 v
3281 v nil
3282 "Couldn't write region to `%s', decode using `%s' failed"
3283 filename rem-dec)
3284 ;; When `file-precious-flag' is set, the region is
3285 ;; written to a temporary file. Check that the
3286 ;; checksum is equal to that from the local tmpfile.
3290 ;; cksum runs locally, if possible.
3292 ;; cksum runs remotely.
3294 v
3297 ;; ... they are different.
3304 v 'file-error
3307 filename rem-dec)))))
3309 ;; Save exit.
3312 ;; That's not expected.
3315 v 'file-error
3318 method))))
3320 ;; Make `last-coding-system-used' have the right value.
3327 ;; We must protect `last-coding-system-used', now we have set it
3328 ;; to its correct value.
3330 ;; Set file modification time.
3334 ;; We must pass modtime explicitly, because filename can
3335 ;; be different from (buffer-file-name), f.e. if
3336 ;; `file-precious-flag' is set.
3342 ;; Set the ownership.
3352 ;; VC backends check for the existence of various different special
3353 ;; files. This is very time consuming, because every single check
3354 ;; requires a remote command (the file cache must be invalidated).
3355 ;; Therefore, we apply a kind of optimization. We install the file
3356 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3357 ;; remembers all file names for which `file-exists-p' or
3358 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3359 ;; is performed. Afterwards, a script is applied for all collected
3360 ;; file names, using just one remote command. The result of this
3361 ;; script is used to fill the file cache with actual values. Now we
3362 ;; can reset the file name handlers, and we make a second run of
3363 ;; `vc-registered', which returns the expected result without sending
3364 ;; any other remote command.
3366 "Like `vc-registered' for Tramp files."
3372 ;; There could be new files, created by the vc backend. We
3373 ;; cannot reuse the old cache entries, therefore.
3379 ;; Here we collect only file names, which need an operation.
3383 ;; Send just one command, in order to fill the cache.
3386 v
3395 v
3399 tramp-vc-registered-file-names
3405 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3406 ;; calls shall be answered from the file cache. We unset
3407 ;; `process-file-side-effects' in order to keep the cache when
3408 ;; `process-file' calls appear.
3412 ;;;###tramp-autoload
3414 "Invoke remote-shell Tramp file name handler.
3415 Fall back to normal file name handler if no Tramp handler exists."
3432 "Invoke special file name handler, which collects files to be handled."
3440 ;; That's what we want: file names, for which checks are
3441 ;; applied. We assume that VC uses only `file-exists-p' and
3442 ;; `file-readable-p' checks; otherwise we must extend the
3443 ;; list. We do not perform any action, but return nil, in
3444 ;; order to keep `vc-registered' running.
3447 nil)
3448 ;; Tramp file name handlers like `expand-file-name'. They
3449 ;; must still work.
3452 ;; Default file name handlers, we don't care.
3455 ;;; Internal Functions:
3458 "Define in remote shell function NAME implemented as SCRIPT.
3459 Only send the definition if it has not already been done."
3464 ;; The script could contain a call of Perl. This is masked with `%s'.
3466 vec
3476 auto-save-default)
3484 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3485 Returns the exit code of the `test' program."
3488 v
3490 "%s %s %s"
3492 switch
3496 "Run `test'-like program on the remote system, given FILE1, FILE2.
3497 FORMAT-STRING contains the program name, switches, and place holders.
3498 Returns the exit code of the `test' program. Barfs if the methods,
3499 hosts, or files, disagree."
3503 v 'file-error
3508 v1
3515 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3516 First arg VEC specifies the connection, PROGNAME is the program
3517 to search for, and DIRLIST gives the list of directories to
3518 search. If IGNORE-TILDE is non-nil, directory names starting
3519 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3520 only in DIRLIST.
3522 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3524 This function expects to be in the right *tramp* buffer."
3527 ;; Check whether the executable is in $PATH. "which(1)" does not
3528 ;; report always a correct error code; therefore we check the
3529 ;; number of words it returns.
3537 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3538 ;; `remove' is in CL, and we want to avoid CL dependencies.
3547 vec
3549 "do if test -x $d/%s -a -f $d/%s; "
3550 "then echo tramp_executable $d/%s; "
3559 result)))
3562 "Sets the remote environment PATH to existing directories.
3563 I.e., for each directory in `tramp-remote-path', it is tested
3564 whether it exists and if so, it is added to the environment
3565 variable PATH."
3571 ;; ------------------------------------------------------------
3572 ;; -- Communication with external shell --
3573 ;; ------------------------------------------------------------
3576 "Find a command on the remote host for checking if a file exists.
3577 Here, we are looking for a command which has zero exit status if the
3578 file exists and nonzero exit status otherwise."
3582 result)
3583 ;; The algorithm is as follows: we try a list of several commands.
3584 ;; For each command, we first run `$cmd /' -- this should return
3585 ;; true, as the root directory always exists. And then we run
3586 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3587 ;; does not exist. This should return false. We use the first
3588 ;; command we find that seems to work.
3589 ;; The list of commands to try is as follows:
3590 ;; `ls -d' This works on most systems, but NetBSD 1.4
3591 ;; has a bug: `ls' always returns zero exit
3592 ;; status, even for files which don't exist.
3593 ;; `test -e' Some Bourne shells have a `test' builtin
3594 ;; which does not know the `-e' option.
3595 ;; `/bin/test -e' For those, the `test' binary on disk normally
3596 ;; provides the option. Alas, the binary
3597 ;; is sometimes `/bin/test' and sometimes it's
3598 ;; `/usr/bin/test'.
3599 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3623 result))
3626 "Opens shell SHELL."
3629 ;; Find arguments for this shell.
3632 item extra-args)
3641 t))
3642 ;; Setting prompts.
3650 "Opens a shell on the remote host which groks tilde expansion."
3657 ;; The default shell (ksh93) of OpenSolaris and Solaris
3658 ;; is buggy. We've got reports for "SunOS 5.10" and
3659 ;; "SunOS 5.11" so far.
3669 vec 'file-error
3678 vec "remote-shell"
3682 ;; Utility functions.
3685 "Wait for shell prompt and barf if none appears.
3686 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3687 seconds. If not, it produces an error message with the given ERROR-ARGS."
3690 proc timeout
3696 "Set up an interactive shell.
3697 Mainly sets the prompt and the echo correctly. PROC is the shell
3698 process to set up. VEC specifies the connection."
3700 ;; It is useful to set the prompt in the following command because
3701 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3702 ;; about and thus /bin/sh will display a strange prompt. For
3703 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3704 ;; display the current working directory but /bin/sh will display
3705 ;; a dollar sign. The following command line sets $PS1 to a sane
3706 ;; value, and works under Bourne-ish shells as well as csh-like
3707 ;; shells. Daniel Pittman reports that the unusual positioning of
3708 ;; the single quotes makes it work under `rc', too. We also unset
3709 ;; the variable $ENV because that is read by some sh
3710 ;; implementations (eg, bash when called as sh) on startup; this
3711 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3712 ;; is another way to set the prompt in /bin/bash, it must be
3713 ;; discarded as well.
3715 vec
3718 ;; Disable echo.
3721 ;; Check whether the echo has really been disabled. Some
3722 ;; implementations, like busybox of embedded GNU/Linux, don't
3723 ;; support disabling.
3730 ;; Make sure backspaces and their echo are enabled and no line
3731 ;; width magic interferes with them.
3741 ;; Try to set up the coding system correctly.
3742 ;; CCC this can't be the right way to do it. Hm.
3748 ;; Use MULE to select the right EOL convention for communicating
3749 ;; with the process.
3752 cs-decode cs-encode)
3767 ;; Look for ^M and do something useful if found.
3769 ;; We have found a ^M but cannot frob the process coding system
3770 ;; because we're running on a non-MULE Emacs. Let's try
3771 ;; stty, instead.
3776 ;; Check whether the output of "uname -sr" has been changed. If
3777 ;; yes, this is a strong indication that we must expire all
3778 ;; connection properties. We start again with
3779 ;; `tramp-maybe-open-connection', it will be catched there.
3784 vec "uname"
3788 ;; Keep the debug buffer.
3795 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
3798 vec 3
3799 "Connection reset, because remote host changed from `%s' to `%s'"
3800 old-uname new-uname)
3803 ;; Check whether the remote host suffers from buggy
3804 ;; `send-process-string'. This is known for FreeBSD (see comment in
3805 ;; `send_process', file process.c). I've tested sending 624 bytes
3806 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3807 ;; this host type is detected locally. It cannot handle remote
3808 ;; hosts, though.
3812 tramp-chunksize)
3820 ;; Set remote PATH variable.
3823 ;; Search for a good shell before searching for a command which
3824 ;; checks if a file exists. This is done because Tramp wants to use
3825 ;; "test foo; echo $?" to check if various conditions hold, and
3826 ;; there are buggy /bin/sh implementations which don't execute the
3827 ;; "echo $?" part if the "test" part has an error. In particular,
3828 ;; the OpenSolaris /bin/sh is a problem. There are also other
3829 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3830 ;; in function declarations, or changing HISTFILE in place.
3831 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3832 ;; detected.
3835 ;; Disable unexpected output.
3838 ;; IRIX64 bash expands "!" even when in single quotes. This
3839 ;; destroys our shell functions, we must disable it. See
3840 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3844 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3849 ;; Set `remote-tty' process property.
3854 ;; Dump stty settings in the traces.
3858 ;; Set the environment.
3862 unset item)
3875 ;; CCC: We should either implement a Perl version of base64 encoding
3876 ;; and decoding. Then we just use that in the last item. The other
3877 ;; alternative is to use the Perl version of UU encoding. But then
3878 ;; we need a Lisp version of uuencode.
3879 ;;
3880 ;; Old text from documentation of tramp-methods:
3881 ;; Using a uuencode/uudecode inline method is discouraged, please use one
3882 ;; of the base64 methods instead since base64 encoding is much more
3883 ;; reliable and the commands are more standardized between the different
3884 ;; Unix versions. But if you can't use base64 for some reason, please
3885 ;; note that the default uudecode command does not work well for some
3886 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
3887 ;; the following command for uudecode:
3888 ;;
3889 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3890 ;;
3891 ;; For Irix, no solution is known yet.
3899 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3901 "List of local coding commands for inline transfer.
3902 Each item is a list that looks like this:
3904 \(FORMAT ENCODING DECODING\)
3906 FORMAT is symbol describing the encoding/decoding format. It can be
3907 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3909 ENCODING and DECODING can be strings, giving commands, or symbols,
3910 giving functions. If they are strings, then they can contain
3912 filename will be put into the command line at that spot. If the
3913 specifier is not present, the input should be read from standard
3914 input.
3916 If they are functions, they will be called with two arguments, start
3917 and end of region, and are expected to replace the region contents
3922 ;; "-i" is more robust with older base64 from GNU coreutils.
3923 ;; However, I don't know whether all base64 versions do supports
3924 ;; this option.
3936 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3938 "List of remote coding commands for inline transfer.
3939 Each item is a list that looks like this:
3941 \(FORMAT ENCODING DECODING\)
3943 FORMAT is symbol describing the encoding/decoding format. It can be
3944 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3946 ENCODING and DECODING can be strings, giving commands, or symbols,
3947 giving variables. If they are strings, then they can contain
3949 filename will be put into the command line at that spot. If the
3950 specifier is not present, the input should be read from standard
3951 input.
3953 If they are variables, this variable is a string containing a Perl
3954 implementation for this functionality. This Perl program will be transferred
3958 "Find an inline transfer encoding that works.
3959 Goes through the list `tramp-local-coding-commands' and
3960 `tramp-remote-coding-commands'."
3964 loc-enc loc-dec rem-enc rem-dec litem ritem found)
3972 ;; If the local encoder or decoder is a string, the
3973 ;; corresponding command has to work locally.
3980 loc-enc nil nil))
3988 loc-dec nil nil))
3990 ;; Search for remote coding commands with the same format
3997 ;; Check if remote encoding and decoding commands can be
3998 ;; called remotely with null input and output. This makes
3999 ;; sure there are no syntax errors and the command is really
4000 ;; found. Note that we do not redirect stdout to /dev/null,
4001 ;; for two reasons: when checking the decoding command, we
4002 ;; actually check the output it gives. And also, when
4003 ;; redirecting "mimencode" output to /dev/null, then as root
4004 ;; it might change the permissions of /dev/null!
4012 vec 5
4025 vec 5
4028 vec
4030 t)
4038 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4043 ;; Did we find something?
4048 ;; Set connection properties.
4059 "Call the local encoding or decoding command.
4061 Otherwise, INPUT is passed via standard input.
4062 INPUT can also be nil which means `/dev/null'.
4063 OUTPUT can be a string (which specifies a filename), or t (which
4064 means standard output and thus the current buffer), or nil (which
4065 means discard it)."
4067 tramp-encoding-shell
4070 nil
4071 tramp-encoding-command-switch
4080 "List of compress and decompress commands for inline transfer.
4081 Each item is a list that looks like this:
4083 \(COMPRESS DECOMPRESS\)
4088 "Find an inline transfer compress command that works.
4089 Goes through the list `tramp-inline-compress-commands'."
4093 item compress decompress
4094 found)
4101 vec 5
4102 "Checking local compress command `%s', `%s' for sanity"
4103 compress decompress)
4108 ;; Windows shells need the program file name after
4109 ;; the pipe symbol be quoted if they use forward
4110 ;; slashes as directory separators.
4117 vec 5
4118 "Checking remote compress command `%s', `%s' for sanity"
4119 compress decompress)
4125 ;; Did we find something?
4128 ;; Set connection properties.
4142 "Expands VEC according to `tramp-default-proxies-alist'.
4143 Gateway hops are already opened."
4146 item proxy)
4148 ;; Look for proxy hosts to be passed.
4153 ;; host
4156 ;; user
4160 ;; No more hops needed.
4162 ;; Replace placeholders.
4165 proxy
4170 ;; Add the hop.
4172 ;; Start next search.
4175 ;; Handle gateways.
4182 ;; Is the method prepared for gateways?
4185 vec 'file-error
4187 ;; Open the gateway connection.
4189 'target-alist
4193 ;; For the password prompt, we need the correct values.
4194 ;; Therefore, we must remember the gateway vector. But we
4195 ;; cannot do it as connection property, because it shouldn't
4196 ;; be persistent. And we have no started process yet either.
4199 ;; Foreign and out-of-band methods are not supported for multi-hops.
4212 vec 'file-error
4213 "Method `%s' is not supported for multi-hops."
4216 ;; In case the host name is not used for the remote shell
4217 ;; command, the user could be misguided by applying a random
4218 ;; hostname.
4224 ;; There are multi-hops.
4226 ;; The host name is used for the remote shell command.
4229 ;; The host is local. We cannot use `tramp-local-host-p'
4230 ;; here, because it opens a connection as well.
4233 v 'file-error
4234 "Host `%s' looks like a remote host, `%s' can only use the local host"
4235 host method)))
4237 ;; Result.
4238 target-alist))
4241 "Maybe open a connection VEC.
4242 Does not do anything if a connection is already open, but re-opens the
4243 connection if a previous connection has died for some reason."
4250 ;; If too much time has passed since last command was sent, look
4251 ;; whether process is still alive. If it isn't, kill it. When
4252 ;; using ssh, it can sometimes happen that the remote end has
4253 ;; hung up but the local ssh client doesn't recognize this until
4254 ;; it tries to send some data to the remote end. So that's why
4255 ;; we try to send a command from time to time, then look again
4256 ;; whether the process is really alive.
4267 ;; The error will be catched locally.
4275 ;; New connection must be opened.
4278 ;; We call `tramp-get-buffer' in order to get a debug buffer for
4279 ;; messages from the beginning.
4282 vec 3
4292 ;; Start new process.
4303 ;; This must be done in order to avoid our file name handler.
4307 'start-process
4312 tramp-encoding-command-interactive)
4315 ;; Set sentinel and query flag.
4323 ;; Check whether process is alive.
4327 ;; Now do all the connections as specified.
4348 ;; We don't create the temporary file. In fact,
4349 ;; it is just a prefix for the ControlPath option
4350 ;; of ssh; the real temporary file has another
4351 ;; name, and it is created and protected by ssh.
4352 ;; It is also removed by ssh when the connection
4353 ;; is closed.
4356 p "temp-file"
4359 tramp-temp-name-prefix
4361 spec)
4363 ;; Add arguments for asynchrononous processes.
4367 ;; Add gateway arguments if necessary.
4371 ;; Check for port number. Until now, there's no need
4372 ;; for handling like method, user, host.
4377 ;; Set variables for computing the prompt for reading
4378 ;; password. They can also be derived from a gateway.
4383 ;; Replace login-args place holders.
4389 ?h l-host ?u l-user ?p l-port ?t tmpfile)
4390 command
4392 ;; We do not want to see the trailing local prompt in
4393 ;; `start-file-process'.
4395 command " "
4401 ;; Local shell could be a Windows COMSPEC. It
4402 ;; doesn't know the ";" syntax, but we must exit
4403 ;; always for `start-file-process'. "exec" does not
4404 ;; work either.
4407 ;; Send the command.
4413 ;; Next hop.
4416 ;; Make initial shell settings.
4420 "Send the COMMAND to connection VEC.
4421 Erases temporary buffer before sending the command. If optional
4422 arg NEVEROPEN is non-nil, never try to open the connection. This
4423 is meant to be used from `tramp-maybe-open-connection' only. The
4424 function waits for output unless NOOUTPUT is set."
4428 ;; We mark the command string that it can be erased in the output buffer.
4432 ;; Unset $PS1 when using here documents, in order to avoid
4433 ;; multiple prompts.
4435 ;; Send the command.
4441 "Wait for output from remote command."
4447 ;; be leading escape sequences, which must be ignored.
4449 ;; Sometimes, the commands do not return a newline but a
4450 ;; null byte before the shell prompt, for example "git
4451 ;; ls-files -c -z ...".
4456 ;; A simple-minded busybox has sent " ^H" sequences.
4457 ;; Delete them.
4462 ;; Delete the prompt.
4468 proc 'file-error
4469 "[[Remote prompt `%s' not found in %d secs]]"
4470 tramp-end-of-output timeout)
4472 proc 'file-error
4474 ;; Return value is whether end-of-output sentinel was found.
4475 found)))
4479 "Run COMMAND and check its exit status.
4480 Sends `echo $?' along with the COMMAND for checking the exit status. If
4481 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4483 If the optional argument SUBSHELL is non-nil, the command is
4484 executed in a subshell, ie surrounded by parentheses. If
4485 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4487 vec
4489 command
4491 "echo tramp_exit_status $?"
4505 "Run COMMAND, check exit status, throw error if exit status not okay.
4506 Similar to `tramp-send-command-and-check' but accepts two more arguments
4507 FMT and ARGS which are passed to `error'."
4512 "Run COMMAND and return the output, which must be a Lisp expression.
4513 In case there is no valid Lisp expression and NOERROR is nil, it
4514 raises an error."
4517 ;; Read the expression.
4521 ;; Error handling.
4526 vec 'file-error
4527 "`%s' does not return a valid Lisp expression: `%s'"
4531 "Convert file-attributes ATTR generated by perl script, stat or ls.
4532 Convert file mode bits to string and set virtual device number.
4533 Return ATTR."
4535 ;; Remove color escape sequences from symlink.
4539 ;; Convert last access time.
4544 ;; Convert last modification time.
4549 ;; Convert last status change time.
4554 ;; Convert file size.
4560 ;; Convert file mode bits to string.
4565 ;; Convert directory indication bit.
4568 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4574 ;; Set file's gid change bit.
4582 ;; Convert inode.
4588 ;; Inodes can be incredible huge. We must hide this.
4590 ;; Set virtual device number.
4593 attr))
4596 "Check `file-attributes' caches for VEC.
4597 Return t if according to the cache access type ACCESS is known to
4598 be granted."
4606 result
4608 result
4620 file-attr
4622 ;; Not a symlink
4626 ;; World accessible.
4628 ;; User accessible and owned by user.
4632 ;; Group accessible and owned by user's
4633 ;; principal group.
4639 "Turn an integer representing a file mode into an ls(1)-like string."
4654 "Convert a permission bitset into a string.
4655 This is used internally by `tramp-file-mode-from-int'."
4666 "Converts STRING to shell glob pattern which ignores case."
4672 string
4676 "Create a file name suitable to be passed to `rcp' and workalikes."
4686 "Return t if this is an out-of-band method, nil otherwise."
4688 ;; It shall be an out-of-band method.
4690 ;; There must be a size, otherwise the file doesn't exist.
4692 ;; Either the file size is large enough, or (in rare cases) there
4693 ;; does not exist a remote encoding.
4698 ;; Variables local to connection.
4702 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4703 ;; cache the result for the session only. Otherwise, the result
4704 ;; is cached persistently.
4707 vec)
4708 "remote-path"
4717 ;; Default if "getconf" is not available.
4720 vec 3
4731 nil)))))
4733 ;; Replace place holder `tramp-default-remote-path'.
4741 ;; Replace place holder `tramp-own-remote-path'.
4749 ;; Remove double entries.
4756 ;; Remove non-existing directories.
4758 nil
4768 x))
4769 x))
4770 remote-path)))))
4779 dir
4789 result)
4791 ;; Check parameters. On busybox, "ls" output coloring is
4792 ;; enabled by default sometimes. So we try to disable it
4793 ;; when possible. $LS_COLORING is not supported there.
4794 ;; Some "ls" versions are sensible wrt the order of
4795 ;; arguments, they fail when "-al" is after the
4796 ;; "--color=never" argument (for example on FreeBSD).
4811 ;; Some "ls" versions are sensible wrt the order of arguments,
4812 ;; they fail when "-al" is after the "--dired" argument (for
4813 ;; example on FreeBSD).
4821 "test"
4825 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4826 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4827 ;; for otherwise the shell crashes.
4839 vec
4862 ;; We must check also for some Perl modules.
4870 result)))
4877 tmp)
4878 ;; Check whether stat(1) returns usable syntax. "%s" does not
4879 ;; work on older AIX systems.
4888 result)))
4898 result))))
4911 result)
4913 ;; Check POSIX parameter.
4922 vec
4928 ;; The command might not always return a number.
4934 vec
4940 ;; The command might not always return a number.
4949 ;; Some predefined connection properties.
4951 "Return the compress command related to PROP.
4952 PROP is either `inline-compress' or `inline-decompress'. SIZE is
4953 the length of the file to be compressed.
4955 If no corresponding command is found, nil is returned."
4963 "Return the coding command related to PROP.
4964 PROP is either `remote-encoding', `remode-decoding',
4965 `local-encoding' or `local-decoding'.
4967 SIZE is the length of the file to be coded. Depending on SIZE,
4968 compression might be applied.
4970 If no corresponding command is found, nil is returned.
4971 Otherwise, either a string is returned which contains a `%s' mark
4972 to be used for the respective input or output file; or a Lisp
4973 function cell is returned to be applied on a buffer."
4974 ;; We must catch the errors, because we want to return `nil', when
4975 ;; no inline coding is found.
4983 compress)
4984 ;; The connection property might have been cached. So we must
4985 ;; send the script to the remote side - maybe.
4993 ;; Check for the `compress' command.
4995 ;; Return the value.
5011 'call-process-region beg end
5016 coding)
5019 ;; Windows shells need the program file name after
5020 ;; the pipe symbol be quoted if they use forward
5021 ;; slashes as directory separators.
5026 coding compress))
5029 ;; Windows shells need the program file name after
5030 ;; the pipe symbol be quoted if they use forward
5031 ;; slashes as directory separators.
5036 compress coding))
5042 ;;; Integration of eshell.el:
5047 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
5048 ;; when `default-directory' points to another host.
5050 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
5055 'identity
5076 ;;; TODO:
5078 ;; * Don't use globbing for directories with many files, as this is
5079 ;; likely to produce long command lines, and some shells choke on
5080 ;; long command lines.
5081 ;; * Make it work for different encodings, and for different file name
5082 ;; encodings, too. (Daniel Pittman)
5083 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5084 ;; then look if it's the right version (with `perl -v').
5085 ;; * When editing a remote CVS controlled file as a different user, VC
5086 ;; gets confused about the file locking status. Try to find out why
5087 ;; the workaround doesn't work.
5088 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5089 ;; until the last but one hop via `start-file-process'. Apply it
5090 ;; also for ftp and smb.
5091 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5092 ;; some shell with root priviledges, it would be nice if I could
5093 ;; just call
5094 ;; trampclient filename.c
5095 ;; as an editor, and the _current_ shell would connect to an Emacs
5096 ;; server and would be used in an existing non-priviledged Emacs
5097 ;; session for doing the editing in question.
5098 ;; That way, I need not tell Emacs my password again and be afraid
5099 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5100 ;; once display a just typed password in the context of a keyboard
5101 ;; sequence prompt for a question immediately following in a shell
5102 ;; script run within Emacs -- nasty).
5103 ;; And if I have some ssh session running to a different computer,
5104 ;; having the possibility of passing a local file there to a local
5105 ;; Emacs session (in case I can arrange for a connection back) would
5106 ;; be nice.
5107 ;; Likely the corresponding Tramp server should not allow the
5108 ;; equivalent of the emacsclient -eval option in order to make this
5109 ;; reasonably unproblematic. And maybe trampclient should have some
5110 ;; way of passing credentials, like by using an SSL socket or
5111 ;; something. (David Kastrup)
5112 ;; * Reconnect directly to a compliant shell without first going
5113 ;; through the user's default shell. (Pete Forman)
5114 ;; * How can I interrupt the remote process with a signal
5115 ;; (interrupt-process seems not to work)? (Markus Triska)
5116 ;; * Avoid the local shell entirely for starting remote processes. If
5117 ;; so, I think even a signal, when delivered directly to the local
5118 ;; SSH instance, would correctly be propagated to the remote process
5119 ;; automatically; possibly SSH would have to be started with
5120 ;; "-t". (Markus Triska)
5121 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5122 ;; isn't on the remote host. (Mark A. Hershberger)
5123 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5124 ;; * Optimize out-of-band copying when both methods are scp-like (not
5125 ;; rsync).
5126 ;; * Keep a second connection open for out-of-band methods like scp or
5127 ;; rsync.
5128 ;; * Try telnet+curl as new method. It might be useful for busybox,
5129 ;; without built-in uuencode/uudecode.
5131 ;;; tramp-sh.el ends here