| blob | 26141c0aa20dd6b63e67da11089aa21d26e812ab |
1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol -*- coding: iso-8859-1; -*-
3 ;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
5 ;; Author: Kai.Grossjohann@CS.Uni-Dortmund.DE
6 ;; Keywords: comm, processes
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; This package provides remote file editing, similar to ange-ftp.
28 ;; The difference is that ange-ftp uses FTP to transfer files between
29 ;; the local and the remote host, whereas tramp.el uses a combination
30 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
31 ;;
32 ;; For more detailed instructions, please see the info file, which is
33 ;; included in the file `tramp.tar.gz' mentioned below.
34 ;;
35 ;; Notes:
36 ;; -----
37 ;;
38 ;; This package only works for Emacs 20 and higher, and for XEmacs 21
39 ;; and higher. (XEmacs 20 is missing the `with-timeout' macro. Emacs
40 ;; 19 is reported to have other problems. For XEmacs 21, you need the
41 ;; package `fsf-compat' for the `with-timeout' macro.)
42 ;;
43 ;; This version might not work with pre-Emacs 21 VC unless VC is
44 ;; loaded before tramp.el. Could you please test this and tell me about
45 ;; the result? Thanks.
46 ;;
47 ;; Also see the todo list at the bottom of this file.
48 ;;
49 ;; The current version of tramp.el can be retrieved from the following
50 ;; URL: ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz
51 ;; For your convenience, the *.el file is available separately from
52 ;; the same directory.
53 ;;
54 ;; There's a mailing list for this, as well. Its name is:
55 ;; tramp-devel@mail.freesoftware.fsf.org
56 ;; Send a mail with `help' in the subject (!) to the administration
57 ;; address for instructions on joining the list. The administration
58 ;; address is:
59 ;; tramp-devel-request@mail.freesoftware.fsf.org
60 ;; You can also use the Web to subscribe, under the following URL:
61 ;; http://mail.freesoftware.fsf.org/mailman/listinfo/tramp-devel
62 ;;
63 ;; For the adventurous, the current development sources are available
64 ;; via CVS. You can find instructions about this at the following URL:
65 ;; http://savannah.gnu.org/projects/tramp/
66 ;; Click on "CVS" in the navigation bar near the top.
67 ;;
68 ;; Don't forget to put on your asbestos longjohns, first!
70 ;;; Code:
84 ;; ;; It does not work to load EFS after loading TRAMP.
85 ;; (when (fboundp 'efs-file-handler-function)
86 ;; (require 'efs))
91 ;; Emacs 19.34 compatibility hack -- is this needed?
98 ;;; User Customizable Internal Variables:
101 "Edit remote files with a combination of rsh and rcp or similar programs."
105 "*Verbosity level for tramp.el. 0 means be silent, 10 is most verbose."
110 "*Whether to send all commands and responses to a debug buffer."
115 "*Put auto-save files in this directory, if set.
116 The idea is to use a local directory so that auto-saving is faster."
119 string))
122 "*Use this program for shell commands on the local host.
123 This MUST be a Bourne-like shell. This shell is used to execute
124 the encoding and decoding command on the local host, so if you
125 want to use `~' in those commands, you should choose a shell here
126 which groks tilde expansion. `/bin/sh' normally does not
127 understand tilde expansion.
129 Note that this variable is not used for remote commands. There are
130 mechanisms in tramp.el which automatically determine the right shell to
131 use for the remote host."
137 "cmd.exe"
138 tramp-sh-program)
139 "*Use this program for bootstrapping multi-hop connections.
140 This variable is similar to `tramp-sh-program', but it is only used
141 when initializing a multi-hop connection. Therefore, the set of
142 commands sent to this shell is quite restricted, and if you are
143 careful it works to use CMD.EXE under Windows (instead of a Bourne-ish
144 shell which does not normally exist on Windows anyway).
146 To use multi-hop methods from Windows, you also need suitable entries
147 in `tramp-multi-connection-function-alist' for the first hop.
149 This variable defaults to CMD.EXE on Windows NT, and to the value of
150 `tramp-sh-program' on other systems."
154 ;; CCC I have changed all occurrences of comint-quote-filename with
155 ;; tramp-shell-quote-argument, except in tramp-handle-expand-many-files.
156 ;; There, comint-quote-filename was removed altogether. If it turns
157 ;; out to be necessary there, something will need to be done.
158 ;;-(defcustom tramp-file-name-quote-list
159 ;;- '(?] ?[ ?\| ?& ?< ?> ?\( ?\) ?\; ?\ ?\* ?\? ?\! ?\" ?\' ?\` ?# ?\@ ?\+ )
160 ;;- "*Protect these characters from the remote shell.
161 ;;-Any character in this list is quoted (preceded with a backslash)
162 ;;-because it means something special to the shell. This takes effect
163 ;;-when sending file and directory names to the remote shell.
164 ;;-
165 ;;-See `comint-file-name-quote-list' for details."
166 ;;- :group 'tramp
167 ;;- :type '(repeat character))
454 )
455 "*Alist of methods for remote files.
456 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
457 Each NAME stands for a remote access method. Each PARAM is a
458 pair of the form (KEY VALUE). The following KEYs are defined:
459 * `tramp-connection-function'
460 This specifies the function to use to connect to the remote host.
461 Currently, `tramp-open-connection-rsh', `tramp-open-connection-telnet'
462 and `tramp-open-connection-su' are defined. See the documentation
463 of these functions for more details.
464 * `tramp-remote-sh'
465 This specifies the Bourne shell to use on the remote host. This
466 MUST be a Bourne-like shell. It is normally not necessary to set
468 which groks tilde expansion, but it can search for it. Also note
470 the value that you decide to use. You Have Been Warned.
471 * `tramp-rsh-program'
472 This specifies the name of the program to use for rsh; this might be
473 the full path to rsh or the name of a workalike program.
474 * `tramp-rsh-args'
475 This specifies the list of arguments to pass to the above
476 mentioned program. Please note that this is a list of arguments,
480 * `tramp-rcp-program'
481 This specifies the name of the program to use for rcp; this might be
482 the full path to rcp or the name of a workalike program.
483 * `tramp-rcp-args'
484 This specifies the list of parameters to pass to the above mentioned
485 program, the hints for `tramp-rsh-args' also apply here.
486 * `tramp-rcp-keep-date-arg'
487 This specifies the parameter to use for `rcp' when the timestamp
488 of the original file should be kept. For `rcp', use `-p', for
489 `rsync', use `-t'.
490 * `tramp-su-program'
491 This specifies the name of the program to use for `su'.
492 * `tramp-su-args'
493 This specifies the list of arguments to pass to `su'.
495 percent character.
496 * `tramp-encoding-command'
497 This specifies a command to use to encode the file contents for
498 transfer. The command should read the raw file contents from
499 standard input and write the encoded file contents to standard
502 percent character in your command.
503 * `tramp-decoding-command'
504 This specifies a command to use to decode file contents encoded
505 with `tramp-encoding-command'. The command should read from standard
506 input and write to standard output.
507 * `tramp-encoding-function'
508 This specifies a function to be called to encode the file contents
509 on the local side. This function should accept two arguments
510 START and END, the beginning and end of the region to encode. The
511 region should be replaced with the encoded contents.
512 * `tramp-decoding-function'
513 Same for decoding on the local side.
514 * `tramp-telnet-program'
515 Specifies the telnet program to use when using
516 `tramp-open-connection-telnet' to log in.
517 * `tramp-telnet-args'
518 Specifies list of arguments to pass to `telnet'. The hints for
519 `tramp-rsh-args' also apply here.
521 What does all this mean? Well, you should specify `tramp-rsh-program',
522 `tramp-telnet-program' or `tramp-su-program' for all methods; this program
523 is used to log in to the remote site. Then, there are two ways to
524 actually transfer the files between the local and the remote side.
525 One way is using an additional rcp-like program. If you want to do
526 this, set `tramp-rcp-program' in the method.
528 Another possibility for file transfer is inline transfer, i.e. the
529 file is passed through the same buffer used by `tramp-rsh-program'. In
530 this case, the file contents need to be protected since the
531 `tramp-rsh-program' might use escape codes or the connection might not
532 be eight-bit clean. Therefore, file contents are encoded for transit.
534 Two possibilities for encoding are uuencode/uudecode and mimencode.
535 For uuencode/uudecode you want to set `tramp-encoding-command' to
541 When using inline transfer, you can use a program or a Lisp function
542 on the local side to encode or decode the file contents. Set the
543 `tramp-encoding-function' and `tramp-decoding-function' parameters to nil
544 in order to use the commands or to the function to use. It is
545 possible to specify one function and the other parameter as nil.
547 So, to summarize: if the method is an inline method, you must specify
548 `tramp-encoding-command' and `tramp-decoding-command', and
549 `tramp-rcp-program' must be nil. If the method is out of band, then
550 you must specify `tramp-rcp-program' and `tramp-rcp-args' and
551 `tramp-encoding-command' and `tramp-decoding-command' must be nil.
552 Every method, inline or out of band, must specify
553 `tramp-connection-function' plus the associated arguments (for
554 example, the telnet program if you chose
555 `tramp-open-connection-telnet').
557 Notes:
559 When using `tramp-open-connection-su' the phrase `open connection to a
560 remote host' sounds strange, but it is used nevertheless, for
561 consistency. No connection is opened to a remote host, but `su' is
562 started on the local host. You are not allowed to specify a remote
563 host other than `localhost' or the name of the local host.
565 Using a uuencode/uudecode inline method is discouraged, please use one
566 of the base64 methods instead since base64 encoding is much more
567 reliable and the commands are more standardized between the different
568 Unix versions. But if you can't use base64 for some reason, please
569 note that the default uudecode command does not work well for some
570 Unices, in particular AIX and Irix. For AIX, you might want to use
571 the following command for uudecode:
573 sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
575 For Irix, no solution is known yet."
606 "*List of multi-hop methods.
607 Each entry in this list should be a method name as mentioned in the
608 variable `tramp-methods'."
618 "*List of connection functions for multi-hop methods.
619 Each list item is a list of three items (METHOD FUNCTION COMMAND),
620 where METHOD is the name as used in the file name, FUNCTION is the
621 function to be executed, and COMMAND is the shell command used for
622 connecting.
624 COMMAND may contain percent escapes. `%u' will be replaced with the
625 user name, `%h' will be replaced with the host name, and `%n' will be
626 replaced with an end-of-line character, as specified in the variable
627 `tramp-rsh-end-of-line'. Use `%%' for a literal percent character.
628 Note that the interpretation of the percent escapes also depends on
629 the FUNCTION. For example, the `%u' escape is forbidden with the
630 function `tramp-multi-connect-telnet'. See the documentation of the
631 various functions for details."
636 ;;(if (featurep 'xemacs) "sm" "ftp")
637 "*Default method to use for transferring files.
638 See `tramp-methods' for possibilities.
639 Also see `tramp-default-method-alist'.
641 Emacs uses a unified filename syntax for Tramp and Ange-FTP.
642 For backward compatibility, the default value of this variable
650 nil
653 "*Default method to use for specific user/host pairs.
654 This is an alist of items (HOST USER METHOD). The first matching item
655 specifies the method to use for a file name which does not specify a
656 method. HOST and USER are regular expressions or nil, which is
657 interpreted as a regular expression which always matches. If no entry
658 matches, the variable `tramp-default-method' takes effect.
660 If the file name does not specify the user, lookup is done using the
661 empty string for the user name.
663 See `tramp-methods' for a list of possibilities for METHOD."
670 "*When this method name is used, forward all calls to Ange-FTP."
675 "*String used for end of line in rsh connections.
676 I don't think this ever needs to be changed, so please tell me about it
677 if you need to change this."
685 "*List of directories to search for executables on remote host.
686 Please notify me about other semi-standard directories to include here.
688 You can use `~' in this list, but when searching for a shell which groks
689 tilde expansion, all directory names starting with `~' will be ignored."
694 ".*ogin: *"
695 "*Regexp matching login-like prompts.
696 The regexp should match at end of buffer."
702 "*Regexp matching password-like prompts.
703 The regexp should match at end of buffer.
705 The `sudo' program appears to insert a `^@' character into the prompt."
713 "*Regexp matching a `login failed' message.
714 The regexp should match at end of buffer."
720 "Regular expression matching all queries which need to be confirmed.
721 The confirmation should be done with yes or no.
722 The regexp should match at end of buffer."
727 "*Prefix to use for temporary files.
729 relative to the directory name returned by the function
730 `tramp-temporary-file-directory' (which see). It may also be an
731 absolute file name; don't forget to include a prefix for the filename
732 part, though."
737 "*If non-nil, try to discard garbage sent by remote shell.
738 Some shells send such garbage upon connection setup."
743 "*Alist specifying extra arguments to pass to the remote shell.
744 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
745 matching the shell file name and ARGS is a string specifying the
746 arguments.
748 This variable is only used when Tramp needs to start up another shell
749 for tilde expansion. The extra arguments should typically prevent the
750 shell from reading its init file."
754 ;; File name format.
762 "Default value for `tramp-file-name-structure' for unified remoting.
763 On Emacs (not XEmacs), the Tramp and Ange-FTP packages use a unified
772 "Default value for `tramp-file-name-structure' for separate remoting.
773 On XEmacs, the Tramp and EFS packages use a separate namespace for
774 remote filenames. This value is used in that case. It is designed
779 tramp-file-name-structure-separate
780 tramp-file-name-structure-unified)
781 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
782 the tramp file name structure.
784 The first element REGEXP is a regular expression matching a tramp file
785 name. The regex should contain parentheses around the method name,
786 the user name, the host name, and the file name parts.
788 The second element METHOD is a number, saying which pair of
789 parentheses matches the method name. The third element USER is
790 similar, but for the user name. The fourth element HOST is similar,
791 but for the host name. The fifth element FILE is for the file name.
792 These numbers are passed directly to `match-string', which see. That
793 means the opening parentheses are counted to identify the pair.
795 See also `tramp-file-name-regexp' and `tramp-make-tramp-file-format'."
803 ;;;###autoload
806 "Value for `tramp-file-name-regexp' for unified remoting.
807 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
810 ;;;###autoload
813 "Value for `tramp-file-name-regexp' for separate remoting.
814 XEmacs uses a separate filename syntax for Tramp and EFS.
817 ;;;###autoload
820 tramp-file-name-regexp-separate
821 tramp-file-name-regexp-unified)
822 "*Regular expression matching file names handled by tramp.
823 This regexp should match tramp file names but no other file names.
824 \(When tramp.el is loaded, this regular expression is prepended to
825 `file-name-handler-alist', and that is searched sequentially. Thus,
826 if the tramp entry appears rather early in the `file-name-handler-alist'
827 and is a bit too general, then some files might be considered tramp
828 files which are not really tramp files.
830 Please note that the entry in `file-name-handler-alist' is made when
831 this file (tramp.el) is loaded. This means that this variable must be set
832 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
833 updated after changing this variable.
835 Also see `tramp-file-name-structure' and `tramp-make-tramp-file-format'."
840 "/%m:%u@%h:%p"
841 "Value for `tramp-make-tramp-file-format' for unified remoting.
842 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and Tramp.
846 "/[%m/%u@%h]%p"
847 "Value for `tramp-make-tramp-file-format' for separate remoting.
848 XEmacs uses a separate filename syntax for EFS and Tramp.
853 tramp-make-tramp-file-format-separate
854 tramp-make-tramp-file-format-unified)
855 "*Format string saying how to construct tramp file name.
856 `%m' is replaced by the method name.
857 `%u' is replaced by the user name.
858 `%h' is replaced by the host name.
859 `%p' is replaced by the file name.
860 `%%' is replaced by %.
862 Also see `tramp-file-name-structure' and `tramp-file-name-regexp'."
867 "/%m:%h:%p"
868 "Value of `tramp-make-tramp-file-user-nil-format' for unified remoting.
869 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and Tramp.
873 "/[%m/%h]%p"
874 "Value of `tramp-make-tramp-file-user-nil-format' for separate remoting.
875 XEmacs uses a separate filename syntax for EFS and Tramp.
880 tramp-make-tramp-file-user-nil-format-separate
881 tramp-make-tramp-file-user-nil-format-unified)
882 "*Format string saying how to construct tramp file name when the user name is not known.
883 `%m' is replaced by the method name.
884 `%h' is replaced by the host name.
885 `%p' is replaced by the file name.
886 `%%' is replaced by %.
888 Also see `tramp-make-tramp-file-format', `tramp-file-name-structure', and `tramp-file-name-regexp'."
897 "Value for `tramp-multi-file-name-structure' for unified remoting.
898 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and Tramp.
903 ;; prefix
905 ;; regexp specifying the hops
907 ;; path name
912 "Value of `tramp-multi-file-name-structure' for separate remoting.
913 XEmacs uses a separate filename syntax for EFS and Tramp.
918 tramp-multi-file-name-structure-separate
919 tramp-multi-file-name-structure-unified)
920 "*Describes the file name structure of `multi' files.
921 Multi files allow you to contact a remote host in several hops.
922 This is a list of four elements (REGEXP METHOD HOP PATH).
924 The first element, REGEXP, gives a regular expression to match against
925 the file name. In this regular expression, `%s' is replaced with the
926 value of `tramp-multi-file-name-hop-structure'. (Note: in order to
927 allow multiple hops, you normally want to use something like
929 of parentheses is used for the HOP element, see below.)
931 All remaining elements are numbers. METHOD gives the number of the
932 paren pair which matches the method name. HOP gives the number of the
933 paren pair which matches the hop sequence. PATH gives the number of
934 the paren pair which matches the path name on the remote host.
936 PATH can also be negative, which means to count from the end. Ie, a
937 value of -1 means the last paren pair.
939 I think it would be good if the regexp matches the whole of the
940 string, but I haven't actually tried what happens if it doesn't..."
952 "Value of `tramp-multi-file-name-hop-structure' for unified remoting.
953 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and Tramp.
961 "Value of `tramp-multi-file-name-hop-structure' for separate remoting.
962 XEmacs uses a separate filename syntax for EFS and Tramp.
967 tramp-multi-file-name-hop-structure-separate
968 tramp-multi-file-name-hop-structure-unified)
969 "*Describes the structure of a hop in multi files.
970 This is a list of four elements (REGEXP METHOD USER HOST). First
971 element REGEXP is used to match against the hop. Pair number METHOD
972 matches the method of one hop, pair number USER matches the user of
973 one hop, pair number HOST matches the host of one hop.
975 This regular expression should match exactly all of one hop."
984 "Value of `tramp-make-multi-tramp-file-format' for unified remoting.
985 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and Tramp.
990 "Value of `tramp-make-multi-tramp-file-format' for separate remoting.
991 XEmacs uses a separate filename syntax for EFS and Tramp.
996 tramp-make-multi-tramp-file-format-separate
997 tramp-make-multi-tramp-file-format-unified)
998 "*Describes how to construct a `multi' file name.
999 This is a list of three elements PREFIX, HOP and PATH.
1001 The first element PREFIX says how to construct the prefix, the second
1002 element HOP specifies what each hop looks like, and the final element
1003 PATH says how to construct the path name.
1005 In PREFIX, `%%' means `%' and `%m' means the method name.
1007 In HOP, `%%' means `%' and `%m', `%u', `%h' mean the hop method, hop
1008 user and hop host, respectively.
1010 In PATH, `%%' means `%' and `%p' means the path name.
1012 The resulting file name always contains one copy of PREFIX and one
1013 copy of PATH, but there is one copy of HOP for each hop in the file
1014 name.
1016 Note: the current implementation requires the prefix to contain the
1017 method name, followed by all the hops, and the path name must come
1018 last."
1023 "*Value of TERM environment variable for logging in to remote host.
1024 Because Tramp wants to parse the output of the remote shell, it is easily
1025 confused by ANSI color escape sequences and suchlike. Often, shell init
1026 files conditionalize this setup based on the TERM environment variable."
1031 "*If nil, use shell wildcards for completion, else rely on Lisp only.
1032 Using shell wildcards for completions has the advantage that it can be
1033 fast even in large directories, but completion is always
1034 case-sensitive. Relying on Lisp only means that case-insensitive
1035 completion is possible (subject to the variable `completion-ignore-case'),
1036 but it might be slow on large directories."
1046 "List of pattern/action pairs.
1047 Whenever a pattern matches, the corresponding action is performed.
1048 Each item looks like (PATTERN ACTION).
1050 The PATTERN should be a symbol, a variable. The value of this
1051 variable gives the regular expression to search for. Note that the
1053 appended to it.
1055 The ACTION should also be a symbol, but a function. When the
1056 corresponding PATTERN matches, the ACTION function is called."
1065 "List of pattern/action pairs.
1066 This list is used for each hop in multi-hop connections.
1067 See `tramp-actions-before-shell' for more info."
1071 ;;; Internal Variables:
1074 "Holds the `ls -ild' output for the current buffer.
1075 This variable is local to each buffer. It is not used if the remote
1076 machine groks Perl. If it is used, it's used as an emulation for
1084 "This internal variable holds a parameter for `tramp-methods'.
1085 In the connection buffer, this variable has the value of the like-named
1089 "This internal variable holds a parameter for `tramp-methods'.
1090 In the connection buffer, this variable has the value of the like-named
1094 "This internal variable holds a parameter for `tramp-methods'.
1095 In the connection buffer, this variable has the value of the like-named
1099 "This internal variable holds a parameter for `tramp-methods'.
1100 In the connection buffer, this variable has the value of the like-named
1104 "This internal variable holds a parameter for `tramp-methods'.
1105 In the connection buffer, this variable has the value of the like-named
1109 "This internal variable holds a parameter for `tramp-methods'.
1110 In the connection buffer, this variable has the value of the like-named
1114 "This internal variable holds a parameter for `tramp-methods'.
1115 In the connection buffer, this variable has the value of the like-named
1119 "This internal variable holds a parameter for `tramp-methods'.
1120 In the connection buffer, this variable has the value of the like-named
1124 "This internal variable holds a parameter for `tramp-methods'.
1125 In the connection buffer, this variable has the value of the like-named
1129 "This internal variable holds a parameter for `tramp-methods'.
1130 In the connection buffer, this variable has the value of the like-named
1134 "This internal variable holds a parameter for `tramp-methods'.
1135 In the connection buffer, this variable has the value of the like-named
1139 "This internal variable holds a parameter for `tramp-methods'.
1140 In the connection buffer, this variable has the value of the like-named
1144 "This internal variable holds a parameter for `tramp-methods'.
1145 In the connection buffer, this variable has the value of the like-named
1148 ;; CCC `local in each buffer'?
1150 "This command is used to get a long listing with numeric user and group ids.
1151 This variable is automatically made buffer-local to each rsh process buffer
1155 "Name of `multi' connection method for this *tramp* buffer, or nil if not multi.
1156 This variable is automatically made buffer-local to each rsh process buffer
1160 "Connection method for this *tramp* buffer.
1161 This variable is automatically made buffer-local to each rsh process buffer
1165 "Remote login name for this *tramp* buffer.
1166 This variable is automatically made buffer-local to each rsh process buffer
1170 "Remote host for this *tramp* buffer.
1171 This variable is automatically made buffer-local to each rsh process buffer
1175 "Whether the `test' command groks the `-nt' switch.
1176 \(`test A -nt B' tests if file A is newer than file B.)
1177 This variable is automatically made buffer-local to each rsh process buffer
1181 "Command to use for checking if a file exists.
1182 This variable is automatically made buffer-local to each rsh process buffer
1185 ;; Perl script to implement `file-attributes' in a Lisp `read'able output.
1186 ;; If you are hacking on this, note that you get *no* output unless this
1187 ;; spits out a complete line, including the '\n' at the end.
1189 "$f = $ARGV[0];
1190 @s = lstat($f);
1195 $l, $s[3], $s[4], $s[5], $s[8] >> 16 & 0xffff, $s[8] & 0xffff,
1196 $s[9] >> 16 & 0xffff, $s[9] & 0xffff, $s[10] >> 16 & 0xffff, $s[10] & 0xffff,
1197 $s[7], $s[2], $s[1] >> 16 & 0xffff, $s[1] & 0xffff, $s[0] >> 16 & 0xffff, $s[0] & 0xffff);"
1198 )
1199 "Perl script to produce output suitable for use with `file-attributes'
1202 ;; ;; These two use uu encoding.
1203 ;; (defvar tramp-perl-encode "%s -e'\
1204 ;; print qq(begin 644 xxx\n);
1205 ;; my $s = q();
1206 ;; my $res = q();
1207 ;; while (read(STDIN, $s, 45)) {
1208 ;; print pack(q(u), $s);
1209 ;; }
1210 ;; print qq(`\n);
1211 ;; print qq(end\n);
1212 ;; '"
1213 ;; "Perl program to use for encoding a file.
1214 ;; Escape sequence %s is replaced with name of Perl binary.")
1216 ;; (defvar tramp-perl-decode "%s -ne '
1217 ;; print unpack q(u), $_;
1218 ;; '"
1219 ;; "Perl program to use for decoding a file.
1220 ;; Escape sequence %s is replaced with name of Perl binary.")
1222 ;; These two use base64 encoding.
1224 "perl -MMIME::Base64 -0777 -ne 'print encode_base64($_)'"
1225 "Perl program to use for encoding a file.
1229 "perl -MMIME::Base64 -0777 -ne 'print decode_base64($_)'"
1230 "Perl program to use for decoding a file.
1233 ; These values conform to `file-attributes' from XEmacs 21.2.
1234 ; GNU Emacs and other tools not checked.
1250 "A list of file types returned from the `stat' system call.
1256 'dos
1261 "Internal Tramp variable recording the time when the last cmd was sent.
1265 ;; New handlers should be added here. The following operations can be
1266 ;; handled using the normal primitives: file-name-as-directory,
1267 ;; file-name-directory, file-name-nondirectory,
1268 ;; file-name-sans-versions, get-file-buffer.
1270 '(
1309 . tramp-handle-dired-recursive-delete-directory)
1312 "Alist of handler functions.
1315 ;;; Internal functions which must come first.
1318 "Emit a message depending on verbosity level.
1319 First arg LEVEL says to be quiet if `tramp-verbose' is less than LEVEL. The
1320 message is emitted only if `tramp-verbose' is greater than or equal to LEVEL.
1321 Calls function `message' with FMT-STRING as control string and the remaining
1322 ARGS to actually emit the message (if applicable).
1324 This function expects to be called from the tramp buffer only!"
1331 tramp-current-multi-method tramp-current-method
1332 tramp-current-user tramp-current-host))
1335 'italic
1340 "Like `tramp-message' but temporarily switches to the tramp buffer.
1341 First three args METHOD, USER, and HOST identify the tramp buffer to use,
1342 remaining args passed to `tramp-message'."
1348 "Return point at end of line.
1349 Calls `line-end-position' or `point-at-eol' if defined, else
1350 own implementation."
1357 "Parse a Tramp filename and make components available in the body.
1359 First arg FILENAME is evaluated and dissected into its components.
1360 Second arg VAR is a symbol. It is used as a variable name to hold
1361 the filename structure. It is also used as a prefix for the variables
1362 holding the components. For example, if VAR is the symbol `foo', then
1363 `foo' will be bound to the whole structure, `foo-multi-method' will
1364 be bound to the multi-method component, and so on for `foo-method',
1365 `foo-user', `foo-host', `foo-path'.
1367 Remaining args are Lisp expressions to be evaluated (inside an implicit
1368 `progn').
1370 If VAR is nil, then we bind `v' to the structure and `multi-method',
1371 `method', `user', `host', `path' to the components."
1387 ;;; File Name Handler Functions:
1391 "Like `make-symbolic-link' for tramp files.
1392 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1393 the symlink. If LINKNAME is a Tramp file, only the path component is
1394 used as the target of the symlink.
1396 If LINKNAME is a Tramp file and the path component is relative, then
1397 it is expanded first, before the path component is taken. Note that
1398 this can give surprising results if the user/host for the source and
1399 target of the symlink differ."
1403 filename linkname ok-if-already-exists))
1411 ;; Do the 'confirm if exists' thing.
1413 ;; What to do?
1418 "File %s already exists; make it a link anyway? "
1419 l-path)))))
1423 ;; If FILENAME is a Tramp name, use just the path component.
1429 ;; Right, they are on the same host, regardless of user, method, etc.
1430 ;; We now make the link on the remote machine. This will occur as the user
1431 ;; that FILENAME belongs to.
1434 l-multi-method l-method l-user l-host
1436 cwd ln
1437 filename
1438 l-path)
1439 t)))))
1443 "Like `load' for tramp files. Not implemented!"
1449 file noerror nomessage nosuffix must-suffix))
1456 ;; The first condition is always true for absolute file names.
1457 ;; Included for safety's sake.
1461 file)))
1466 nil
1470 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
1475 t)))
1477 ;; Path manipulation functions that grok TRAMP paths...
1479 "Like `file-name-directory' but aware of TRAMP files."
1480 ;; everything except the last filename thing is the directory
1484 ;; For the following condition, two possibilities should be tried:
1485 ;; (1) (string= path "")
1486 ;; (2) (or (string= path "") (string= path "/"))
1487 ;; The second variant fails when completing a "/" directory on
1488 ;; the remote host, that is a filename which looks like
1489 ;; "/user@host:/". But maybe wildcards fail with the first variant.
1490 ;; We should do some investigation.
1492 ;; For a filename like "/[foo]", we return "/". The `else'
1493 ;; case would return "/[foo]" unchanged. But if we do that,
1494 ;; then `file-expand-wildcards' ceases to work. It's not
1495 ;; quite clear to me what's the intuition that tells that this
1496 ;; behavior is the right behavior, but oh, well.
1497 "/"
1498 ;; run the command on the path portion only
1499 ;; CCC: This should take into account the remote machine type, no?
1500 ;; --daniel <daniel@danann.net>
1502 ;; This will not recurse...
1506 "Like `file-name-nondirectory' but aware of TRAMP files."
1513 "Like `file-truename' for tramp files."
1515 ;; Ange-FTP does not support truename processing. It returns the
1516 ;; file name as-is. So that's what we do, too.
1518 filename)
1525 ;; Don't make the following value larger than necessary.
1526 ;; People expect an error message in a timely fashion when
1527 ;; something is wrong; otherwise they might think that Emacs
1528 ;; is hung. Of course, correctness has to come first.
1532 symlink-target)
1534 multi-method method user host
1539 multi-method method user host
1547 multi-method method user host
1559 ;; It's a symlink, follow it.
1561 multi-method method user host
1569 ;; It's a file.
1575 multi-method method user host
1579 multi-method method user host
1583 ;; Basic functions.
1586 "Like `file-exists-p' for tramp files."
1592 multi-method method user host
1597 ;; CCC: This should check for an error condition and signal failure
1598 ;; when something goes wrong.
1599 ;; Daniel Pittman <daniel@danann.net>
1601 "Like `file-attributes' for tramp files.
1602 Optional argument NONNUMERIC means return user and group name
1603 rather than as numbers."
1609 ;; file exists, find out stuff
1614 multi-method method user host path nonnumeric))
1617 multi-method method user host path nonnumeric))))))
1618 result))
1623 "Implement `file-attributes' for tramp files using the ls(1) command."
1625 res-inode res-filemodes res-numlinks
1626 res-uid res-gid res-size res-symlink-target)
1628 "file attributes with ls: %s"
1630 multi-method method user host path))
1632 multi-method method user host
1638 ;; parse `ls -l' output ...
1639 ;; ... inode
1655 ;; ... file mode flags
1657 ;; ... number links
1659 ;; ... uid and gid
1665 ;; ... size
1667 ;; From the file modes, figure out other stuff.
1670 ;; if symlink, find out file name pointed to
1676 ;; return data gathered
1678 ;; 0. t for directory, string (name linked to) for symbolic
1679 ;; link, or nil.
1681 ;; 1. Number of links to file.
1682 res-numlinks
1683 ;; 2. File uid.
1684 res-uid
1685 ;; 3. File gid.
1686 res-gid
1687 ;; 4. Last access time, as a list of two integers. First
1688 ;; integer has high-order 16 bits of time, second has low 16
1689 ;; bits.
1690 ;; 5. Last modification time, likewise.
1691 ;; 6. Last status change time, likewise.
1693 ;; 7. Size in bytes (-1, if number is out of range).
1694 res-size
1695 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1696 res-filemodes
1697 ;; 9. t iff file's gid would change if file were deleted and
1698 ;; recreated.
1699 nil ;hm?
1700 ;; 10. inode number.
1701 res-inode
1702 ;; 11. Device number.
1704 )))
1708 "Implement `file-attributes' for tramp files using a Perl script.
1710 The Perl command is sent to the remote machine when the connection
1711 is initially created and is kept cached by the remote shell."
1713 "file attributes with perl: %s"
1715 multi-method method user host path))
1717 multi-method method user host
1724 result))
1727 "Like `set-visited-file-modtime' for tramp files."
1736 ;; This operation is not handled by Ange-FTP!
1743 ;; We use '(0 0) as a don't-know value. See also
1744 ;; `tramp-handle-file-attributes-with-ls'.
1751 multi-method method user host
1761 nil))))
1763 ;; CCC continue here
1765 ;; This function makes the same assumption as
1766 ;; `tramp-handle-set-visited-file-modtime'.
1768 "Like `verify-visited-file-modtime' for tramp files."
1773 ;; This one requires a hack since the file name is not passed
1774 ;; on the arg list.
1776 user host path)))
1781 ;; Why does `file-attributes' return a list (HIGH
1782 ;; LOW), but `visited-file-modtime' returns a cons
1783 ;; (HIGH . LOW)?
1790 multi-method method user host
1793 user host)
1799 ;; If file does not exist, say it is not modified.
1803 "Set `tramp-buffer-file-attributes' back to nil.
1804 Tramp uses this variable as an emulation for the actual modtime of the file,
1805 if the remote host can't provide the modtime."
1809 "Like `set-file-modes' for tramp files."
1815 multi-method method user host
1821 ;; FIXME: extract the proper text from chmod's stderr.
1822 "error while changing file's mode"
1823 filename))))))
1825 ;; Simple functions using the `test' command.
1828 "Like `file-executable-p' for tramp files."
1835 "Like `file-readable-p' for tramp files."
1842 "Like `file-accessible-directory-p' for tramp files."
1850 ;; When the remote shell is started, it looks for a shell which groks
1851 ;; tilde expansion. Here, we assume that all shells which grok tilde
1852 ;; expansion will also provide a `test' command which groks `-nt' (for
1853 ;; newer than). If this breaks, tell me about it and I'll try to do
1854 ;; something smarter about it.
1856 "Like `file-newer-than-file-p' for tramp files."
1858 nil)
1860 t)
1861 ;; We are sure both files exist at this point. We assume that
1862 ;; both files are Tramp files, otherwise we issue an error
1863 ;; message. Todo: make a better error message.
1871 file1 file2))
1878 file1 file2)))
1883 file1 file2)))
1885 v1-multi-method v1-method v1-user v1-host)
1889 ;; Functions implemented using the basic functions above.
1892 "Like `file-modes' for tramp files."
1901 "Like `file-directory-p' for tramp files."
1902 ;; Care must be taken that this function returns `t' for symlinks
1903 ;; pointing to directories. Surely the most obvious implementation
1904 ;; would be `test -d', but that returns false for such symlinks.
1905 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
1906 ;; I now think he's right. So we could be using `test -d', couldn't
1907 ;; we?
1908 ;;
1909 ;; Alternatives: `cd %s', `test -d %s'
1916 multi-method method user host
1922 "Like `file-regular-p' for tramp files."
1930 "Like `file-symlink-p' for tramp files."
1938 "Like `file-writable-p' for tramp files."
1943 ;; Existing files must be writable.
1945 ;; If file doesn't exist, check if directory is writable.
1952 "Like `file-ownership-preserved-p' for tramp files."
1957 ;; Existing files must be writable.
1960 ;; Other file name ops.
1962 ;; ;; Matthias Köppe <mkoeppe@mail.math.uni-magdeburg.de>
1963 ;; (defun tramp-handle-directory-file-name (directory)
1964 ;; "Like `directory-file-name' for tramp files."
1965 ;; (if (and (eq (aref directory (- (length directory) 1)) ?/)
1966 ;; (not (eq (aref directory (- (length directory) 2)) ?:)))
1967 ;; (substring directory 0 (- (length directory) 1))
1968 ;; directory))
1970 ;; Philippe Troin <phil@fifi.org>
1972 "Like `directory-file-name' for tramp files."
1982 directory)))))
1984 ;; Directory listings.
1988 "Like `directory-files' for tramp files."
1992 directory full match nosort files-only))
1996 multi-method method user host
1998 nil
1999 'file-error
2000 "tramp-handle-directory-files: couldn't `cd %s'"
2003 multi-method method user host
2014 x)
2015 result)
2019 ;; Remove non-files or non-directories if necessary. Using
2020 ;; the remote shell for this would probably be way faster.
2021 ;; Maybe something could be adapted from
2022 ;; tramp-handle-file-name-all-completions.
2025 item)
2028 ;; files only
2033 ;; directories only
2038 result)))
2040 ;; This function should return "foo/" for directories and "bar" for
2041 ;; files. We use `ls -ad' to get a list of files (including
2042 ;; directories), and `find . -type d \! -name . -prune' to get a list
2043 ;; of directories.
2045 "Like `file-name-all-completions' for tramp files."
2049 filename directory))
2052 result)
2055 multi-method method user host
2057 nil 'file-error
2058 "tramp-handle-file-name-all-completions: Couldn't `cd %s'"
2061 ;; Get a list of directories and files, including reliably
2062 ;; tagging the directories with a trailing '/'. Because I
2063 ;; rock. --daniel@danann.net
2065 multi-method method user host
2071 ""
2075 ;; Now grab the output.
2081 result))
2086 ;; Return the list.
2089 result))))))
2092 ;; The following isn't needed for Emacs 20 but for 19.34?
2094 "Like `file-name-completion' for tramp files."
2097 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2098 directory))
2102 filename directory))
2104 filename
2108 ;; cp, mv and ln
2112 "Like `add-name-to-file' for tramp files."
2116 v1-multi-method v1-method v1-user v1-host))))
2127 filename newname ok-if-already-exists))
2130 filename newname ok-if-already-exists))
2133 filename newname ok-if-already-exists))
2139 "File %s already exists; make it a new name anyway? "
2140 newname)))
2143 v1-multi-method v1-method v1-user v1-host
2146 nil 'file-error
2147 "error with add-name-to-file, see buffer `%s' for details"
2152 "Like `copy-file' for tramp files."
2153 ;; Check if both files are local -- invoke normal copy-file.
2154 ;; Otherwise, use tramp from local system.
2157 ;; At least one file a tramp file?
2163 'copy-file
2168 "Like `rename-file' for tramp files."
2169 ;; Check if both files are local -- invoke normal rename-file.
2170 ;; Otherwise, use tramp from local system.
2173 ;; At least one file a tramp file?
2183 "Copy or rename a remote file.
2184 OP must be `copy' or `rename' and indicates the operation to perform.
2185 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2186 the new file (for copy) or the new name of the file (for rename).
2187 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2188 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2189 as FILENAME.
2191 This function is invoked by `tramp-handle-copy-file' and
2192 `tramp-handle-rename-file'. It is an error if OP is neither of `copy'
2193 and `rename'. FILENAME and NEWNAME must be absolute file names."
2202 ;; Check which ones of source and target are Tramp files.
2205 ;; Both are Tramp files.
2208 ;; Possibly invoke Ange-FTP.
2213 filename newname ok-if-already-exists keep-date))
2214 ;; Check if we can use a shortcut.
2219 ;; Shortcut: if method, host, user are the same for both
2220 ;; files, we invoke `cp' or `mv' on the remote host
2221 ;; directly.
2223 op v1-multi-method v1-method v1-user v1-host
2224 v1-path v2-path keep-date)
2225 ;; The shortcut was not possible. So we copy the
2226 ;; file first. If the operation was `rename', we go
2227 ;; back and delete the original file (if the copy was
2228 ;; successful). The approach is simple-minded: we
2229 ;; create a new buffer, insert the contents of the
2230 ;; source file into it, then write out the buffer to
2231 ;; the target file. The advantage is that it doesn't
2232 ;; matter which filename handlers are used for the
2233 ;; source and target file.
2235 ;; CCC: If both source and target are Tramp files,
2236 ;; and both are using the same rcp-program, then we
2237 ;; can invoke rcp directly. Note that
2238 ;; default-directory should point to a local
2239 ;; directory if we want to invoke rcp.
2241 op filename newname keep-date)))))
2243 ;; Use the generic method via a Tramp buffer.
2246 ;; One of them must be a Tramp file.
2250 "Use an Emacs buffer to copy or rename a file.
2251 First arg OP is either `copy' or `rename' and indicates the operation.
2252 FILENAME is the source file, NEWNAME the target file.
2253 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2264 ;; If the operation was `rename', delete the original file.
2270 "Invokes `cp' or `mv' on the remote system.
2271 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2272 respectively. METHOD, USER, and HOST specify the connection.
2273 PATH1 and PATH2 specify the two arguments of `cp' or `mv'.
2274 If KEEP-DATE is non-nil, preserve the time stamp when copying."
2275 ;; CCC: What happens to the timestamp when renaming?
2280 "Unknown operation `%s', must be `copy' or `rename'"
2281 op)))))
2284 multi-method method user host
2286 cmd
2289 nil 'file-error
2290 "Copying directly failed, see buffer `%s' for details."
2293 ;; mkdir
2295 "Like `make-directory' for tramp files."
2301 multi-method method user host
2305 nil 'file-error
2308 ;; CCC error checking?
2310 "Like `delete-directory' for tramp files."
2317 multi-method method user host
2323 "Like `delete-file' for tramp files."
2330 multi-method method user host
2335 ;; Dired.
2337 ;; CCC: This does not seem to be enough. Something dies when
2338 ;; we try and delete two directories under TRAMP :/
2340 "Recursively delete the directory given.
2341 This is like `dired-recursive-delete-directory' for tramp files."
2345 filename))
2346 ;; run a shell command 'rm -r <path>'
2347 ;; Code shamelessly stolen for the dired implementation and, um, hacked :)
2350 'file-error
2352 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
2355 ;; Wait for the remote system to return to us...
2356 ;; This might take a while, allow it plenty of time.
2358 ;; Make sure that it worked...
2364 "Like `dired-call-process' for tramp files."
2370 program discard arguments)))
2373 multi-method method user host
2375 nil 'file-error
2376 "tramp-handle-dired-call-process: Couldn't `cd %s'"
2379 multi-method method user host
2390 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
2391 ;; not sure at all that this is the right way to do it, but let's hope
2392 ;; it works for now, and wait for a guru to point out the Right Way to
2393 ;; achieve this.
2394 ;;(eval-when-compile
2395 ;; (unless (fboundp 'dired-insert-set-properties)
2396 ;; (fset 'dired-insert-set-properties 'ignore)))
2397 ;; Gerd suggests this:
2399 ;; Note that dired is required at run-time, too, when it is needed.
2400 ;; It is only needed on XEmacs for the function
2401 ;; `dired-insert-set-properties'.
2405 "Like `insert-directory' for tramp files."
2410 filename switches wildcard full-directory-p))
2412 multi-method method user host 10
2413 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
2426 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2427 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2430 multi-method method user host
2433 switches
2435 path
2438 multi-method method user host
2441 nil 'file-error
2442 "Couldn't `cd %s'"
2445 multi-method method user host
2448 switches
2450 ;; Add "/." to make sure we got complete dir
2451 ;; listing for symlinks, too.
2458 ;; On XEmacs, we want to call (exchange-point-and-mark t), but
2459 ;; that doesn't exist on Emacs, so we use this workaround instead.
2460 ;; Since zmacs-region-stays doesn't exist in Emacs, this ought to
2461 ;; be safe. Thanks to Daniel Pittman <daniel@danann.net>.
2467 ;; Another XEmacs specialty follows. What's the right way to do
2468 ;; it?
2475 ;; Continuation of kluge to pacify byte-compiler.
2476 ;;(eval-when-compile
2477 ;; (when (eq (symbol-function 'dired-insert-set-properties) 'ignore)
2478 ;; (fmakunbound 'dired-insert-set-properties)))
2480 ;; CCC is this the right thing to do?
2482 "Like `unhandled-file-name-directory' for tramp files."
2486 filename))
2489 ;; Canonicalization of file names.
2492 "Cut off unnecessary drive letter from file NAME.
2493 The function `tramp-handle-expand-file-name' calls `expand-file-name'
2494 locally on a remote file name. When the local system is a W32 system
2495 but the remote system is Unix, this introduces a superfluous drive
2496 letter into the file name. This function removes it.
2498 Doesn't do anything if the NAME does not start with a drive letter."
2505 name))
2508 "Like `expand-file-name' for tramp files."
2509 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2511 ;; Unless NAME is absolute, concat DIR and NAME.
2514 ;; If NAME is not a tramp file, run the real handler
2518 ;; Dissect NAME.
2525 ;; Tilde expansion if necessary. This needs a shell which
2526 ;; groks tilde expansion! The function `tramp-find-shell' is
2527 ;; supposed to find such a shell on the remote host. Please
2528 ;; tell me about it when this doesn't work on your system.
2532 ;; CCC fanatic error checking?
2536 multi-method method user host
2538 t)
2544 ;; No tilde characters in file name, do normal
2545 ;; expand-file-name (this does "/./" and "/../"). We bind
2546 ;; directory-sep-char here for XEmacs on Windows, which would
2547 ;; otherwise use backslash.
2550 multi-method method user host
2554 ;; Remote commands.
2557 "Like `shell-command' for tramp files.
2558 This will break if COMMAND prints a newline, followed by the value of
2559 `tramp-end-of-output', followed by another newline."
2564 user host path)))
2566 command output-buffer error-buffer)))
2574 multi-method method user host
2576 nil 'file-error
2577 "tramp-handle-shell-command: Couldn't `cd %s'"
2581 ;; This will break if the shell command prints "/////"
2582 ;; somewhere. Let's just hope for the best...
2596 multi-method method user host
2607 status)))
2608 ;; The following is only executed if something strange was
2609 ;; happening. Emit a helpful message and do it anyway.
2611 default-directory)
2615 ;; File Editing.
2623 "Like `file-local-copy' for tramp files."
2628 tmpfil)
2631 filename))
2634 ;; Use rcp-like program for file transfer.
2636 multi-method method user host
2640 0
2643 nil trampbuf nil
2647 user host
2649 tmpfil))))
2656 multi-method method user host
2660 ;; Use inline encoding for file transfer.
2662 ;; Following line for setting tramp-current-method,
2663 ;; tramp-current-user, tramp-current-host.
2667 multi-method method user host
2670 nil 'file-error
2671 "Encoding remote file failed, see buffer `%s' for details"
2673 ;; Remove trailing status code
2680 multi-method method user host)))
2681 ;; If tramp-decoding-function is defined for this
2682 ;; method, we call it.
2687 user host))
2689 multi-method method user host
2691 filename
2696 multi-method method user host)
2701 ;; If tramp-decoding-function is not defined for this
2702 ;; method, we invoke tramp-decoding-command instead.
2707 filename
2710 tramp-sh-program
2711 tmpfil2 ;input
2712 nil ;output
2713 nil ;display
2715 multi-method method user host)
2719 multi-method method user host
2723 tmpfil)))
2728 "Like `insert-file-contents' for tramp files."
2734 filename visit beg end replace))
2752 multi-method method user host
2757 ;; Now `last-coding-system-used' has right value. Remember it.
2767 ;; CCC grok APPEND, LOCKNAME, CONFIRM
2770 "Like `write-region' for tramp files."
2774 ;; Following part commented out because we don't know what to do about
2775 ;; file locking, and it does not appear to be a problem to ignore it.
2776 ;; Ange-ftp ignores it, too.
2777 ;; (when (and lockname (stringp lockname))
2778 ;; (setq lockname (expand-file-name lockname)))
2779 ;; (unless (or (eq lockname nil)
2780 ;; (string= lockname filename))
2781 ;; (error
2782 ;; "tramp-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
2783 ;; XEmacs takes a coding system as the sevent argument, not `confirm'
2787 filename))
2792 start end filename append visit lockname confirm))
2803 ;; We use this to save the value of `last-coding-system-used'
2804 ;; after writing the tmp file. At the end of the function,
2805 ;; we set `last-coding-system-used' to this saved value.
2806 ;; This way, any intermediary coding systems used while
2807 ;; talking to the remote shell or suchlike won't hose this
2808 ;; variable. This approach was snarfed from ange-ftp.el.
2809 coding-system-used
2810 tmpfil)
2811 ;; Write region into a tmp file. This isn't really needed if we
2812 ;; use an encoding function, but currently we use it always
2813 ;; because this makes the logic simpler.
2815 ;; We say `no-message' here because we don't want the visited file
2816 ;; modtime data to be clobbered from the temp file. We call
2817 ;; `set-visited-file-modtime' ourselves later on.
2819 'write-region
2823 ;; Now, `last-coding-system-used' has the right value. Remember it.
2826 ;; This is a bit lengthy due to the different methods possible for
2827 ;; file transfer. First, we check whether the method uses an rcp
2828 ;; program. If so, we call it. Otherwise, both encoding and
2829 ;; decoding command must be specified. However, if the method
2830 ;; _also_ specifies an encoding function, then that is used for
2831 ;; encoding the contents of the tmp file.
2833 ;; use rcp-like program for file transfer
2836 tmpfil
2838 user host
2841 multi-method method user host
2847 method user host))
2854 rcp-program nil trampbuf nil argl))
2857 "Cannot write region to file `%s', command `%s' failed"
2858 filename rcp-program))
2860 multi-method method user host
2862 rcp-program)))
2864 ;; Use inline file transfer
2867 ;; Encode tmpfil into tmpbuf
2872 ;; Use encoding function or command.
2877 multi-method method user host
2880 ;; CCC. The following `let' is a workaround for
2881 ;; the base64.el that comes with pgnus-0.84. If
2882 ;; both of the following conditions are
2883 ;; satisfied, it tries to write to a local file
2884 ;; in default-directory, but at this point,
2885 ;; default-directory is remote.
2886 ;; (CALL-PROCESS-REGION can't write to remote
2887 ;; files, it seems.) The file in question is a
2888 ;; tmp file anyway.
2896 multi-method method user host
2900 tramp-sh-program
2901 tmpfil ;input = local tmp file
2902 t ;output is current buffer
2903 nil ;don't redisplay
2904 "-c"
2905 encoding-command))
2909 filename encoding-command)))
2910 ;; Send tmpbuf into remote decoding command which
2911 ;; writes to remote file. Because this happens on the
2912 ;; remote host, we cannot use the function.
2914 multi-method method user host
2917 multi-method method user host
2919 decoding-command
2923 multi-method method user host
2927 ;; wait for remote decoding to complete
2929 multi-method method user host
2934 multi-method method user host 6
2939 multi-method method user host nil nil 'file-error
2942 filename decoding-command)
2944 filename)
2950 method)))
2957 ;; Make `last-coding-system-used' have the right value.
2965 ;; Call down to the real handler.
2966 ;; Because EFS does not play nicely with TRAMP (both systems match an
2967 ;; TRAMP path) it is needed to disable efs as well as tramp for the
2968 ;; operation.
2969 ;;
2970 ;; Other than that, this is the canon file-handler code that the doco
2971 ;; says should be used here. Which is nice.
2972 ;;
2973 ;; Under XEmacs current, EFS also hooks in as
2974 ;; efs-sifn-handler-function to handle any path with environment
2975 ;; variables. This has two implications:
2976 ;; 1) That EFS may not be completely dead (yet) for TRAMP paths
2977 ;; 2) That TRAMP might want to do the same thing.
2978 ;; Details as they come in.
2979 ;;
2980 ;; Daniel Pittman <daniel@danann.net>
2982 ;; (defun tramp-run-real-handler (operation args)
2983 ;; "Invoke normal file name handler for OPERATION.
2984 ;; This inhibits EFS and Ange-FTP, too, because they conflict with tramp.
2985 ;; First arg specifies the OPERATION, remaining ARGS are passed to the
2986 ;; OPERATION."
2987 ;; (let ((inhibit-file-name-handlers
2988 ;; (list 'tramp-file-name-handler
2989 ;; 'efs-file-handler-function
2990 ;; 'ange-ftp-hook-function
2991 ;; (and (eq inhibit-file-name-operation operation)
2992 ;; inhibit-file-name-handlers)))
2993 ;; (inhibit-file-name-operation operation))
2994 ;; (apply operation args)))
2997 "Invoke normal file name handler for OPERATION.
2998 First arg specifies the OPERATION, second arg is a list of arguments to
2999 pass to the OPERATION."
3003 inhibit-file-name-handlers)))
3007 ;; Main function.
3008 ;;;###autoload
3010 "Invoke tramp file name handler.
3011 Falls back to normal file name handler if no tramp file name handler exists."
3018 ;; Register in file name handler alist
3019 ;;;###autoload
3023 ;; To handle EFS, the following functions need to be dealt with:
3024 ;;
3025 ;; * dired-before-readin-hook contains efs-dired-before-readin
3026 ;; * file-name-handler-alist contains efs-file-handler-function
3027 ;; and efs-root-handler-function and efs-sifn-handler-function
3028 ;; * find-file-hooks contains efs-set-buffer-mode
3029 ;;
3030 ;; But it won't happen for EFS since the XEmacs maintainers
3031 ;; don't want to use a unified filename syntax.
3033 "Turn Ange-FTP off.
3034 This is useful for unified remoting. See
3035 `tramp-file-name-structure-unified' and
3036 `tramp-file-name-structure-separate' for details. Requests suitable
3037 for Ange-FTP will be forwarded to Ange-FTP. Also see the variables
3038 `tramp-ftp-method', `tramp-default-method', and
3039 `tramp-default-method-alist'.
3041 This function is not needed in Emacsen which include Tramp, but is
3042 present for backward compatibility."
3050 "If jka-compr is already loaded, move it to the front of
3051 `file-name-handler-alist'. On Emacs 21.4 or so this will not be
3052 necessary anymore."
3060 "Invoke the Ange-FTP handler function and throw."
3071 "Check if it's a filename that should be forwarded to Ange-FTP."
3075 ;;; Interactions with other packages:
3077 ;; -- complete.el --
3079 ;; This function contributed by Ed Sabol
3081 "Like `PC-expand-many-files' for tramp files."
3090 ;; Dissect NAME.
3092 ;; Perhaps invoke Ange-FTP.
3095 ;; CCC: To do it right, we should quote certain characters
3096 ;; in the file name, but since the echo command is going to
3097 ;; break anyway when there are spaces in the file names, we
3098 ;; don't bother.
3099 ;;-(let ((comint-file-name-quote-list
3100 ;;- (set-difference tramp-file-name-quote-list
3101 ;;- '(?\* ?\? ?[ ?]))))
3102 ;;- (tramp-send-command
3103 ;;- multi-method method user host
3104 ;;- (format "echo %s" (comint-quote-filename path)))
3105 ;;- (tramp-wait-for-output))
3113 nil
3125 user host x)))
3129 ;; Check for complete.el and override PC-expand-many-files if appropriate.
3141 ;; Why isn't eval-after-load sufficient?
3149 ;;; Internal Functions:
3154 auto-save-default)
3159 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3160 Returns the exit code of the `test' program."
3170 "Run `test'-like PROGRAM on the remote system, given FILE1, FILE2.
3171 The optional SWITCH is inserted between the two files.
3172 Returns the exit code of the `test' PROGRAM. Barfs if the methods,
3173 hosts, or files, disagree."
3195 mmethod1 method1 user1 host1
3197 program
3203 "A name for the connection buffer for USER at HOST using METHOD."
3212 "A name for the multi method connection buffer.
3213 MULTI-METHOD gives the multi method, METHOD the array of methods,
3214 USER the array of user names, HOST the array of host names."
3220 string-list)
3227 string-list))
3230 prefix multi-method
3234 "Get the connection buffer to be used for USER at HOST using METHOD."
3238 "A name for the debug buffer for USER at HOST using METHOD."
3241 multi-method method user host))
3248 "Get the debug buffer for USER at HOST using METHOD."
3252 progname dirlist ignore-tilde)
3253 "Searches for PROGNAME in all directories mentioned in DIRLIST.
3254 First args METHOD, USER and HOST specify the connection, PROGNAME
3255 is the program to search for, and DIRLIST gives the list of directories
3256 to search. If IGNORE-TILDE is non-nil, directory names starting
3257 with `~' will be ignored.
3259 Returns the full path name of PROGNAME, if found, and nil otherwise.
3261 This function expects to be in the right *tramp* buffer."
3264 ;; Remove all ~/foo directories from dirlist. In Emacs 20,
3265 ;; `remove' is in CL, and we want to avoid CL dependencies.
3274 multi-method method user host
3276 "do if test -x $d/%s -a -f $d/%s; "
3277 "then echo tramp_executable $d/%s; "
3279 progname progname progname))
3282 dirlist)
3292 "Sets the remote environment VAR to existing directories from DIRLIST.
3293 I.e., for each directory in DIRLIST, it is tested whether it exists and if
3294 so, it is added to the environment variable VAR."
3303 x))
3304 dirlist)))
3306 multi-method method user host
3312 ;; -- communication with external shell --
3315 "Find a command on the remote host for checking if a file exists.
3316 Here, we are looking for a command which has zero exit status if the
3317 file exists and nonzero exit status otherwise."
3322 multi-method method user host
3326 multi-method method user host
3328 ;; The algorithm is as follows: we try a list of several commands.
3329 ;; For each command, we first run `$cmd /' -- this should return
3330 ;; true, as the root directory always exists. And then we run
3331 ;; `$cmd /this\ file\ does\ not\ exist', hoping that the file indeed
3332 ;; does not exist. This should return false. We use the first
3333 ;; command we find that seems to work.
3334 ;; The list of commands to try is as follows:
3335 ;; `ls -d' This works on most systems, but NetBSD 1.4
3336 ;; has a bug: `ls' always returns zero exit
3337 ;; status, even for files which don't exist.
3338 ;; `test -e' Some Bourne shells have a `test' builtin
3339 ;; which does not know the `-e' option.
3340 ;; `/bin/test -e' For those, the `test' binary on disk normally
3341 ;; provides the option. Alas, the binary
3342 ;; is sometimes `/bin/test' and sometimes it's
3343 ;; `/usr/bin/test'.
3344 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3361 ;; CCC test ksh or bash found for tilde expansion?
3363 "Find a shell on the remote host which groks tilde expansion."
3376 ;; Find arguments for this shell.
3378 item extra-args)
3387 multi-method method user host
3395 tramp-rsh-end-of-line
3396 tramp-end-of-output
3397 tramp-rsh-end-of-line
3398 tramp-rsh-end-of-line))
3412 "Checks whether the given `ls' executable groks `-n'.
3413 METHOD, USER and HOST specify the connection, CMD (the full path name of)
3414 the `ls' executable. Returns t if CMD supports the `-n' option, nil
3415 otherwise."
3417 cmd)
3424 multi-method method user host
3426 cmd)))
3428 cmd
3433 "Checks whether the given `ls' executable in one of the dirs groks `-n'.
3434 Returns nil if none was found, else the command is returned."
3437 ;; It would be better to use the CL function `find', but
3438 ;; we don't want run-time dependencies on CL.
3444 result))
3447 "Finds an `ls' command which groks the `-n' option, returning nil if failed.
3448 \(This option prints numeric user and group ids in a long listing.)"
3455 ;; ------------------------------------------------------------
3456 ;; -- Functions for establishing connection --
3457 ;; ------------------------------------------------------------
3459 ;; The following functions are actions to be taken when seeing certain
3460 ;; prompts from the remote host. See the variable
3461 ;; `tramp-actions-before-shell' for usage of these functions.
3464 "Send the login name."
3469 tramp-rsh-end-of-line)))
3472 "Query the user for a password."
3477 method))
3481 "Signal success in finding shell prompt."
3487 "Signal permission denied."
3494 "Ask the user if he is sure."
3504 ;; The following functions are specifically for multi connections.
3507 "Send the login name."
3513 "Query the user for a password."
3517 "Signal success in finding shell prompt."
3523 "Signal permission denied."
3529 ;; Functions for processing the actions.
3532 "Wait for output from the shell and perform one action."
3549 found)))
3552 "Perform actions until success."
3559 p multi-method method user host actions)
3560 nil)))
3564 ;; For multi-actions.
3567 "Wait for output from the shell and perform one action."
3584 found)))
3587 "Perform actions until success."
3593 nil)))
3597 ;; The actual functions for opening connections.
3600 "Open a connection using a telnet METHOD.
3601 This starts the command `telnet HOST ARGS'[*], then waits for a remote
3602 login prompt, then sends the user name USER, then waits for a remote
3603 password prompt. It queries the user for the password, then sends the
3604 password to the remote host.
3606 If USER is nil, uses value returned by `(user-login-name)' instead.
3608 Recognition of the remote shell prompt is based on the variable
3609 `shell-prompt-pattern' which must be set up correctly.
3611 Please note that it is NOT possible to use this connection method
3612 together with an out-of-band transfer method! You must use an inline
3613 transfer method.
3615 Maybe the different regular expressions need to be tuned.
3617 * Actually, the telnet program as well as the args to be used can be
3618 specified in the method parameters, see the variable `tramp-methods'."
3622 method))
3633 tramp-dos-coding-system))
3638 host
3646 tramp-actions-before-shell)
3648 ;; (tramp-message 9 "Waiting for login prompt...")
3649 ;; (unless (tramp-wait-for-regexp p nil tramp-login-prompt-regexp)
3650 ;; (pop-to-buffer (buffer-name))
3651 ;; (kill-process p)
3652 ;; (error "Couldn't find remote login prompt"))
3653 ;; (erase-buffer)
3654 ;; ;; Remote login defaults to local one.
3655 ;; (tramp-message 9 "Sending login name %s" (or user (user-login-name)))
3656 ;; (process-send-string p (concat (or user (user-login-name))
3657 ;; tramp-rsh-end-of-line))
3658 ;; (tramp-message 9 "Waiting for password prompt...")
3659 ;; (unless (setq found (tramp-wait-for-regexp
3660 ;; p nil tramp-password-prompt-regexp))
3661 ;; (pop-to-buffer (buffer-name))
3662 ;; (kill-process p)
3663 ;; (error "Couldn't find remote password prompt"))
3664 ;; (erase-buffer)
3665 ;; (setq pw (tramp-read-passwd (car found)))
3666 ;; (tramp-message 9 "Sending password")
3667 ;; (process-send-string p (concat pw tramp-rsh-end-of-line))
3668 ;; (tramp-message 9 "Waiting 30s for remote shell to come up...")
3669 ;; (unless (setq found
3670 ;; (tramp-wait-for-regexp
3671 ;; p 30 (format "\\(%s\\)\\|\\(%s\\)\\'"
3672 ;; tramp-wrong-passwd-regexp
3673 ;; shell-prompt-pattern)))
3674 ;; (pop-to-buffer (buffer-name))
3675 ;; (kill-process p)
3676 ;; (error "Couldn't find remote shell prompt"))
3677 ;; (when (nth 1 found)
3678 ;; (pop-to-buffer (buffer-name))
3679 ;; (kill-process p)
3680 ;; (error "Login failed: %s" (nth 1 found)))
3683 p multi-method method user host)
3688 "Open a connection using an rsh METHOD.
3689 This starts the command `rsh HOST -l USER'[*], then waits for a remote
3690 password or shell prompt. If a password prompt is seen, the user is
3691 queried for a password, this function sends the password to the remote
3692 host and waits for a shell prompt.
3694 If USER is nil, start the command `rsh HOST'[*] instead
3696 Recognition of the remote shell prompt is based on the variable
3697 `shell-prompt-pattern' which must be set up correctly.
3699 Please note that it is NOT possible to use this connection method with
3700 an out-of-band transfer method if this function asks the user for a
3701 password! You must use an inline transfer method in this case.
3702 Sadly, the transfer method cannot be switched on the fly, instead you
3703 must specify the right method in the file name.
3707 arguments, and xx will be used as the host name to connect to.
3709 * Actually, the rsh program to be used can be specified in the
3710 method parameters, see the variable `tramp-methods'."
3717 user host method)
3724 ;; The following should be changed. We need a more general
3725 ;; mechanism to parse extra host args.
3733 tramp-dos-coding-system))
3738 host rsh-args)))
3744 tramp-actions-before-shell)
3746 ;; (tramp-message 9 "Waiting 60s for shell or passwd prompt from %s" host)
3747 ;; (setq found
3748 ;; (tramp-wait-for-regexp
3749 ;; p 60
3750 ;; (format
3751 ;; "\\(%s\\)\\|\\(%s\\)\\'"
3752 ;; tramp-password-prompt-regexp
3753 ;; shell-prompt-pattern)))
3754 ;; (unless found
3755 ;; (pop-to-buffer (buffer-name))
3756 ;; (kill-process p)
3757 ;; (error "Couldn't find remote shell or passwd prompt"))
3758 ;; (when (nth 1 found)
3759 ;; (when (tramp-method-out-of-band-p multi-method method)
3760 ;; (pop-to-buffer (buffer-name))
3761 ;; (kill-process p)
3762 ;; (error (concat "Out of band method `%s' not applicable"
3763 ;; " for remote shell asking for a password")
3764 ;; method))
3765 ;; (erase-buffer)
3766 ;; (tramp-message 9 "Sending password...")
3767 ;; (tramp-enter-password p (nth 1 found))
3768 ;; (tramp-message 9 "Sent password, waiting 60s for remote shell prompt")
3769 ;; (setq found (tramp-wait-for-regexp p 60
3770 ;; (format "\\(%s\\)\\|\\(%s\\)\\'"
3771 ;; tramp-wrong-passwd-regexp
3772 ;; shell-prompt-pattern))))
3773 ;; (unless found
3774 ;; (pop-to-buffer (buffer-name))
3775 ;; (kill-process p)
3776 ;; (error "Couldn't find remote shell prompt"))
3777 ;; (when (nth 1 found)
3778 ;; (pop-to-buffer (buffer-name))
3779 ;; (kill-process p)
3780 ;; (error "Login failed: %s" (nth 1 found)))
3784 p multi-method method user host)
3788 "Open a connection using the `su' program with METHOD.
3789 This starts `su - USER', then waits for a password prompt. The HOST
3790 name must be equal to the local host name or to `localhost'.
3792 If USER is nil, uses value returned by user-login-name instead.
3794 Recognition of the remote shell prompt is based on the variable
3795 `shell-prompt-pattern' which must be set up correctly. Note that the
3796 other user may have a different shell prompt than you do, so it is not
3797 at all unlikely that this variable is set up wrongly!"
3801 method))
3806 "Cannot connect to different host `%s' with `su' connection method"
3807 host))
3818 tramp-dos-coding-system))
3832 tramp-actions-before-shell)
3834 ;; (tramp-message 9 "Waiting 30s for shell or password prompt...")
3835 ;; (unless (setq found (tramp-wait-for-regexp
3836 ;; p 30
3837 ;; (format "\\(%s\\)\\|\\(%s\\)\\'"
3838 ;; tramp-password-prompt-regexp
3839 ;; shell-prompt-pattern)))
3840 ;; (pop-to-buffer (buffer-name))
3841 ;; (kill-process p)
3842 ;; (error "Couldn't find shell or password prompt"))
3843 ;; (when (nth 1 found)
3844 ;; (erase-buffer)
3845 ;; (setq pw (tramp-read-passwd (car found)))
3846 ;; (tramp-message 9 "Sending password")
3847 ;; (process-send-string p (concat pw tramp-rsh-end-of-line))
3848 ;; (tramp-message 9 "Waiting 30s for remote shell to come up...")
3849 ;; (unless (setq found
3850 ;; (tramp-wait-for-regexp
3851 ;; p 30 (format "\\(%s\\)\\|\\(%s\\)\\'"
3852 ;; tramp-wrong-passwd-regexp
3853 ;; shell-prompt-pattern)))
3854 ;; (pop-to-buffer (buffer-name))
3855 ;; (kill-process p)
3856 ;; (error "Couldn't find remote shell prompt"))
3857 ;; (when (nth 1 found)
3858 ;; (pop-to-buffer (buffer-name))
3859 ;; (kill-process p)
3860 ;; (error "`su' failed: %s" (nth 1 found))))
3863 p multi-method method user host)
3865 user host)))))
3867 ;; HHH: Not Changed. Multi method. It is not clear to me how this can
3868 ;; handle not giving a user name in the "file name".
3869 ;;
3870 ;; This is more difficult than for the single-hop method. In the
3871 ;; multi-hop-method, the desired behaviour should be that the
3872 ;; user must specify names for the telnet hops of which the user
3873 ;; name is different than the "original" name (or different from
3874 ;; the previous hop.
3876 "Open a multi-hop connection using METHOD.
3877 This uses a slightly changed file name syntax. The idea is to say
3878 [multi/telnet:u1@h1/rsh:u2@h2]/path/to/file
3879 This will use telnet to log in as u1 to h1, then use rsh from there to
3880 log in as u2 to h2."
3902 tramp-dos-coding-system))
3905 tramp-multi-sh-program))
3915 ;; Now do all the connections as specified.
3923 ;; The multi-funcs don't need to do save-match-data, as that
3924 ;; is done here.
3929 p multi-method method user host)
3932 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
3933 ;; of no user name provided. Hack to make it work as it did before:
3934 ;; changed `user' to `(or user (user-login-name))' in the places where
3935 ;; the value is actually used.
3937 "Issue `telnet' command.
3938 Uses shell COMMAND to issue a `telnet' command to log in as USER to
3939 HOST. You can use percent escapes in COMMAND: `%h' is replaced with
3940 the host name, and `%n' is replaced with an end of line character, as
3941 set in `tramp-rsh-end-of-line'. Use `%%' if you want a literal percent
3942 character.
3944 If USER is nil, uses the return value of (user-login-name) instead."
3948 found pw)
3953 tramp-multi-actions)
3955 ;; (tramp-message 9 "Waiting 30s for login prompt from %s" host)
3956 ;; (unless (tramp-wait-for-regexp p 30 tramp-login-prompt-regexp)
3957 ;; (pop-to-buffer (buffer-name))
3958 ;; (kill-process p)
3959 ;; (error "Couldn't find login prompt from host %s" host))
3960 ;; (erase-buffer)
3961 ;; (tramp-message 9 "Sending login name %s" (or user (user-login-name)))
3962 ;; (process-send-string p (concat (or user (user-login-name)) tramp-rsh-end-of-line))
3963 ;; (tramp-message 9 "Waiting for password prompt")
3964 ;; (unless (setq found (tramp-wait-for-regexp p nil tramp-password-prompt-regexp))
3965 ;; (pop-to-buffer (buffer-name))
3966 ;; (kill-process p)
3967 ;; (error "Couldn't find password prompt from host %s" host))
3968 ;; (erase-buffer)
3969 ;; (setq pw (tramp-read-passwd
3970 ;; (format "Password for %s@%s, %s" (or user (user-login-name)) host found)))
3971 ;; (tramp-message 9 "Sending password")
3972 ;; (process-send-string p (concat pw tramp-rsh-end-of-line))
3973 ;; (tramp-message 9 "Waiting 60s for remote shell to come up...")
3974 ;; (unless (setq found (tramp-wait-for-regexp
3975 ;; p 60 (format "\\(%s\\)\\|\\(%s\\)\\'"
3976 ;; tramp-wrong-passwd-regexp
3977 ;; shell-prompt-pattern)))
3978 ;; (pop-to-buffer (buffer-name))
3979 ;; (kill-process p)
3980 ;; (error "Couldn't find shell prompt from host %s" host))
3981 ;; (when (nth 1 found)
3982 ;; (pop-to-buffer (buffer-name))
3983 ;; (kill-process p)
3984 ;; (error "Login to %s failed: %s" (nth 2 found)))
3985 ))
3987 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
3988 ;; of no user name provided. Hack to make it work as it did before:
3989 ;; changed `user' to `(or user (user-login-name))' in the places where
3990 ;; the value is actually used.
3992 "Issue `rlogin' command.
3993 Uses shell COMMAND to issue an `rlogin' command to log in as USER to
3994 HOST. You can use percent escapes in COMMAND. `%u' will be replaced
3995 with the user name, `%h' will be replaced with the host name, and `%n'
3996 will be replaced with the value of `tramp-rsh-end-of-line'. You can use
3997 `%%' if you want to use a literal percent character.
3999 If USER is nil, uses the return value of (user-login-name) instead."
4006 found)
4011 tramp-multi-actions)
4012 ;; (tramp-message 9 "Waiting 60s for shell or passwd prompt from %s" host)
4013 ;; (unless (setq found
4014 ;; (tramp-wait-for-regexp p 60
4015 ;; (format "\\(%s\\)\\|\\(%s\\)\\'"
4016 ;; tramp-password-prompt-regexp
4017 ;; shell-prompt-pattern)))
4018 ;; (pop-to-buffer (buffer-name))
4019 ;; (kill-process p)
4020 ;; (error "Couldn't find remote shell or passwd prompt"))
4021 ;; (when (nth 1 found)
4022 ;; (erase-buffer)
4023 ;; (tramp-message 9 "Sending password...")
4024 ;; (tramp-enter-password p (nth 1 found))
4025 ;; (tramp-message 9 "Sent password, waiting 60s for remote shell prompt")
4026 ;; (setq found (tramp-wait-for-regexp p 60
4027 ;; (format "\\(%s\\)\\|\\(%s\\)\\'"
4028 ;; tramp-wrong-passwd-regexp
4029 ;; shell-prompt-pattern))))
4030 ;; (unless found
4031 ;; (pop-to-buffer (buffer-name))
4032 ;; (kill-process p)
4033 ;; (error "Couldn't find remote shell prompt"))
4034 ;; (when (nth 1 found)
4035 ;; (pop-to-buffer (buffer-name))
4036 ;; (kill-process p)
4037 ;; (error "Login failed: %s" (nth 1 found)))
4038 ))
4040 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
4041 ;; of no user name provided. Hack to make it work as it did before:
4042 ;; changed `user' to `(or user (user-login-name))' in the places where
4043 ;; the value is actually used.
4045 "Issue `su' command.
4046 Uses shell COMMAND to issue a `su' command to log in as USER on
4047 HOST. The HOST name is ignored, this just changes the user id on the
4048 host currently logged in to.
4050 If USER is nil, uses the return value of (user-login-name) instead.
4052 You can use percent escapes in the COMMAND. `%u' is replaced with the
4053 user name, and `%n' is replaced with the value of
4054 `tramp-rsh-end-of-line'. Use `%%' if you want a literal percent
4055 character."
4060 found)
4065 tramp-multi-actions)
4066 ;; (tramp-message 9 "Waiting 60s for shell or passwd prompt for %s" (or user (user-login-name)))
4067 ;; (unless (setq found (tramp-wait-for-regexp
4068 ;; p 60 (format "\\(%s\\)\\|\\(%s\\)\\'"
4069 ;; tramp-password-prompt-regexp
4070 ;; shell-prompt-pattern)))
4071 ;; (pop-to-buffer (buffer-name))
4072 ;; (kill-process p)
4073 ;; (error "Couldn't find shell or passwd prompt for %s"
4074 ;; (or user (user-login-name))))
4075 ;; (when (nth 1 found)
4076 ;; (tramp-message 9 "Sending password...")
4077 ;; (tramp-enter-password p (nth 1 found))
4078 ;; (erase-buffer)
4079 ;; (tramp-message 9 "Sent password, waiting 60s for remote shell prompt")
4080 ;; (setq found (tramp-wait-for-regexp p 60
4081 ;; (format "\\(%s\\)\\|\\(%s\\)\\'"
4082 ;; tramp-wrong-passwd-regexp
4083 ;; shell-prompt-pattern))))
4084 ;; (unless found
4085 ;; (pop-to-buffer (buffer-name))
4086 ;; (kill-process p)
4087 ;; (error "Couldn't find remote shell prompt"))
4088 ;; (when (nth 1 found)
4089 ;; (pop-to-buffer (buffer-name))
4090 ;; (kill-process p)
4091 ;; (error "Login failed: %s" (nth 1 found)))
4092 ))
4094 ;; Utility functions.
4097 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
4098 Expects the output of PROC to be sent to the current buffer. Returns
4099 the string that matched, or nil. Waits indefinitely if TIMEOUT is
4100 nil."
4104 ;; Work around a bug in XEmacs 21, where the timeout
4105 ;; expires faster than it should. This degenerates
4106 ;; to polling for buggy XEmacsen, but oh, well.
4109 timeout))
4125 tramp-current-user tramp-current-host)
4131 tramp-current-user tramp-current-host))
4136 found))
4139 "Prompt for a password and send it to the remote end.
4140 Uses PROMPT as a prompt and sends the password to process P."
4145 ;; HHH: Not Changed. This might handle the case where USER is not
4146 ;; given in the "File name" very poorly. Then, the local
4147 ;; variable tramp-current user will be set to nil.
4149 "Do some setup before actually logging in.
4150 METHOD, USER and HOST specify the connection."
4161 "Set up an interactive shell.
4162 Mainly sets the prompt and the echo correctly. P is the shell process
4163 to set up. METHOD, USER and HOST specify the connection."
4164 ;; Wait a bit in case the remote end feels like sending a little
4165 ;; junk first. It seems that fencepost.gnu.org does this when doing
4166 ;; a Kerberos login.
4171 tramp-rsh-end-of-line))
4195 tramp-rsh-end-of-line))
4200 ;; Try to set up the coding system correctly.
4201 ;; CCC this can't be the right way to do it. Hm.
4206 tramp-rsh-end-of-line))
4213 ;; Use MULE to select the right EOL convention for communicating
4214 ;; with the process.
4216 cs-decode cs-encode)
4228 ;; Look for ^M and do something useful if found.
4230 ;; We have found a ^M but cannot frob the process coding system
4231 ;; because we're running on a non-MULE Emacs. Let's try
4232 ;; stty, instead.
4244 tramp-rsh-end-of-line))
4255 tramp-rsh-end-of-line))
4265 tramp-rsh-end-of-line))
4283 multi-method method user host
4285 tramp-rsh-end-of-line
4286 tramp-end-of-output
4287 tramp-rsh-end-of-line))
4301 "Prepare a remote shell before being able to work on it.
4302 METHOD, USER and HOST specify the connection.
4303 Among other things, this finds a shell which groks tilde expansion,
4304 tries to find an `ls' command which groks the `-n' option, sets the
4305 locale to C and sets up the remote shell search path."
4306 ;; Search for a good shell before searching for a command which
4307 ;; checks if a file exists. This is done because Tramp wants to use
4308 ;; "test foo; echo $?" to check if various conditions hold, and
4309 ;; there are buggy /bin/sh implementations which don't execute the
4310 ;; "echo $?" part if the "test" part has an error. In particular,
4311 ;; the Solaris /bin/sh is a problem. I'm betting that all systems
4312 ;; with buggy /bin/sh implementations will have a working bash or
4313 ;; ksh. Whee...
4317 ;; Without (sit-for 0.1) at least, my machine will almost always blow
4318 ;; up on 'not numberp /root' - a race that causes the 'echo ~root'
4319 ;; output of (tramp-find-shell) to show up along with the output of
4320 ;; (tramp-find-ls-command) testing.
4321 ;;
4322 ;; I can't work out why this is a problem though. The (tramp-wait-for-output)
4323 ;; call in (tramp-find-shell) *should* make this not happen, I thought.
4324 ;;
4325 ;; After much debugging I couldn't find any problem with the implementation
4326 ;; of that function though. The workaround stays for me at least. :/
4327 ;;
4328 ;; Daniel Pittman <daniel@danann.net>
4333 1
4341 tramp-ls-command)
4344 "return $1" tramp-rsh-end-of-line
4347 ;; Set remote PATH variable.
4349 ;; Tell remote shell to use standard time format, needed for
4350 ;; parsing `ls -l' output.
4360 ;; Unalias ls(1) to work around issues with those silly people who make it
4361 ;; spit out ANSI escapes or whatever.
4365 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4366 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4367 ;; for otherwise the shell crashes.
4378 multi-method method user host
4383 ;; Find a `perl'.
4392 ;; Set up stat in Perl if we can.
4396 multi-method method user host
4398 tramp-remote-perl
4404 multi-method method user host
4407 " 2>/dev/null"
4412 multi-method method user host
4415 " 2>/dev/null"
4418 ;; Find ln(1)
4425 ;; Find the right encoding/decoding commands to use.
4428 ;; If encoding/decoding command are given, test to see if they work.
4429 ;; CCC: Maybe it would be useful to run the encoder both locally and
4430 ;; remotely to see if they produce the same result.
4440 5
4443 multi-method method user host
4455 ;; CCC: We should either implement a Perl version of base64 encoding
4456 ;; and decoding. Then we just use that in the last item. The other
4457 ;; alternative is to use the Perl version of UU encoding. But then
4458 ;; we need a Lisp version of uuencode.
4461 base64-encode-region base64-decode-region)
4463 base64-encode-region base64-decode-region)
4465 base64-encode-region base64-decode-region)
4467 nil uudecode-decode-region)
4469 nil uudecode-decode-region)
4471 base64-encode-region base64-decode-region))
4472 "List of coding commands for inline transfer.
4473 Each item is a list (ENCODING-COMMAND DECODING-COMMAND
4474 ENCODING-FUNCTION DECODING-FUNCTION).
4476 Each item can be a string, giving a command, or a symbol, giving
4477 a function.
4479 The ENCODING-COMMAND should be a command accepting a plain file on
4480 standard input and writing the encoded file to standard output. The
4481 DECODING-COMMAND should be a command accepting an encoded file on
4482 standard input and writing the decoded file to standard output.
4484 The ENCODING-FUNCTION and DECODING-FUNCTION functions will be called
4485 with two arguments, start and end of region, and are expected to
4486 replace the region contents with the encoded or decoded results,
4490 "Find an inline transfer encoding that works.
4491 Goes through the list `tramp-coding-commands'."
4493 item found)
4501 ;; Check if encoding and decoding commands can be called
4502 ;; remotely with null input and output. This makes sure there
4503 ;; are no syntax errors and the command is really found.
4505 multi-method method user host 10
4508 multi-method method user host
4512 multi-method method user host 10
4515 multi-method method user host
4518 ;; If no encoding/decoding function is given, the
4519 ;; corresponding encoding/decoding command also has to work
4520 ;; locally.
4523 multi-method method user host 10
4526 tramp-sh-program ;program
4527 nil ;input
4528 nil ;output buffer
4529 nil ;redisplay
4530 "-c"
4535 multi-method method user host 10
4538 tramp-sh-program ;program
4539 nil ;input file
4540 nil ;output buffer
4541 nil ;redisplay
4542 "-c"
4545 ;; CCC: At this point, maybe we should check that the output
4546 ;; of the commands is correct. But for the moment we will
4547 ;; assume that commands working on empty input will also
4548 ;; work in practice.
4550 ;; Did we find something? If not, issue error. If so,
4551 ;; set connection properties.
4565 "Maybe open a connection to HOST, logging in as USER, using METHOD.
4566 Does not do anything if a connection is already open, but re-opens the
4567 connection if a previous connection has died for some reason."
4569 last-cmd-time)
4570 ;; If too much time has passed since last command was sent, look
4571 ;; whether process is still alive. If it isn't, kill it. When
4572 ;; using ssh, it can sometimes happen that the remote end has hung
4573 ;; up but the local ssh client doesn't recognize this until it
4574 ;; tries to send some data to the remote end. So that's why we
4575 ;; try to send a command from time to time, then look again
4576 ;; whether the process is really alive.
4590 multi-method method user host))))
4594 "Send the COMMAND to USER at HOST (logged in using METHOD).
4595 Erases temporary buffer before sending the command (unless NOERASE
4596 is true)."
4611 ;; It seems that Tru64 Unix does not like it if long strings are sent
4612 ;; to it in one go. (This happens when sending the Perl
4613 ;; `file-attributes' implementation, for instance.) Therefore, we
4614 ;; have this function which waits a bit at each line.
4617 "Send the STRING to USER at HOST linewise.
4618 Erases temporary buffer before sending the STRING (unless NOERASE
4619 is true).
4621 The STRING is expected to use Unix line-endings, but the lines sent to
4622 the remote host use line-endings as defined in the variable
4623 `tramp-rsh-end-of-line'."
4639 lines)))
4642 "Wait for output from remote rsh command."
4649 ;; Algorithm: get waiting output. See if last line contains
4650 ;; end-of-output sentinel. If not, wait a bit and again get
4651 ;; waiting output. Repeat until timeout expires or end-of-output
4652 ;; sentinel is seen. Will hang if timeout is nil and
4653 ;; end-of-output sentinel never appears.
4656 ;; Work around an XEmacs bug, where the timeout expires
4657 ;; faster than it should. This degenerates into polling
4658 ;; for buggy XEmacsen, but oh, well.
4661 timeout))
4674 ;; At this point, either the timeout has expired or we have found
4675 ;; the end-of-output sentinel.
4680 ;; Add output to debug buffer if appropriate.
4684 tramp-current-user tramp-current-host)
4690 tramp-current-user tramp-current-host))
4696 ;; Return value is whether end-of-output sentinel was found.
4697 found))
4700 "Returns list of all match strings.
4701 That is, (list (match-string 0) (match-string 1) ...), according to the
4702 number of matches."
4709 res))
4713 "Run COMMAND and check its exit status.
4714 MULTI-METHOD and METHOD specify how to log in (as USER) to the remote HOST.
4715 Sends `echo $?' along with the COMMAND for checking the exit status. If
4716 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4718 If the optional argument SUBSHELL is non-nil, the command is executed in
4719 a subshell, ie surrounded by parentheses."
4722 command
4724 "echo tramp_exit_status $?"
4735 "Run COMMAND, check exit status, throw error if exit status not okay.
4736 Similar to `tramp-send-command-and-check' but accepts two more arguments
4737 FMT and ARGS which are passed to `error'."
4739 multi-method method user host command subshell))
4740 ;; CCC: really pop-to-buffer? Maybe it's appropriate to be more
4741 ;; silent.
4746 "Send the region from START to END to remote command
4747 running as USER on HOST using METHOD."
4756 start end))))
4759 "Send EOF to the remote end.
4760 METHOD, HOST and USER specify the connection."
4766 ; (process-send-string proc "\^D")))
4769 "Kill the connection process used by Tramp.
4770 MULTI-METHOD, METHOD, USER, and HOST specify the connection."
4776 "Erase buffer, then discard subsequent garbage.
4777 If `tramp-discard-garbage' is nil, just erase buffer."
4789 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
4814 owner-execute-or-setid)))
4827 group-execute-or-setid)))
4840 other-execute-or-sticky)))))))
4844 "Turn an integer representing a file mode into an ls(1)-like string."
4859 "Convert a permission bitset into a string.
4860 This is used internally by `tramp-file-mode-from-int'."
4872 "Return a string consisting of the octal digits of I.
4881 ;;(defun tramp-octal-to-decimal (ostr)
4882 ;; "Given a string of octal digits, return a decimal number."
4883 ;; (cond ((null ostr) 0)
4884 ;; ((string= "" ostr) 0)
4885 ;; (t (let ((last (aref ostr (1- (length ostr))))
4886 ;; (rest (substring ostr 0 (1- (length ostr)))))
4887 ;; (unless (and (>= last ?0)
4888 ;; (<= last ?7))
4889 ;; (error "Not an octal digit: %c" last))
4890 ;; (+ (- last ?0) (* 8 (tramp-octal-to-decimal rest)))))))
4891 ;; Kudos to Gerd Moellmann for this suggestion.
4893 "Given a string of octal digits, return a decimal number."
4895 ;; `save-match' is in `tramp-mode-string-to-int' which calls this.
4901 "Converts STRING to shell glob pattern which ignores case."
4907 string
4911 ;; ------------------------------------------------------------
4912 ;; -- TRAMP file names --
4913 ;; ------------------------------------------------------------
4914 ;; Conversion functions between external representation and
4915 ;; internal data structure. Convenience functions for internal
4916 ;; data structure.
4921 "Return t iff NAME is a tramp file."
4925 ;; HHH: Changed. Used to assign the return value of (user-login-name)
4926 ;; to the `user' part of the structure if a user name was not
4927 ;; provided, now it assigns nil.
4929 "Return an `tramp-file-name' structure.
4930 The structure consists of remote method, remote user, remote host and
4931 remote path name."
4938 ;; If it's a multi method, the file name structure contains
4939 ;; arrays of method, user and host.
4941 ;; Normal method. First, find out default method.
4948 :multi-method nil
4949 :method method
4951 :host host
4955 "Look up the right method to use in `tramp-default-method-alist'."
4958 item)
4965 method))
4967 ;; HHH: Not Changed. Multi method. Will probably not handle the case where
4968 ;; a user name is not provided in the "file name" very well.
4970 "Not implemented yet."
4979 method hops len hop-methods hop-users hop-hosts path)
4997 :multi-method method
5004 "Constructs a tramp file name from METHOD, USER, HOST and PATH."
5015 ;; CCC: Henrik Holm: Not Changed. Multi Method. What should be done
5016 ;; with this when USER is nil?
5018 "Constructs a tramp file name for a multi-hop method."
5037 "Create a file name suitable to be passed to `rcp'."
5043 "Given user, host, and path, return an Ange-FTP filename."
5049 "Return t if this is an out-of-band method, nil otherwise.
5050 It is important to check for this condition, since it is not possible
5051 to enter a password for the `tramp-rcp-program'."
5054 ;; Variables local to connection.
5060 tramp-ls-command))
5066 tramp-test-groks-nt))
5072 tramp-file-exists-command))
5080 ;; Get a property of a TRAMP connection.
5083 "Get the named property for the connection.
5084 If the value is not set for the connection, return `default'"
5092 ;; Set a property of a TRAMP connection.
5095 "Set the named property of a TRAMP connection."
5100 value)))
5102 ;; Some predefined connection properties.
5105 multi-method method user host))
5108 multi-method method user host))
5111 multi-method method user host))
5114 multi-method method user host))
5117 multi-method method user host))
5120 multi-method method user host))
5123 multi-method method user host))
5126 multi-method method user host))
5132 tramp-methods))
5139 tramp-methods))
5146 tramp-methods))
5153 tramp-methods))
5160 tramp-methods))
5167 tramp-methods))
5174 tramp-methods))
5181 tramp-methods))
5188 tramp-methods))
5195 tramp-methods))
5202 tramp-methods))
5206 ;; (defun tramp-get-encoding-command (multi-method method)
5207 ;; (second (or (assoc 'tramp-encoding-command
5208 ;; (assoc (or multi-method method tramp-default-method)
5209 ;; tramp-methods))
5210 ;; (error "Method `%s' didn't specify an encoding command"
5211 ;; (or multi-method method)))))
5213 ;; (defun tramp-get-decoding-command (multi-method method)
5214 ;; (second (or (assoc 'tramp-decoding-command
5215 ;; (assoc (or multi-method method tramp-default-method)
5216 ;; tramp-methods))
5217 ;; (error "Method `%s' didn't specify a decoding command"
5218 ;; (or multi-method method)))))
5220 ;; (defun tramp-get-encoding-function (multi-method method)
5221 ;; (second (or (assoc 'tramp-encoding-function
5222 ;; (assoc (or multi-method method tramp-default-method)
5223 ;; tramp-methods))
5224 ;; (error "Method `%s' didn't specify an encoding function"
5225 ;; (or multi-method method)))))
5227 ;; (defun tramp-get-decoding-function (multi-method method)
5228 ;; (second (or (assoc 'tramp-decoding-function
5229 ;; (assoc (or multi-method method tramp-default-method)
5230 ;; tramp-methods))
5231 ;; (error "Method `%s' didn't specify a decoding function"
5232 ;; (or multi-method method)))))
5234 ;; Auto saving to a special directory.
5237 "Returns a file name in `tramp-auto-save-directory' for autosaving this file."
5241 ;; jka-compr doesn't like auto-saving, so by appending "~" to the
5242 ;; file name we make sure that jka-compr isn't used for the
5243 ;; auto-save file.
5251 fn)
5252 tramp-auto-save-directory)))
5257 "Invoke `tramp-make-auto-save-file-name' for tramp files."
5259 tramp-auto-save-directory)
5262 ad-do-it))
5265 "Replace all occurrences of the string FROM with TO in STRING.
5266 ALIST is of the form ((FROM . TO) ...)."
5275 string))
5278 "Insert text with a specific face."
5283 ;; ------------------------------------------------------------
5284 ;; -- Compatibility functions section --
5285 ;; ------------------------------------------------------------
5288 "Return name of directory for temporary files (compat function).
5289 For Emacs, this is the variable `temporary-file-directory', for XEmacs
5290 this is the function `temp-directory'."
5307 "Read a password from user (compat function).
5308 Invokes `read-passwd' if that is defined, else `ange-ftp-read-passwd'."
5314 "Return the difference between the two times, in seconds.
5315 T1 and T2 are time values (as returned by `current-time' for example).
5317 NOTE: This function will fail if the time difference is too large to
5318 fit in an integer."
5319 ;; Pacify byte-compiler with `symbol-function'.
5328 ;; snarfed from Emacs 21 time-date.el
5334 "Return a coding system like CODING-SYSTEM but with given EOL-TYPE.
5335 EOL-TYPE can be one of `dos', `unix', or `mac'."
5341 #'subsidiary-coding-system
5348 eol-type
5353 "Like `split-string' but omit empty strings.
5355 This is, the first, empty, element is omitted. In XEmacs, the first
5356 element is not omitted.
5358 Note: this function has been written for `tramp-handle-file-truename'.
5359 If you want to use it for something else, you'll have to check whether
5360 it does the right thing."
5363 ;; ------------------------------------------------------------
5364 ;; -- Kludges section --
5365 ;; ------------------------------------------------------------
5367 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
5368 ;; does not deal well with newline characters. Newline is replaced by
5369 ;; backslash newline. But if, say, the string `a backslash newline b'
5370 ;; is passed to a shell, the shell will expand this into "ab",
5371 ;; completely omitting the newline. This is not what was intended.
5372 ;; It does not appear to be possible to make the function
5373 ;; `shell-quote-argument' work with newlines without making it
5374 ;; dependent on the shell used. But within this package, we know that
5375 ;; we will always use a Bourne-like shell, so we use an approach which
5376 ;; groks newlines.
5377 ;;
5378 ;; The approach is simple: we call `shell-quote-argument', then
5379 ;; massage the newline part of the result.
5380 ;;
5381 ;; This function should produce a string which is grokked by a Unix
5382 ;; shell, even if the Emacs is running on Windows. Since this is the
5383 ;; kludges section, we bind `system-type' in such a way that
5384 ;; `shell-quote-arguments' behaves as if on Unix.
5385 ;;
5386 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
5387 ;; function to work with Bourne-like shells.
5388 ;;
5389 ;; CCC: This function should be rewritten so that
5390 ;; `shell-quote-argument' is not used. This way, we are safe from
5391 ;; changes in `shell-quote-argument'.
5393 "Similar to `shell-quote-argument', but groks newlines.
5394 Only works for Bourne-like shells."
5404 t t result)))
5405 result))))
5407 ;; ;; EFS hooks itself into the file name handling stuff in more places
5408 ;; ;; than just `file-name-handler-alist'. The following tells EFS to stay
5409 ;; ;; away from tramp.el paths.
5410 ;; ;;
5411 ;; ;; This is needed because EFS installs (efs-dired-before-readin) into
5412 ;; ;; 'dired-before-readin-hook'. This prevents EFS from opening an FTP
5413 ;; ;; connection to help it's dired process. Not that I have any real
5414 ;; ;; idea *why* this is helpful to dired.
5415 ;; ;;
5416 ;; ;; Anyway, this advice fixes the problem (with a sledgehammer :)
5417 ;; ;;
5418 ;; ;; Daniel Pittman <daniel@danann.net>
5419 ;; ;;
5420 ;; ;; CCC: when the other defadvice calls have disappeared, make sure
5421 ;; ;; not to call defadvice unless it's necessary. How do we find out whether
5422 ;; ;; it is necessary? (featurep 'efs) is surely the wrong way --
5423 ;; ;; EFS might nicht be loaded yet.
5424 ;; (defadvice efs-ftp-path (around dont-match-tramp-path activate protect)
5425 ;; "Cause efs-ftp-path to fail when the path is a TRAMP path."
5426 ;; (if (tramp-tramp-file-p (ad-get-arg 0))
5427 ;; nil
5428 ;; ad-do-it))
5430 ;; We currently use "[" and "]" in the filename format. In Emacs
5431 ;; 20.x, this means that Emacs wants to expand wildcards if
5432 ;; `find-file-wildcards' is non-nil, and then barfs because no
5433 ;; expansion could be found. We detect this situation and do
5434 ;; something really awful: we have `file-expand-wildcards' return the
5435 ;; original filename if it can't expand anything. Let's just hope
5436 ;; that this doesn't break anything else.
5437 ;;
5438 ;; Another problem is that the check is done by Emacs version, which
5439 ;; is really not what we want to do. Oh, well.
5441 ;;(when (and (not (featurep 'xemacs))
5442 ;; (= emacs-major-version 20))
5443 ;; It seems that this advice is needed in Emacs 21, too.
5447 ;; If it's a Tramp file, dissect it and look if wildcards
5448 ;; need to be expanded at all.
5454 ;; If it is not a Tramp file, just run the original function.
5457 ;; )
5459 ;; Tramp version is useful in a number of situations.
5462 "Print version number of tramp.el in minibuffer or current buffer."
5466 ;; Make the `reporter` functionality available for making bug reports about
5467 ;; the package. A most useful piece of code.
5473 "Submit a bug report to the TRAMP developers."
5478 tramp-bug-report-address ; to-address
5481 tramp-ls-command
5482 tramp-test-groks-nt
5483 tramp-file-exists-command
5484 tramp-current-multi-method
5485 tramp-current-method
5486 tramp-current-user
5487 tramp-current-host
5489 ;; System defaults
5490 tramp-auto-save-directory ; vars to dump
5491 tramp-default-method
5492 tramp-rsh-end-of-line
5493 tramp-remote-path
5494 tramp-login-prompt-regexp
5495 tramp-password-prompt-regexp
5496 tramp-wrong-passwd-regexp
5497 tramp-temp-name-prefix
5498 tramp-file-name-structure
5499 tramp-file-name-regexp
5500 tramp-multi-file-name-structure
5501 tramp-multi-file-name-hop-structure
5502 tramp-multi-methods
5503 tramp-multi-connection-function-alist
5504 tramp-make-tramp-file-format
5505 tramp-end-of-output
5507 ;; Non-tramp variables of interest
5508 shell-prompt-pattern
5509 backup-by-copying
5510 backup-by-copying-when-linked
5511 backup-by-copying-when-mismatch
5514 file-name-handler-alist)
5515 nil ; pre-hook
5516 nil ; post-hook
5517 "\
5518 Enter your bug report in this message, including as much detail as you
5519 possibly can about the problem, what you did to cause it and what the
5520 local and remote machines are.
5522 If you can give a simple set of instructions to make this bug happen
5523 reliably, please include those. Thank you for helping kill bugs in
5524 TRAMP.
5531 ;; Make sure that we get integration with the VC package.
5532 ;; When it is loaded, we need to pull in the integration module.
5533 ;; This must come after (provide 'tramp) because tramp-vc.el
5534 ;; requires tramp.
5538 ;;; TODO:
5540 ;; * Revise the comments near the beginning of the file.
5541 ;; * Cooperate with PCL-CVS. It uses start-process, which doesn't
5542 ;; work for remote files.
5543 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
5544 ;; `shell-quote-argument'.
5545 ;; * Completion gets confused when you leave out the method name.
5546 ;; * Support `dired-compress-file' filename handler.
5547 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
5548 ;; by the files in that directory. Add this here.
5549 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
5550 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
5551 ;; * When logging in, keep looking for questions according to an alist
5552 ;; and then invoke the right function.
5553 ;; * Case-insensitive filename completion. (Norbert Goevert.)
5554 ;; * Running CVS remotely doesn't appear to work right. It thinks
5555 ;; files are locked by somebody else even if I'm the locking user.
5556 ;; Sometimes, one gets `No CVSROOT specified' errors from CVS.
5557 ;; (Skip Montanaro)
5558 ;; * Don't use globbing for directories with many files, as this is
5559 ;; likely to produce long command lines, and some shells choke on
5560 ;; long command lines.
5561 ;; * Find out about the new auto-save mechanism in Emacs 21 and
5562 ;; do the right thing.
5563 ;; * `vc-directory' does not work. It never displays any files, even
5564 ;; if it does show files when run locally.
5565 ;; * Allow correction of passwords, if the remote end allows this.
5566 ;; (Mark Hershberger)
5567 ;; * Make sure permissions of tmp file are good.
5568 ;; (Nelson Minar <nelson@media.mit.edu>)
5569 ;; * Grok passwd prompts with scp? (David Winter
5570 ;; <winter@nevis1.nevis.columbia.edu>). Maybe just do `ssh -l user
5571 ;; host', then wait a while for the passwd or passphrase prompt. If
5572 ;; there is one, remember the passwd/phrase.
5573 ;; * How to deal with MULE in `insert-file-contents' and `write-region'?
5574 ;; * Do asynchronous `shell-command's.
5575 ;; * Grok `append' parameter for `write-region'.
5576 ;; * Test remote ksh or bash for tilde expansion in `tramp-find-shell'?
5577 ;; * abbreviate-file-name
5578 ;; * grok ~ in tramp-remote-path (Henrik Holm <henrikh@tele.ntnu.no>)
5579 ;; * `C' in dired gives error `not tramp file name'.
5580 ;; * Also allow to omit user names when doing multi-hop. Not sure yet
5581 ;; what the user names should default to, though.
5582 ;; * better error checking. At least whenever we see something
5583 ;; strange when doing zerop, we should kill the process and start
5584 ;; again. (Greg Stark)
5585 ;; * Add caching for filename completion. (Greg Stark)
5586 ;; Of course, this has issues with usability (stale cache bites)
5587 ;; -- <daniel@danann.net>
5588 ;; * Provide a local cache of old versions of remote files for the rsync
5589 ;; transfer method to use. (Greg Stark)
5590 ;; * Remove unneeded parameters from methods.
5591 ;; * Invoke rsync once for copying a whole directory hierarchy.
5592 ;; (Francesco Potortì)
5593 ;; * Should we set PATH ourselves or should we rely on the remote end
5594 ;; to do it?
5595 ;; * Do the autoconf thing.
5596 ;; * Make it work for XEmacs 20, which is missing `with-timeout'.
5597 ;; * Allow non-Unix remote systems. (More a long-term thing.)
5598 ;; * Make it work for different encodings, and for different file name
5599 ;; encodings, too. (Daniel Pittman)
5600 ;; * Change applicable functions to pass a struct tramp-file-name rather
5601 ;; than the individual items MULTI-METHOD, METHOD, USER, HOST, PATH.
5602 ;; * Implement asynchronous shell commands.
5603 ;; * Clean up unused *tramp/foo* buffers after a while. (Pete Forman)
5604 ;; * Progress reports while copying files. (Michael Kifer)
5605 ;; * `Smart' connection method that uses inline for small and out of
5606 ;; band for large files. (Michael Kifer)
5607 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5608 ;; then look if it's the right version (with `perl -v').
5609 ;; * When editing a remote CVS controlled file as a different user, VC
5610 ;; gets confused about the file locking status. Try to find out why
5611 ;; the workaround doesn't work.
5612 ;; * When user is running ssh-agent, it would be useful to add the
5613 ;; passwords typed by the user to that agent. This way, the next time
5614 ;; round, the users don't have to type all this in again.
5615 ;; This would be especially useful for start-process, I think.
5616 ;; An easy way to implement start-process is to open a second shell
5617 ;; connection which is inconvenient if the user has to reenter
5618 ;; passwords.
5619 ;; * Change `copy-file' to grok the case where the filename handler
5620 ;; for the source and the target file are different. Right now,
5621 ;; it looks at the source file and then calls that handler, if
5622 ;; there is one. But since ange-ftp, for instance, does not know
5623 ;; about Tramp, it does not do the right thing if the target file
5624 ;; name is a Tramp name.
5626 ;; Functions for file-name-handler-alist:
5627 ;; diff-latest-backup-file -- in diff.el
5628 ;; dired-compress-file
5629 ;; dired-uncache -- this will be needed when we do insert-directory caching
5630 ;; file-name-as-directory -- use primitive?
5631 ;; file-name-directory -- use primitive?
5632 ;; file-name-nondirectory -- use primitive?
5633 ;; file-name-sans-versions -- use primitive?
5634 ;; file-newer-than-file-p
5635 ;; find-backup-file-name
5636 ;; get-file-buffer -- use primitive
5637 ;; load
5638 ;; unhandled-file-name-directory
5639 ;; vc-registered
5641 ;;; tramp.el ends here