1 ;;; tramp-cmds.el --- Interactive commands for Tramp
3 ;; Copyright (C) 2007-2013 Free Software Foundation, Inc.
5 ;; Author: Michael Albinus <michael.albinus@gmx.de>
6 ;; Keywords: comm, processes
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; This package provides all interactive commands which are related
33 ;; Pacify byte-compiler.
34 (defvar reporter-eval-buffer)
35 (defvar reporter-prompt-for-summary-p)
37 (defun tramp-list-tramp-buffers ()
38 "Return a list of all Tramp connection buffers."
41 "*tramp" (mapcar 'list (mapcar 'buffer-name (buffer-list))))
43 "*debug tramp" (mapcar 'list (mapcar 'buffer-name (buffer-list))))))
45 (defun tramp-list-remote-buffers ()
46 "Return a list of all buffers with remote default-directory."
51 (with-current-buffer x
52 (when (and (stringp default-directory)
53 (file-remote-p default-directory))
58 (defun tramp-cleanup-connection (vec)
59 "Flush all connection related objects.
60 This includes password cache, file cache, connection cache, buffers.
61 When called interactively, a Tramp connection has to be selected."
63 ;; When interactive, select the Tramp remote identification.
64 ;; Return nil when there is no Tramp connection.
69 (tramp-make-tramp-file-name
70 (tramp-file-name-method x)
71 (tramp-file-name-user x)
72 (tramp-file-name-host x)
73 (tramp-file-name-localname x)))
74 (tramp-list-connections)))
80 "Enter Tramp connection: " connections nil t
81 (try-completion "" connections)))
82 (when (and name (file-remote-p name))
83 (with-parsed-tramp-file-name name nil v))))))
87 (message "No Tramp connection found.")
89 ;; Flush password cache.
90 (tramp-clear-passwd vec)
93 (tramp-flush-directory-property vec "")
95 ;; Flush connection cache.
96 (when (processp (tramp-get-connection-process vec))
97 (delete-process (tramp-get-connection-process vec))
98 (tramp-flush-connection-property (tramp-get-connection-process vec)))
99 (tramp-flush-connection-property vec)
103 (buf (list (get-buffer (tramp-buffer-name vec))
104 (get-buffer (tramp-debug-buffer-name vec))
105 (tramp-get-connection-property vec "process-buffer" nil)))
106 (when (bufferp buf) (kill-buffer buf)))))
109 (defun tramp-cleanup-this-connection ()
110 "Flush all connection related objects of the current buffer's connection."
112 (and (stringp default-directory)
113 (file-remote-p default-directory)
114 (tramp-cleanup-connection
115 (tramp-dissect-file-name default-directory 'noexpand))))
118 (defun tramp-cleanup-all-connections ()
119 "Flush all Tramp internal objects.
120 This includes password cache, file cache, connection cache, buffers."
124 (setq tramp-locked nil)
126 ;; Flush password cache.
127 (tramp-compat-funcall 'password-reset)
129 ;; Flush file and connection cache.
130 (clrhash tramp-cache-data)
133 (dolist (name (tramp-list-tramp-buffers))
134 (when (bufferp (get-buffer name)) (kill-buffer name))))
137 (defun tramp-cleanup-all-buffers ()
138 "Kill all remote buffers."
141 ;; Remove all Tramp related buffers.
142 (tramp-cleanup-all-connections)
144 ;; Remove all buffers with a remote default-directory.
145 (dolist (name (tramp-list-remote-buffers))
146 (when (bufferp (get-buffer name)) (kill-buffer name))))
148 ;; Tramp version is useful in a number of situations.
151 (defun tramp-version (arg)
152 "Print version number of tramp.el in minibuffer or current buffer."
154 (if arg (insert tramp-version) (message tramp-version)))
156 ;; Make the `reporter` functionality available for making bug reports about
157 ;; the package. A most useful piece of code.
159 (autoload 'reporter-submit-bug-report "reporter")
163 "Submit a bug report to the Tramp developers."
167 (let ((reporter-prompt-for-summary-p t))
168 (reporter-submit-bug-report
169 tramp-bug-report-address ; to-address
170 (format "tramp (%s)" tramp-version) ; package name and version
174 (and x (boundp x) (cons x 'tramp-reporter-dump-variable)))
176 (mapcar 'intern (all-completions "tramp-" obarray 'boundp))
177 ;; Non-tramp variables of interest.
178 '(shell-prompt-pattern
180 backup-by-copying-when-linked
181 backup-by-copying-when-mismatch
182 backup-by-copying-when-privileged-mismatch
183 backup-directory-alist
184 bkup-backup-directory-info
186 password-cache-expiry
187 remote-file-name-inhibit-cache
188 file-name-handler-alist))))
189 (lambda (x y) (string< (symbol-name (car x)) (symbol-name (car y)))))
191 'tramp-load-report-modules ; pre-hook
192 'tramp-append-tramp-buffers ; post-hook
193 (propertize "\n" 'display "\
194 Enter your bug report in this message, including as much detail
195 as you possibly can about the problem, what you did to cause it
196 and what the local and remote machines are.
198 If you can give a simple set of instructions to make this bug
199 happen reliably, please include those. Thank you for helping
202 Before reproducing the bug, you might apply
204 M-x tramp-cleanup-all-connections
206 This allows to investigate from a clean environment. Another
207 useful thing to do is to put
209 (setq tramp-verbose 9)
211 in your init file and to repeat the bug. Then, include the
212 contents of the *tramp/foo* buffer and the *debug tramp/foo*
213 buffer in your bug report.
215 --bug report follows this line--
218 (defun tramp-reporter-dump-variable (varsym mailbuf)
219 "Pretty-print the value of the variable in symbol VARSYM."
220 (let* ((reporter-eval-buffer (symbol-value 'reporter-eval-buffer))
221 (val (with-current-buffer reporter-eval-buffer
222 (symbol-value varsym))))
224 (if (hash-table-p val)
225 ;; Pretty print the cache.
226 (set varsym (read (format "(%s)" (tramp-cache-print val))))
227 ;; There are non-7bit characters to be masked.
228 (when (and (boundp 'mm-7bit-chars)
231 (concat "[^" (symbol-value 'mm-7bit-chars) "]") val))
232 (with-current-buffer reporter-eval-buffer
233 (set varsym (format "(base64-decode-string \"%s\")"
234 (base64-encode-string val))))))
237 (tramp-compat-funcall 'reporter-dump-variable varsym mailbuf)
239 (unless (hash-table-p val)
240 ;; Remove string quotation.
243 (concat "\\(^.*\\)" "\"" ;; \1 "
244 "\\((base64-decode-string \\)" "\\\\" ;; \2 \
245 "\\(\".*\\)" "\\\\" ;; \3 \
246 "\\(\")\\)" "\"$")) ;; \4 "
247 (replace-match "\\1\\2\\3\\4")
249 (insert " ;; Variable encoded due to non-printable characters.\n"))
252 ;; Reset VARSYM to old value.
253 (with-current-buffer reporter-eval-buffer
256 (defun tramp-load-report-modules ()
257 "Load needed modules for reporting."
258 ;; We load message.el and mml.el from Gnus.
259 (if (featurep 'xemacs)
261 (load "message" 'noerror)
262 (load "mml" 'noerror))
263 (require 'message nil 'noerror)
264 (require 'mml nil 'noerror))
265 (tramp-compat-funcall 'message-mode)
266 (tramp-compat-funcall 'mml-mode t))
268 (defun tramp-append-tramp-buffers ()
269 "Append Tramp buffers and buffer local variables into the bug report."
270 (goto-char (point-max))
272 ;; Dump buffer local variables.
273 (insert "\nlocal variables:\n================")
278 (when (string-match "\\*tramp/" (buffer-name b)) b))
280 (let ((reporter-eval-buffer buffer)
281 (elbuf (get-buffer-create " *tmp-reporter-buffer*")))
282 (with-current-buffer elbuf
285 (insert (format "\n;; %s\n(setq-local\n" (buffer-name buffer)))
293 (all-completions "tramp-" (buffer-local-variables buffer)))
294 ;; Non-tramp variables of interest.
295 '(default-directory))
297 (tramp-compat-funcall 'reporter-dump-variable varsym elbuf))
300 (insert-buffer-substring elbuf)))
302 ;; Dump load-path shadows.
303 (insert "\nload-path shadows:\n==================\n")
306 (lambda (x) (when (string-match "tramp" x) (insert x "\n")))
307 (split-string (tramp-compat-funcall 'list-load-path-shadows t) "\n")))
309 ;; Append buffers only when we are in message mode.
311 (eq major-mode 'message-mode)
313 (symbol-value 'mml-mode))
315 (let ((tramp-buf-regexp "\\*\\(debug \\)?tramp/")
316 (buffer-list (tramp-compat-funcall 'tramp-list-tramp-buffers))
317 (curbuf (current-buffer)))
319 ;; There is at least one Tramp buffer.
321 (switch-to-buffer (list-buffers-noselect nil))
322 (delete-other-windows)
323 (setq buffer-read-only nil)
324 (goto-char (point-min))
326 (if (re-search-forward tramp-buf-regexp (point-at-eol) t)
329 (let ((start (point)))
331 (kill-region start (point)))))
333 The buffer(s) above will be appended to this message. If you
334 don't want to append a buffer because it contains sensitive data,
335 or because the buffer is too large, you should delete the
336 respective buffer. The buffer(s) will contain user and host
337 names. Passwords will never be included there.")
339 (when (>= tramp-verbose 6)
341 (let ((start (point)))
343 Please note that you have set `tramp-verbose' to a value of at
344 least 6. Therefore, the contents of files might be included in
345 the debug buffer(s).")
346 (add-text-properties start (point) (list 'face 'italic))))
348 (set-buffer-modified-p nil)
349 (setq buffer-read-only t)
350 (goto-char (point-min))
352 (if (y-or-n-p "Do you want to append the buffer(s)? ")
353 ;; OK, let's send. First we delete the buffer list.
356 (switch-to-buffer curbuf)
357 (goto-char (point-max))
358 (insert (propertize "\n" 'display "\n\
359 This is a special notion of the `gnus/message' package. If you
360 use another mail agent (by copying the contents of this buffer)
361 please ensure that the buffers are attached to your email.\n\n"))
362 (dolist (buffer buffer-list)
363 (tramp-compat-funcall
364 'mml-insert-empty-tag 'part 'type "text/plain"
365 'encoding "base64" 'disposition "attachment" 'buffer buffer
366 'description buffer))
367 (set-buffer-modified-p nil))
369 ;; Don't send. Delete the message buffer.
371 (set-buffer-modified-p nil)
373 (throw 'dont-send nil))))))
375 (defalias 'tramp-submit-bug 'tramp-bug)
377 (add-hook 'tramp-unload-hook
378 (lambda () (unload-feature 'tramp-cmds 'force)))
380 (provide 'tramp-cmds)
384 ;; * Clean up unused *tramp/foo* buffers after a while. (Pete Forman)
385 ;; * WIBNI there was an interactive command prompting for Tramp
386 ;; method, hostname, username and filename and translates the user
387 ;; input into the correct filename syntax (depending on the Emacs
388 ;; flavor) (Reiner Steib)
389 ;; * Let the user edit the connection properties interactively.
390 ;; Something like `gnus-server-edit-server' in Gnus' *Server* buffer.
392 ;;; tramp-cmds.el ends here