]> code.delx.au - gnu-emacs/blob - lisp/net/tramp-gvfs.el
Tramp diagnostics as per ‘text-quoting-style’
[gnu-emacs] / lisp / net / tramp-gvfs.el
1 ;;; tramp-gvfs.el --- Tramp access functions for GVFS daemon
2
3 ;; Copyright (C) 2009-2015 Free Software Foundation, Inc.
4
5 ;; Author: Michael Albinus <michael.albinus@gmx.de>
6 ;; Keywords: comm, processes
7 ;; Package: tramp
8
9 ;; This file is part of GNU Emacs.
10
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.
15
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.
20
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/>.
23
24 ;;; Commentary:
25
26 ;; Access functions for the GVFS daemon from Tramp. Tested with GVFS
27 ;; 1.0 (Ubuntu 8.10, Gnome 2.24). It has been reported also to run
28 ;; with GVFS 0.2.5 (Ubuntu 8.04, Gnome 2.22), but there is an
29 ;; incompatibility with the mount_info structure, which has been
30 ;; worked around.
31
32 ;; It has also been tested with GVFS 1.6 (Ubuntu 10.04, Gnome 2.30),
33 ;; where the default_location has been added to mount_info (see
34 ;; <https://bugzilla.gnome.org/show_bug.cgi?id=561998>.
35
36 ;; With GVFS 1.14 (Ubuntu 12.10, Gnome 3.6) the interfaces have been
37 ;; changed, again. So we must introspect the D-Bus interfaces.
38
39 ;; All actions to mount a remote location, and to retrieve mount
40 ;; information, are performed by D-Bus messages. File operations
41 ;; themselves are performed via the mounted filesystem in ~/.gvfs.
42 ;; Consequently, GNU Emacs 23.1 with enabled D-Bus bindings is a
43 ;; precondition.
44
45 ;; The GVFS D-Bus interface is said to be unstable. There were even
46 ;; no introspection data before GVFS 1.14. The interface, as
47 ;; discovered during development time, is given in respective
48 ;; comments.
49
50 ;; The customer option `tramp-gvfs-methods' contains the list of
51 ;; supported connection methods. Per default, these are "dav",
52 ;; "davs", "obex", "sftp" and "synce". Note that with "obex" it might
53 ;; be necessary to pair with the other bluetooth device, if it hasn't
54 ;; been done already. There might be also some few seconds delay in
55 ;; discovering available bluetooth devices.
56
57 ;; Other possible connection methods are "ftp" and "smb". When one of
58 ;; these methods is added to the list, the remote access for that
59 ;; method is performed via GVFS instead of the native Tramp
60 ;; implementation.
61
62 ;; GVFS offers even more connection methods. The complete list of
63 ;; connection methods of the actual GVFS implementation can be
64 ;; retrieved by:
65 ;;
66 ;; (message
67 ;; "%s"
68 ;; (mapcar
69 ;; 'car
70 ;; (dbus-call-method
71 ;; :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker
72 ;; tramp-gvfs-interface-mounttracker "listMountableInfo")))
73
74 ;; Note that all other connection methods are not tested, beside the
75 ;; ones offered for customization in `tramp-gvfs-methods'. If you
76 ;; request an additional connection method to be supported, please
77 ;; drop me a note.
78
79 ;; For hostname completion, information is retrieved either from the
80 ;; bluez daemon (for the "obex" method), the hal daemon (for the
81 ;; "synce" method), or from the zeroconf daemon (for the "dav",
82 ;; "davs", and "sftp" methods). The zeroconf daemon is pre-configured
83 ;; to discover services in the "local" domain. If another domain
84 ;; shall be used for discovering services, the customer option
85 ;; `tramp-gvfs-zeroconf-domain' can be set accordingly.
86
87 ;; Restrictions:
88
89 ;; * The current GVFS implementation does not allow to write on the
90 ;; remote bluetooth device via OBEX.
91 ;;
92 ;; * Two shares of the same SMB server cannot be mounted in parallel.
93
94 ;;; Code:
95
96 ;; D-Bus support in the Emacs core can be disabled with configuration
97 ;; option "--without-dbus". Declare used subroutines and variables.
98 (declare-function dbus-get-unique-name "dbusbind.c")
99
100 (require 'tramp)
101
102 (require 'dbus)
103 (require 'url-parse)
104 (require 'url-util)
105 (require 'zeroconf)
106
107 ;; Pacify byte-compiler.
108 (eval-when-compile
109 (require 'cl)
110 (require 'custom))
111
112 ;;;###tramp-autoload
113 (defcustom tramp-gvfs-methods '("dav" "davs" "obex" "sftp" "synce")
114 "List of methods for remote files, accessed with GVFS."
115 :group 'tramp
116 :version "23.2"
117 :type '(repeat (choice (const "dav")
118 (const "davs")
119 (const "ftp")
120 (const "obex")
121 (const "sftp")
122 (const "smb")
123 (const "synce"))))
124
125 ;; Add a default for `tramp-default-user-alist'. Rule: For the SYNCE
126 ;; method, no user is chosen.
127 ;;;###tramp-autoload
128 (add-to-list 'tramp-default-user-alist '("\\`synce\\'" nil nil))
129
130 ;;;###tramp-autoload
131 (defcustom tramp-gvfs-zeroconf-domain "local"
132 "Zeroconf domain to be used for discovering services, like host names."
133 :group 'tramp
134 :version "23.2"
135 :type 'string)
136
137 ;; Add the methods to `tramp-methods', in order to allow minibuffer
138 ;; completion.
139 ;;;###tramp-autoload
140 (when (featurep 'dbusbind)
141 (dolist (elt tramp-gvfs-methods)
142 (unless (assoc elt tramp-methods)
143 (add-to-list 'tramp-methods (cons elt nil)))))
144
145 (defconst tramp-gvfs-path-tramp (concat dbus-path-emacs "/Tramp")
146 "The preceding object path for own objects.")
147
148 (defconst tramp-gvfs-service-daemon "org.gtk.vfs.Daemon"
149 "The well known name of the GVFS daemon.")
150
151 ;; D-Bus integration is available since Emacs 23 on some system types.
152 ;; We don't call `dbus-ping', because this would load dbus.el.
153 (defconst tramp-gvfs-enabled
154 (ignore-errors
155 (and (featurep 'dbusbind)
156 (tramp-compat-funcall 'dbus-get-unique-name :system)
157 (tramp-compat-funcall 'dbus-get-unique-name :session)
158 (or (tramp-compat-process-running-p "gvfs-fuse-daemon")
159 (tramp-compat-process-running-p "gvfsd-fuse"))))
160 "Non-nil when GVFS is available.")
161
162 (defconst tramp-gvfs-path-mounttracker "/org/gtk/vfs/mounttracker"
163 "The object path of the GVFS daemon.")
164
165 (defconst tramp-gvfs-interface-mounttracker "org.gtk.vfs.MountTracker"
166 "The mount tracking interface in the GVFS daemon.")
167
168 ;; Introspection data exist since GVFS 1.14. If there are no such
169 ;; data, we expect an earlier interface.
170 (defconst tramp-gvfs-methods-mounttracker
171 (and tramp-gvfs-enabled
172 (dbus-introspect-get-method-names
173 :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker
174 tramp-gvfs-interface-mounttracker))
175 "The list of supported methods of the mount tracking interface.")
176
177 (defconst tramp-gvfs-listmounts
178 (if (member "ListMounts" tramp-gvfs-methods-mounttracker)
179 "ListMounts"
180 "listMounts")
181 "The name of the \"listMounts\" method.
182 It has been changed in GVFS 1.14.")
183
184 (defconst tramp-gvfs-mountlocation
185 (if (member "MountLocation" tramp-gvfs-methods-mounttracker)
186 "MountLocation"
187 "mountLocation")
188 "The name of the \"mountLocation\" method.
189 It has been changed in GVFS 1.14.")
190
191 (defconst tramp-gvfs-mountlocation-signature
192 (and tramp-gvfs-enabled
193 (dbus-introspect-get-signature
194 :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker
195 tramp-gvfs-interface-mounttracker tramp-gvfs-mountlocation))
196 "The D-Bus signature of the \"mountLocation\" method.
197 It has been changed in GVFS 1.14.")
198
199 ;; <interface name='org.gtk.vfs.MountTracker'>
200 ;; <method name='listMounts'>
201 ;; <arg name='mount_info_list'
202 ;; type='a{sosssssbay{aya{say}}ay}'
203 ;; direction='out'/>
204 ;; </method>
205 ;; <method name='mountLocation'>
206 ;; <arg name='mount_spec' type='{aya{say}}' direction='in'/>
207 ;; <arg name='dbus_id' type='s' direction='in'/>
208 ;; <arg name='object_path' type='o' direction='in'/>
209 ;; </method>
210 ;; <signal name='mounted'>
211 ;; <arg name='mount_info'
212 ;; type='{sosssssbay{aya{say}}ay}'/>
213 ;; </signal>
214 ;; <signal name='unmounted'>
215 ;; <arg name='mount_info'
216 ;; type='{sosssssbay{aya{say}}ay}'/>
217 ;; </signal>
218 ;; </interface>
219 ;;
220 ;; STRUCT mount_info
221 ;; STRING dbus_id
222 ;; OBJECT_PATH object_path
223 ;; STRING display_name
224 ;; STRING stable_name
225 ;; STRING x_content_types Since GVFS 1.0 only !!!
226 ;; STRING icon
227 ;; STRING preferred_filename_encoding
228 ;; BOOLEAN user_visible
229 ;; ARRAY BYTE fuse_mountpoint
230 ;; STRUCT mount_spec
231 ;; ARRAY BYTE mount_prefix
232 ;; ARRAY
233 ;; STRUCT mount_spec_item
234 ;; STRING key (server, share, type, user, host, port)
235 ;; ARRAY BYTE value
236 ;; ARRAY BYTE default_location Since GVFS 1.5 only !!!
237
238 (defconst tramp-gvfs-interface-mountoperation "org.gtk.vfs.MountOperation"
239 "Used by the dbus-proxying implementation of GMountOperation.")
240
241 ;; <interface name='org.gtk.vfs.MountOperation'>
242 ;; <method name='askPassword'>
243 ;; <arg name='message' type='s' direction='in'/>
244 ;; <arg name='default_user' type='s' direction='in'/>
245 ;; <arg name='default_domain' type='s' direction='in'/>
246 ;; <arg name='flags' type='u' direction='in'/>
247 ;; <arg name='handled' type='b' direction='out'/>
248 ;; <arg name='aborted' type='b' direction='out'/>
249 ;; <arg name='password' type='s' direction='out'/>
250 ;; <arg name='username' type='s' direction='out'/>
251 ;; <arg name='domain' type='s' direction='out'/>
252 ;; <arg name='anonymous' type='b' direction='out'/>
253 ;; <arg name='password_save' type='u' direction='out'/>
254 ;; </method>
255 ;; <method name='askQuestion'>
256 ;; <arg name='message' type='s' direction='in'/>
257 ;; <arg name='choices' type='as' direction='in'/>
258 ;; <arg name='handled' type='b' direction='out'/>
259 ;; <arg name='aborted' type='b' direction='out'/>
260 ;; <arg name='choice' type='u' direction='out'/>
261 ;; </method>
262 ;; </interface>
263
264 ;; The following flags are used in "askPassword". They are defined in
265 ;; /usr/include/glib-2.0/gio/gioenums.h.
266
267 (defconst tramp-gvfs-password-need-password 1
268 "Operation requires a password.")
269
270 (defconst tramp-gvfs-password-need-username 2
271 "Operation requires a username.")
272
273 (defconst tramp-gvfs-password-need-domain 4
274 "Operation requires a domain.")
275
276 (defconst tramp-gvfs-password-saving-supported 8
277 "Operation supports saving settings.")
278
279 (defconst tramp-gvfs-password-anonymous-supported 16
280 "Operation supports anonymous users.")
281
282 (defconst tramp-bluez-service "org.bluez"
283 "The well known name of the BLUEZ service.")
284
285 (defconst tramp-bluez-interface-manager "org.bluez.Manager"
286 "The manager interface of the BLUEZ daemon.")
287
288 ;; <interface name='org.bluez.Manager'>
289 ;; <method name='DefaultAdapter'>
290 ;; <arg type='o' direction='out'/>
291 ;; </method>
292 ;; <method name='FindAdapter'>
293 ;; <arg type='s' direction='in'/>
294 ;; <arg type='o' direction='out'/>
295 ;; </method>
296 ;; <method name='ListAdapters'>
297 ;; <arg type='ao' direction='out'/>
298 ;; </method>
299 ;; <signal name='AdapterAdded'>
300 ;; <arg type='o'/>
301 ;; </signal>
302 ;; <signal name='AdapterRemoved'>
303 ;; <arg type='o'/>
304 ;; </signal>
305 ;; <signal name='DefaultAdapterChanged'>
306 ;; <arg type='o'/>
307 ;; </signal>
308 ;; </interface>
309
310 (defconst tramp-bluez-interface-adapter "org.bluez.Adapter"
311 "The adapter interface of the BLUEZ daemon.")
312
313 ;; <interface name='org.bluez.Adapter'>
314 ;; <method name='GetProperties'>
315 ;; <arg type='a{sv}' direction='out'/>
316 ;; </method>
317 ;; <method name='SetProperty'>
318 ;; <arg type='s' direction='in'/>
319 ;; <arg type='v' direction='in'/>
320 ;; </method>
321 ;; <method name='RequestMode'>
322 ;; <arg type='s' direction='in'/>
323 ;; </method>
324 ;; <method name='ReleaseMode'/>
325 ;; <method name='RequestSession'/>
326 ;; <method name='ReleaseSession'/>
327 ;; <method name='StartDiscovery'/>
328 ;; <method name='StopDiscovery'/>
329 ;; <method name='ListDevices'>
330 ;; <arg type='ao' direction='out'/>
331 ;; </method>
332 ;; <method name='CreateDevice'>
333 ;; <arg type='s' direction='in'/>
334 ;; <arg type='o' direction='out'/>
335 ;; </method>
336 ;; <method name='CreatePairedDevice'>
337 ;; <arg type='s' direction='in'/>
338 ;; <arg type='o' direction='in'/>
339 ;; <arg type='s' direction='in'/>
340 ;; <arg type='o' direction='out'/>
341 ;; </method>
342 ;; <method name='CancelDeviceCreation'>
343 ;; <arg type='s' direction='in'/>
344 ;; </method>
345 ;; <method name='RemoveDevice'>
346 ;; <arg type='o' direction='in'/>
347 ;; </method>
348 ;; <method name='FindDevice'>
349 ;; <arg type='s' direction='in'/>
350 ;; <arg type='o' direction='out'/>
351 ;; </method>
352 ;; <method name='RegisterAgent'>
353 ;; <arg type='o' direction='in'/>
354 ;; <arg type='s' direction='in'/>
355 ;; </method>
356 ;; <method name='UnregisterAgent'>
357 ;; <arg type='o' direction='in'/>
358 ;; </method>
359 ;; <signal name='DeviceCreated'>
360 ;; <arg type='o'/>
361 ;; </signal>
362 ;; <signal name='DeviceRemoved'>
363 ;; <arg type='o'/>
364 ;; </signal>
365 ;; <signal name='DeviceFound'>
366 ;; <arg type='s'/>
367 ;; <arg type='a{sv}'/>
368 ;; </signal>
369 ;; <signal name='PropertyChanged'>
370 ;; <arg type='s'/>
371 ;; <arg type='v'/>
372 ;; </signal>
373 ;; <signal name='DeviceDisappeared'>
374 ;; <arg type='s'/>
375 ;; </signal>
376 ;; </interface>
377
378 ;;;###tramp-autoload
379 (defcustom tramp-bluez-discover-devices-timeout 60
380 "Defines seconds since last bluetooth device discovery before rescanning.
381 A value of 0 would require an immediate discovery during hostname
382 completion, nil means to use always cached values for discovered
383 devices."
384 :group 'tramp
385 :version "23.2"
386 :type '(choice (const nil) integer))
387
388 (defvar tramp-bluez-discovery nil
389 "Indicator for a running bluetooth device discovery.
390 It keeps the timestamp of last discovery.")
391
392 (defvar tramp-bluez-devices nil
393 "Alist of detected bluetooth devices.
394 Every entry is a list (NAME ADDRESS).")
395
396 (defconst tramp-hal-service "org.freedesktop.Hal"
397 "The well known name of the HAL service.")
398
399 (defconst tramp-hal-path-manager "/org/freedesktop/Hal/Manager"
400 "The object path of the HAL daemon manager.")
401
402 (defconst tramp-hal-interface-manager "org.freedesktop.Hal.Manager"
403 "The manager interface of the HAL daemon.")
404
405 (defconst tramp-hal-interface-device "org.freedesktop.Hal.Device"
406 "The device interface of the HAL daemon.")
407
408 \f
409 ;; New handlers should be added here.
410 (defconst tramp-gvfs-file-name-handler-alist
411 '((access-file . ignore)
412 (add-name-to-file . tramp-gvfs-handle-copy-file)
413 ;; `byte-compiler-base-file-name' performed by default handler.
414 ;; `copy-directory' performed by default handler.
415 (copy-file . tramp-gvfs-handle-copy-file)
416 (delete-directory . tramp-gvfs-handle-delete-directory)
417 (delete-file . tramp-gvfs-handle-delete-file)
418 ;; `diff-latest-backup-file' performed by default handler.
419 (directory-file-name . tramp-handle-directory-file-name)
420 (directory-files . tramp-handle-directory-files)
421 (directory-files-and-attributes
422 . tramp-handle-directory-files-and-attributes)
423 (dired-call-process . ignore)
424 (dired-compress-file . ignore)
425 (dired-uncache . tramp-handle-dired-uncache)
426 (expand-file-name . tramp-gvfs-handle-expand-file-name)
427 (file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
428 (file-acl . ignore)
429 (file-attributes . tramp-gvfs-handle-file-attributes)
430 (file-directory-p . tramp-gvfs-handle-file-directory-p)
431 ;; `file-equal-p' performed by default handler.
432 (file-executable-p . tramp-gvfs-handle-file-executable-p)
433 (file-exists-p . tramp-handle-file-exists-p)
434 ;; `file-in-directory-p' performed by default handler.
435 (file-local-copy . tramp-gvfs-handle-file-local-copy)
436 (file-modes . tramp-handle-file-modes)
437 (file-name-all-completions . tramp-gvfs-handle-file-name-all-completions)
438 (file-name-as-directory . tramp-handle-file-name-as-directory)
439 (file-name-completion . tramp-handle-file-name-completion)
440 (file-name-directory . tramp-handle-file-name-directory)
441 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
442 ;; `file-name-sans-versions' performed by default handler.
443 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
444 (file-notify-add-watch . tramp-gvfs-handle-file-notify-add-watch)
445 (file-notify-rm-watch . tramp-handle-file-notify-rm-watch)
446 (file-ownership-preserved-p . ignore)
447 (file-readable-p . tramp-gvfs-handle-file-readable-p)
448 (file-regular-p . tramp-handle-file-regular-p)
449 (file-remote-p . tramp-handle-file-remote-p)
450 (file-selinux-context . ignore)
451 (file-symlink-p . tramp-handle-file-symlink-p)
452 ;; `file-truename' performed by default handler.
453 (file-writable-p . tramp-gvfs-handle-file-writable-p)
454 (find-backup-file-name . tramp-handle-find-backup-file-name)
455 ;; `find-file-noselect' performed by default handler.
456 ;; `get-file-buffer' performed by default handler.
457 (insert-directory . tramp-handle-insert-directory)
458 (insert-file-contents . tramp-handle-insert-file-contents)
459 (load . tramp-handle-load)
460 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
461 (make-directory . tramp-gvfs-handle-make-directory)
462 (make-directory-internal . ignore)
463 (make-symbolic-link . tramp-handle-make-symbolic-link)
464 (process-file . ignore)
465 (rename-file . tramp-gvfs-handle-rename-file)
466 (set-file-acl . ignore)
467 (set-file-modes . ignore)
468 (set-file-selinux-context . ignore)
469 (set-file-times . ignore)
470 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
471 (shell-command . ignore)
472 (start-file-process . ignore)
473 (substitute-in-file-name . tramp-handle-substitute-in-file-name)
474 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
475 (vc-registered . ignore)
476 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime)
477 (write-region . tramp-gvfs-handle-write-region))
478 "Alist of handler functions for Tramp GVFS method.
479 Operations not mentioned here will be handled by the default Emacs primitives.")
480
481 ;; It must be a `defsubst' in order to push the whole code into
482 ;; tramp-loaddefs.el. Otherwise, there would be recursive autoloading.
483 ;;;###tramp-autoload
484 (defsubst tramp-gvfs-file-name-p (filename)
485 "Check if it's a filename handled by the GVFS daemon."
486 (and (tramp-tramp-file-p filename)
487 (let ((method
488 (tramp-file-name-method (tramp-dissect-file-name filename))))
489 (and (stringp method) (member method tramp-gvfs-methods)))))
490
491 ;;;###tramp-autoload
492 (defun tramp-gvfs-file-name-handler (operation &rest args)
493 "Invoke the GVFS related OPERATION.
494 First arg specifies the OPERATION, second arg is a list of arguments to
495 pass to the OPERATION."
496 (unless tramp-gvfs-enabled
497 (tramp-user-error nil "Package ‘tramp-gvfs’ not supported"))
498 (let ((fn (assoc operation tramp-gvfs-file-name-handler-alist)))
499 (if fn
500 (save-match-data (apply (cdr fn) args))
501 (tramp-run-real-handler operation args))))
502
503 ;; This might be moved to tramp.el. It shall be the first file name
504 ;; handler.
505 ;;;###tramp-autoload
506 (when (featurep 'dbusbind)
507 (add-to-list 'tramp-foreign-file-name-handler-alist
508 (cons 'tramp-gvfs-file-name-p 'tramp-gvfs-file-name-handler)))
509
510 \f
511 ;; D-Bus helper function.
512
513 (defun tramp-gvfs-dbus-string-to-byte-array (string)
514 "Like `dbus-string-to-byte-array' but add trailing \\0 if needed."
515 (dbus-string-to-byte-array
516 (if (string-match "^(aya{sv})" tramp-gvfs-mountlocation-signature)
517 (concat string (string 0)) string)))
518
519 (defun tramp-gvfs-dbus-byte-array-to-string (byte-array)
520 "Like `dbus-byte-array-to-string' but remove trailing \\0 if exists."
521 ;; The byte array could be a variant. Take care.
522 (let ((byte-array
523 (if (and (consp byte-array) (atom (car byte-array)))
524 byte-array (car byte-array))))
525 (dbus-byte-array-to-string
526 (if (and (consp byte-array) (zerop (car (last byte-array))))
527 (butlast byte-array) byte-array))))
528
529 (defun tramp-gvfs-stringify-dbus-message (message)
530 "Convert a D-Bus message into readable UTF8 strings, used for traces."
531 (cond
532 ((and (consp message) (characterp (car message)))
533 (format "%S" (tramp-gvfs-dbus-byte-array-to-string message)))
534 ((consp message)
535 (mapcar 'tramp-gvfs-stringify-dbus-message message))
536 ((stringp message)
537 (format "%S" message))
538 (t message)))
539
540 (defmacro with-tramp-dbus-call-method
541 (vec synchronous bus service path interface method &rest args)
542 "Apply a D-Bus call on bus BUS.
543
544 If SYNCHRONOUS is non-nil, the call is synchronously. Otherwise,
545 it is an asynchronous call, with `ignore' as callback function.
546
547 The other arguments have the same meaning as with `dbus-call-method'
548 or `dbus-call-method-asynchronously'. Additionally, the call
549 will be traced by Tramp with trace level 6."
550 `(let ((func (if ,synchronous
551 'dbus-call-method 'dbus-call-method-asynchronously))
552 (args (append (list ,bus ,service ,path ,interface ,method)
553 (if ,synchronous (list ,@args) (list 'ignore ,@args))))
554 result)
555 (tramp-message ,vec 6 "%s %s" func args)
556 (setq result (apply func args))
557 (tramp-message ,vec 6 "%s" (tramp-gvfs-stringify-dbus-message result))
558 result))
559
560 (put 'with-tramp-dbus-call-method 'lisp-indent-function 2)
561 (put 'with-tramp-dbus-call-method 'edebug-form-spec '(form symbolp body))
562 (tramp-compat-font-lock-add-keywords
563 'emacs-lisp-mode '("\\<with-tramp-dbus-call-method\\>"))
564
565 (defvar tramp-gvfs-dbus-event-vector nil
566 "Current Tramp file name to be used, as vector.
567 It is needed when D-Bus signals or errors arrive, because there
568 is no information where to trace the message.")
569
570 (defun tramp-gvfs-dbus-event-error (event err)
571 "Called when a D-Bus error message arrives, see `dbus-event-error-functions'."
572 (when tramp-gvfs-dbus-event-vector
573 (tramp-message tramp-gvfs-dbus-event-vector 10 "%S" event)
574 (tramp-error tramp-gvfs-dbus-event-vector 'file-error "%s" (cadr err))))
575
576 ;; `dbus-event-error-hooks' has been renamed to `dbus-event-error-functions'.
577 (add-hook
578 (if (boundp 'dbus-event-error-functions)
579 'dbus-event-error-functions 'dbus-event-error-hooks)
580 'tramp-gvfs-dbus-event-error)
581
582 \f
583 ;; File name primitives.
584
585 (defun tramp-gvfs-do-copy-or-rename-file
586 (op filename newname &optional ok-if-already-exists keep-date
587 preserve-uid-gid preserve-extended-attributes)
588 "Copy or rename a remote file.
589 OP must be `copy' or `rename' and indicates the operation to perform.
590 FILENAME specifies the file to copy or rename, NEWNAME is the name of
591 the new file (for copy) or the new name of the file (for rename).
592 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
593 KEEP-DATE means to make sure that NEWNAME has the same timestamp
594 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
595 the uid and gid if both files are on the same host.
596 PRESERVE-EXTENDED-ATTRIBUTES is ignored.
597
598 This function is invoked by `tramp-gvfs-handle-copy-file' and
599 `tramp-gvfs-handle-rename-file'. It is an error if OP is neither
600 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
601 file names."
602 (unless (memq op '(copy rename))
603 (error "Unknown operation ‘%s’, must be ‘copy’ or ‘rename’" op))
604
605 (let ((t1 (tramp-tramp-file-p filename))
606 (t2 (tramp-tramp-file-p newname))
607 (equal-remote (tramp-equal-remote filename newname))
608 (file-operation (intern (format "%s-file" op)))
609 (gvfs-operation (if (eq op 'copy) "gvfs-copy" "gvfs-move"))
610 (msg-operation (if (eq op 'copy) "Copying" "Renaming")))
611
612 (with-parsed-tramp-file-name (if t1 filename newname) nil
613 (when (and (not ok-if-already-exists) (file-exists-p newname))
614 (tramp-error
615 v 'file-already-exists "File %s already exists" newname))
616
617 (if (or (and equal-remote
618 (tramp-get-connection-property v "direct-copy-failed" nil))
619 (and t1 (not (tramp-gvfs-file-name-p filename)))
620 (and t2 (not (tramp-gvfs-file-name-p newname))))
621
622 ;; We cannot copy or rename directly.
623 (let ((tmpfile (tramp-compat-make-temp-file filename)))
624 (cond
625 (preserve-extended-attributes
626 (tramp-compat-funcall
627 file-operation
628 filename tmpfile t keep-date preserve-uid-gid
629 preserve-extended-attributes))
630 (preserve-uid-gid
631 (tramp-compat-funcall
632 file-operation filename tmpfile t keep-date preserve-uid-gid))
633 (t
634 (tramp-compat-funcall
635 file-operation filename tmpfile t keep-date)))
636 (rename-file tmpfile newname ok-if-already-exists))
637
638 ;; Direct action.
639 (with-tramp-progress-reporter
640 v 0 (format "%s %s to %s" msg-operation filename newname)
641 (unless
642 (apply
643 'tramp-gvfs-send-command v gvfs-operation
644 (append
645 (and (eq op 'copy) (or keep-date preserve-uid-gid)
646 (list "--preserve"))
647 (list
648 (tramp-gvfs-url-file-name filename)
649 (tramp-gvfs-url-file-name newname))))
650
651 (if (or (not equal-remote)
652 (and equal-remote
653 (tramp-get-connection-property
654 v "direct-copy-failed" nil)))
655 ;; Propagate the error.
656 (with-current-buffer (tramp-get-connection-buffer v)
657 (goto-char (point-min))
658 (tramp-error-with-buffer
659 nil v 'file-error
660 "%s failed, see buffer ‘%s’ for details."
661 msg-operation (buffer-name)))
662
663 ;; Some WebDAV server, like the one from QNAP, do not
664 ;; support direct copy/move. Try a fallback.
665 (tramp-set-connection-property v "direct-copy-failed" t)
666 (tramp-gvfs-do-copy-or-rename-file
667 op filename newname ok-if-already-exists keep-date
668 preserve-uid-gid preserve-extended-attributes))))
669
670 (when (and t1 (eq op 'rename))
671 (with-parsed-tramp-file-name filename nil
672 (tramp-flush-file-property v (file-name-directory localname))
673 (tramp-flush-file-property v localname)))
674
675 (when t2
676 (with-parsed-tramp-file-name newname nil
677 (tramp-flush-file-property v (file-name-directory localname))
678 (tramp-flush-file-property v localname)))))))
679
680 (defun tramp-gvfs-handle-copy-file
681 (filename newname &optional ok-if-already-exists keep-date
682 preserve-uid-gid preserve-extended-attributes)
683 "Like `copy-file' for Tramp files."
684 (setq filename (expand-file-name filename))
685 (setq newname (expand-file-name newname))
686 (cond
687 ;; At least one file a Tramp file?
688 ((or (tramp-tramp-file-p filename)
689 (tramp-tramp-file-p newname))
690 (tramp-gvfs-do-copy-or-rename-file
691 'copy filename newname ok-if-already-exists keep-date
692 preserve-uid-gid preserve-extended-attributes))
693 ;; Compat section.
694 (preserve-extended-attributes
695 (tramp-run-real-handler
696 'copy-file
697 (list filename newname ok-if-already-exists keep-date
698 preserve-uid-gid preserve-extended-attributes)))
699 (preserve-uid-gid
700 (tramp-run-real-handler
701 'copy-file
702 (list filename newname ok-if-already-exists keep-date preserve-uid-gid)))
703 (t
704 (tramp-run-real-handler
705 'copy-file (list filename newname ok-if-already-exists keep-date)))))
706
707 (defun tramp-gvfs-handle-delete-directory (directory &optional recursive trash)
708 "Like `delete-directory' for Tramp files."
709 (when (and recursive (not (file-symlink-p directory)))
710 (mapc (lambda (file)
711 (if (eq t (car (file-attributes file)))
712 (tramp-compat-delete-directory file recursive trash)
713 (tramp-compat-delete-file file trash)))
714 (directory-files
715 directory 'full "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")))
716 (with-parsed-tramp-file-name directory nil
717 (tramp-flush-file-property v (file-name-directory localname))
718 (tramp-flush-directory-property v localname)
719 (unless
720 (tramp-gvfs-send-command
721 v (if (and trash delete-by-moving-to-trash) "gvfs-trash" "gvfs-rm")
722 (tramp-gvfs-url-file-name directory))
723 ;; Propagate the error.
724 (with-current-buffer (tramp-get-connection-buffer v)
725 (goto-char (point-min))
726 (tramp-error-with-buffer
727 nil v 'file-error "Couldn’t delete %s" directory)))))
728
729 (defun tramp-gvfs-handle-delete-file (filename &optional trash)
730 "Like `delete-file' for Tramp files."
731 (with-parsed-tramp-file-name filename nil
732 (tramp-flush-file-property v (file-name-directory localname))
733 (tramp-flush-file-property v localname)
734 (unless
735 (tramp-gvfs-send-command
736 v (if (and trash delete-by-moving-to-trash) "gvfs-trash" "gvfs-rm")
737 (tramp-gvfs-url-file-name filename))
738 ;; Propagate the error.
739 (with-current-buffer (tramp-get-connection-buffer v)
740 (goto-char (point-min))
741 (tramp-error-with-buffer
742 nil v 'file-error "Couldn’t delete %s" filename)))))
743
744 (defun tramp-gvfs-handle-expand-file-name (name &optional dir)
745 "Like `expand-file-name' for Tramp files."
746 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
747 (setq dir (or dir default-directory "/"))
748 ;; Unless NAME is absolute, concat DIR and NAME.
749 (unless (file-name-absolute-p name)
750 (setq name (concat (file-name-as-directory dir) name)))
751 ;; If NAME is not a Tramp file, run the real handler.
752 (if (not (tramp-tramp-file-p name))
753 (tramp-run-real-handler 'expand-file-name (list name nil))
754 ;; Dissect NAME.
755 (with-parsed-tramp-file-name name nil
756 ;; If there is a default location, expand tilde.
757 (when (string-match "\\`\\(~\\)\\(/\\|\\'\\)" localname)
758 (save-match-data
759 (tramp-gvfs-maybe-open-connection (vector method user host "/" hop)))
760 (setq localname
761 (replace-match
762 (tramp-get-file-property v "/" "default-location" "~")
763 nil t localname 1)))
764 ;; Tilde expansion is not possible.
765 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
766 (tramp-error
767 v 'file-error
768 "Cannot expand tilde in file ‘%s’" name))
769 (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
770 (setq localname (concat "/" localname)))
771 ;; We do not pass "/..".
772 (if (string-equal "smb" method)
773 (when (string-match "^/[^/]+\\(/\\.\\./?\\)" localname)
774 (setq localname (replace-match "/" t t localname 1)))
775 (when (string-match "^/\\.\\./?" localname)
776 (setq localname (replace-match "/" t t localname))))
777 ;; There might be a double slash. Remove this.
778 (while (string-match "//" localname)
779 (setq localname (replace-match "/" t t localname)))
780 ;; No tilde characters in file name, do normal
781 ;; `expand-file-name' (this does "/./" and "/../").
782 (tramp-make-tramp-file-name
783 method user host
784 (tramp-run-real-handler
785 'expand-file-name (list localname))))))
786
787 (defun tramp-gvfs-handle-file-attributes (filename &optional id-format)
788 "Like `file-attributes' for Tramp files."
789 (unless id-format (setq id-format 'integer))
790 (ignore-errors
791 ;; Don't modify `last-coding-system-used' by accident.
792 (let ((last-coding-system-used last-coding-system-used)
793 dirp res-symlink-target res-numlinks res-uid res-gid res-access
794 res-mod res-change res-size res-filemodes res-inode res-device)
795 (with-parsed-tramp-file-name filename nil
796 (with-tramp-file-property
797 v localname (format "file-attributes-%s" id-format)
798 (tramp-message v 5 "file attributes: %s" localname)
799 (tramp-gvfs-send-command
800 v "gvfs-info" (tramp-gvfs-url-file-name filename))
801 ;; Parse output ...
802 (with-current-buffer (tramp-get-connection-buffer v)
803 (goto-char (point-min))
804 (when (re-search-forward "attributes:" nil t)
805 ;; ... directory or symlink
806 (goto-char (point-min))
807 (setq dirp (if (re-search-forward "type:\\s-+directory" nil t) t))
808 (goto-char (point-min))
809 (setq res-symlink-target
810 (if (re-search-forward
811 "standard::symlink-target:\\s-+\\(\\S-+\\)" nil t)
812 (match-string 1)))
813 ;; ... number links
814 (goto-char (point-min))
815 (setq res-numlinks
816 (if (re-search-forward
817 "unix::nlink:\\s-+\\([0-9]+\\)" nil t)
818 (string-to-number (match-string 1)) 0))
819 ;; ... uid and gid
820 (goto-char (point-min))
821 (setq res-uid
822 (or (if (eq id-format 'integer)
823 (if (re-search-forward
824 "unix::uid:\\s-+\\([0-9]+\\)" nil t)
825 (string-to-number (match-string 1)))
826 (if (re-search-forward
827 "owner::user:\\s-+\\(\\S-+\\)" nil t)
828 (match-string 1)))
829 (tramp-get-local-uid id-format)))
830 (setq res-gid
831 (or (if (eq id-format 'integer)
832 (if (re-search-forward
833 "unix::gid:\\s-+\\([0-9]+\\)" nil t)
834 (string-to-number (match-string 1)))
835 (if (re-search-forward
836 "owner::group:\\s-+\\(\\S-+\\)" nil t)
837 (match-string 1)))
838 (tramp-get-local-gid id-format)))
839 ;; ... last access, modification and change time
840 (goto-char (point-min))
841 (setq res-access
842 (if (re-search-forward
843 "time::access:\\s-+\\([0-9]+\\)" nil t)
844 (seconds-to-time (string-to-number (match-string 1)))
845 '(0 0)))
846 (goto-char (point-min))
847 (setq res-mod
848 (if (re-search-forward
849 "time::modified:\\s-+\\([0-9]+\\)" nil t)
850 (seconds-to-time (string-to-number (match-string 1)))
851 '(0 0)))
852 (goto-char (point-min))
853 (setq res-change
854 (if (re-search-forward
855 "time::changed:\\s-+\\([0-9]+\\)" nil t)
856 (seconds-to-time (string-to-number (match-string 1)))
857 '(0 0)))
858 ;; ... size
859 (goto-char (point-min))
860 (setq res-size
861 (if (re-search-forward
862 "standard::size:\\s-+\\([0-9]+\\)" nil t)
863 (string-to-number (match-string 1)) 0))
864 ;; ... file mode flags
865 (goto-char (point-min))
866 (setq res-filemodes
867 (if (re-search-forward "unix::mode:\\s-+\\([0-9]+\\)" nil t)
868 (tramp-file-mode-from-int
869 (string-to-number (match-string 1)))
870 (if dirp "drwx------" "-rwx------")))
871 ;; ... inode and device
872 (goto-char (point-min))
873 (setq res-inode
874 (if (re-search-forward
875 "unix::inode:\\s-+\\([0-9]+\\)" nil t)
876 (string-to-number (match-string 1))
877 (tramp-get-inode v)))
878 (goto-char (point-min))
879 (setq res-device
880 (if (re-search-forward
881 "unix::device:\\s-+\\([0-9]+\\)" nil t)
882 (string-to-number (match-string 1))
883 (tramp-get-device v)))
884
885 ;; Return data gathered.
886 (list
887 ;; 0. t for directory, string (name linked to) for
888 ;; symbolic link, or nil.
889 (or dirp res-symlink-target)
890 ;; 1. Number of links to file.
891 res-numlinks
892 ;; 2. File uid.
893 res-uid
894 ;; 3. File gid.
895 res-gid
896 ;; 4. Last access time, as a list of integers.
897 ;; 5. Last modification time, likewise.
898 ;; 6. Last status change time, likewise.
899 res-access res-mod res-change
900 ;; 7. Size in bytes (-1, if number is out of range).
901 res-size
902 ;; 8. File modes.
903 res-filemodes
904 ;; 9. t if file's gid would change if file were deleted
905 ;; and recreated.
906 nil
907 ;; 10. Inode number.
908 res-inode
909 ;; 11. Device number.
910 res-device
911 ))))))))
912
913 (defun tramp-gvfs-handle-file-directory-p (filename)
914 "Like `file-directory-p' for Tramp files."
915 (eq t (car (file-attributes filename))))
916
917 (defun tramp-gvfs-handle-file-executable-p (filename)
918 "Like `file-executable-p' for Tramp files."
919 (with-parsed-tramp-file-name filename nil
920 (with-tramp-file-property v localname "file-executable-p"
921 (tramp-check-cached-permissions v ?x))))
922
923 (defun tramp-gvfs-handle-file-local-copy (filename)
924 "Like `file-local-copy' for Tramp files."
925 (with-parsed-tramp-file-name filename nil
926 (let ((tmpfile (tramp-compat-make-temp-file filename)))
927 (unless (file-exists-p filename)
928 (tramp-error
929 v 'file-error
930 "Cannot make local copy of non-existing file ‘%s’" filename))
931 (copy-file filename tmpfile t t)
932 tmpfile)))
933
934 (defun tramp-gvfs-handle-file-name-all-completions (filename directory)
935 "Like `file-name-all-completions' for Tramp files."
936 (unless (save-match-data (string-match "/" filename))
937 (with-parsed-tramp-file-name (expand-file-name directory) nil
938
939 (all-completions
940 filename
941 (mapcar
942 'list
943 (or
944 ;; Try cache entries for filename, filename with last
945 ;; character removed, filename with last two characters
946 ;; removed, ..., and finally the empty string - all
947 ;; concatenated to the local directory name.
948 (let ((remote-file-name-inhibit-cache
949 (or remote-file-name-inhibit-cache
950 tramp-completion-reread-directory-timeout)))
951
952 ;; This is inefficient for very long filenames, pity
953 ;; `reduce' is not available...
954 (car
955 (apply
956 'append
957 (mapcar
958 (lambda (x)
959 (let ((cache-hit
960 (tramp-get-file-property
961 v
962 (concat localname (substring filename 0 x))
963 "file-name-all-completions"
964 nil)))
965 (when cache-hit (list cache-hit))))
966 ;; We cannot use a length of 0, because file properties
967 ;; for "foo" and "foo/" are identical.
968 (tramp-compat-number-sequence (length filename) 1 -1)))))
969
970 ;; Cache expired or no matching cache entry found so we need
971 ;; to perform a remote operation.
972 (let ((result '("." ".."))
973 entry)
974 ;; Get a list of directories and files.
975 (tramp-gvfs-send-command
976 v "gvfs-ls" "-h" (tramp-gvfs-url-file-name directory))
977
978 ;; Now grab the output.
979 (with-temp-buffer
980 (insert-buffer-substring (tramp-get-connection-buffer v))
981 (goto-char (point-max))
982 (while (zerop (forward-line -1))
983 (setq entry (buffer-substring (point) (point-at-eol)))
984 (when (string-match filename entry)
985 (if (file-directory-p (expand-file-name entry directory))
986 (push (concat entry "/") result)
987 (push entry result)))))
988
989 ;; Because the remote op went through OK we know the
990 ;; directory we `cd'-ed to exists.
991 (tramp-set-file-property v localname "file-exists-p" t)
992
993 ;; Because the remote op went through OK we know every
994 ;; file listed by `ls' exists.
995 (mapc (lambda (entry)
996 (tramp-set-file-property
997 v (concat localname entry) "file-exists-p" t))
998 result)
999
1000 ;; Store result in the cache.
1001 (tramp-set-file-property
1002 v (concat localname filename)
1003 "file-name-all-completions" result))))))))
1004
1005 (defun tramp-gvfs-handle-file-notify-add-watch (file-name _flags _callback)
1006 "Like `file-notify-add-watch' for Tramp files."
1007 (setq file-name (expand-file-name file-name))
1008 (with-parsed-tramp-file-name file-name nil
1009 (let ((p (start-process
1010 "gvfs-monitor-file" (generate-new-buffer " *gvfs-monitor-file*")
1011 "gvfs-monitor-file" (tramp-gvfs-url-file-name file-name))))
1012 (if (not (processp p))
1013 (tramp-error
1014 v 'file-notify-error "gvfs-monitor-file failed to start")
1015 (tramp-message
1016 v 6 "Run ‘%s’, %S" (mapconcat 'identity (process-command p) " ") p)
1017 (tramp-set-connection-property p "vector" v)
1018 (tramp-compat-set-process-query-on-exit-flag p nil)
1019 (set-process-filter p 'tramp-gvfs-file-gvfs-monitor-file-process-filter)
1020 (with-current-buffer (process-buffer p)
1021 (setq default-directory (file-name-directory file-name)))
1022 p))))
1023
1024 (defun tramp-gvfs-file-gvfs-monitor-file-process-filter (proc string)
1025 "Read output from \"gvfs-monitor-file\" and add corresponding file-notify events."
1026 (let* ((rest-string (tramp-compat-process-get proc 'rest-string))
1027 (dd (with-current-buffer (process-buffer proc) default-directory))
1028 (ddu (regexp-quote (tramp-gvfs-url-file-name dd))))
1029 (when rest-string
1030 (tramp-message proc 10 "Previous string:\n%s" rest-string))
1031 (tramp-message proc 6 "%S\n%s" proc string)
1032 (setq string (concat rest-string string)
1033 ;; Attribute change is returned in unused wording.
1034 string (tramp-compat-replace-regexp-in-string
1035 "ATTRIB CHANGED" "ATTRIBUTE_CHANGED" string))
1036
1037 (while (string-match
1038 (concat "^[\n\r]*"
1039 "File Monitor Event:[\n\r]+"
1040 "File = \\([^\n\r]+\\)[\n\r]+"
1041 "Event = \\([^[:blank:]]+\\)[\n\r]+")
1042 string)
1043 (let ((action (intern-soft
1044 (tramp-compat-replace-regexp-in-string
1045 "_" "-" (downcase (match-string 2 string)))))
1046 (file (match-string 1 string)))
1047 (setq string (replace-match "" nil nil string))
1048 ;; File names are returned as URL paths. We must convert them.
1049 (when (string-match ddu file)
1050 (setq file (replace-match dd nil nil file)))
1051 (while (string-match "%\\([0-9A-F]\\{2\\}\\)" file)
1052 (setq file
1053 (replace-match
1054 (char-to-string (string-to-number (match-string 1 file) 16))
1055 nil nil file)))
1056 ;; Usually, we would add an Emacs event now. Unfortunately,
1057 ;; `unread-command-events' does not accept several events at
1058 ;; once. Therefore, we apply the callback directly.
1059 (tramp-compat-funcall 'file-notify-callback (list proc action file))))
1060
1061 ;; Save rest of the string.
1062 (when (zerop (length string)) (setq string nil))
1063 (when string (tramp-message proc 10 "Rest string:\n%s" string))
1064 (tramp-compat-process-put proc 'rest-string string)))
1065
1066 (defun tramp-gvfs-handle-file-readable-p (filename)
1067 "Like `file-readable-p' for Tramp files."
1068 (with-parsed-tramp-file-name filename nil
1069 (with-tramp-file-property v localname "file-executable-p"
1070 (tramp-check-cached-permissions v ?r))))
1071
1072 (defun tramp-gvfs-handle-file-writable-p (filename)
1073 "Like `file-writable-p' for Tramp files."
1074 (with-parsed-tramp-file-name filename nil
1075 (with-tramp-file-property v localname "file-writable-p"
1076 (if (file-exists-p filename)
1077 (tramp-check-cached-permissions v ?w)
1078 ;; If file doesn't exist, check if directory is writable.
1079 (and (file-directory-p (file-name-directory filename))
1080 (file-writable-p (file-name-directory filename)))))))
1081
1082 (defun tramp-gvfs-handle-make-directory (dir &optional parents)
1083 "Like `make-directory' for Tramp files."
1084 (setq dir (directory-file-name (expand-file-name dir)))
1085 (with-parsed-tramp-file-name dir nil
1086 (tramp-flush-file-property v (file-name-directory localname))
1087 (tramp-flush-directory-property v localname)
1088 (save-match-data
1089 (let ((ldir (file-name-directory dir)))
1090 ;; Make missing directory parts. "gvfs-mkdir -p ..." does not
1091 ;; work robust.
1092 (when (and parents (not (file-directory-p ldir)))
1093 (make-directory ldir parents))
1094 ;; Just do it.
1095 (unless (tramp-gvfs-send-command
1096 v "gvfs-mkdir" (tramp-gvfs-url-file-name dir))
1097 (tramp-error v 'file-error "Couldn’t make directory %s" dir))))))
1098
1099 (defun tramp-gvfs-handle-rename-file
1100 (filename newname &optional ok-if-already-exists)
1101 "Like `rename-file' for Tramp files."
1102 ;; Check if both files are local -- invoke normal rename-file.
1103 ;; Otherwise, use Tramp from local system.
1104 (setq filename (expand-file-name filename))
1105 (setq newname (expand-file-name newname))
1106 ;; At least one file a Tramp file?
1107 (if (or (tramp-tramp-file-p filename)
1108 (tramp-tramp-file-p newname))
1109 (tramp-gvfs-do-copy-or-rename-file
1110 'rename filename newname ok-if-already-exists t t)
1111 (tramp-run-real-handler
1112 'rename-file (list filename newname ok-if-already-exists))))
1113
1114 (defun tramp-gvfs-handle-write-region
1115 (start end filename &optional append visit lockname confirm)
1116 "Like `write-region' for Tramp files."
1117 (with-parsed-tramp-file-name filename nil
1118 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
1119 (when (and (not (featurep 'xemacs)) confirm (file-exists-p filename))
1120 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename))
1121 (tramp-error v 'file-error "File not overwritten")))
1122
1123 (let ((tmpfile (tramp-compat-make-temp-file filename)))
1124 (when (and append (file-exists-p filename))
1125 (copy-file filename tmpfile 'ok))
1126 ;; We say `no-message' here because we don't want the visited file
1127 ;; modtime data to be clobbered from the temp file. We call
1128 ;; `set-visited-file-modtime' ourselves later on.
1129 (tramp-run-real-handler
1130 'write-region
1131 (if confirm ; don't pass this arg unless defined for backward compat.
1132 (list start end tmpfile append 'no-message lockname confirm)
1133 (list start end tmpfile append 'no-message lockname)))
1134 (condition-case nil
1135 (rename-file tmpfile filename 'ok-if-already-exists)
1136 (error
1137 (delete-file tmpfile)
1138 (tramp-error
1139 v 'file-error "Couldn’t write region to ‘%s’" filename))))
1140
1141 (tramp-flush-file-property v (file-name-directory localname))
1142 (tramp-flush-file-property v localname)
1143
1144 ;; Set file modification time.
1145 (when (or (eq visit t) (stringp visit))
1146 (set-visited-file-modtime (nth 5 (file-attributes filename))))
1147
1148 ;; The end.
1149 (when (or (eq visit t) (null visit) (stringp visit))
1150 (tramp-message v 0 "Wrote %s" filename))
1151 (run-hooks 'tramp-handle-write-region-hook)))
1152
1153 \f
1154 ;; File name conversions.
1155
1156 (defun tramp-gvfs-url-file-name (filename)
1157 "Return FILENAME in URL syntax."
1158 ;; "/" must NOT be hexlified.
1159 (let ((url-unreserved-chars (cons ?/ url-unreserved-chars))
1160 result)
1161 (setq
1162 result
1163 (url-recreate-url
1164 (if (tramp-tramp-file-p filename)
1165 (with-parsed-tramp-file-name filename nil
1166 (when (and user (string-match tramp-user-with-domain-regexp user))
1167 (setq user
1168 (concat (match-string 2 user) ";" (match-string 1 user))))
1169 (url-parse-make-urlobj
1170 method (and user (url-hexify-string user)) nil
1171 (tramp-file-name-real-host v) (tramp-file-name-port v)
1172 (and localname (url-hexify-string localname)) nil nil t))
1173 (url-parse-make-urlobj
1174 "file" nil nil nil nil
1175 (url-hexify-string (file-truename filename)) nil nil t))))
1176 (when (tramp-tramp-file-p filename)
1177 (with-parsed-tramp-file-name filename nil
1178 (tramp-message v 10 "remote file ‘%s’ is URL ‘%s’" filename result)))
1179 result))
1180
1181 (defun tramp-gvfs-object-path (filename)
1182 "Create a D-Bus object path from FILENAME."
1183 (expand-file-name (dbus-escape-as-identifier filename) tramp-gvfs-path-tramp))
1184
1185 (defun tramp-gvfs-file-name (object-path)
1186 "Retrieve file name from D-Bus OBJECT-PATH."
1187 (dbus-unescape-from-identifier
1188 (tramp-compat-replace-regexp-in-string
1189 "^.*/\\([^/]+\\)$" "\\1" object-path)))
1190
1191 (defun tramp-bluez-address (device)
1192 "Return bluetooth device address from a given bluetooth DEVICE name."
1193 (when (stringp device)
1194 (if (string-match tramp-ipv6-regexp device)
1195 (match-string 0 device)
1196 (cadr (assoc device (tramp-bluez-list-devices))))))
1197
1198 (defun tramp-bluez-device (address)
1199 "Return bluetooth device name from a given bluetooth device ADDRESS.
1200 ADDRESS can have the form \"xx:xx:xx:xx:xx:xx\" or \"[xx:xx:xx:xx:xx:xx]\"."
1201 (when (stringp address)
1202 (while (string-match "[][]" address)
1203 (setq address (replace-match "" t t address)))
1204 (let (result)
1205 (dolist (item (tramp-bluez-list-devices) result)
1206 (when (string-match address (cadr item))
1207 (setq result (car item)))))))
1208
1209 \f
1210 ;; D-Bus GVFS functions.
1211
1212 (defun tramp-gvfs-handler-askpassword (message user domain flags)
1213 "Implementation for the \"org.gtk.vfs.MountOperation.askPassword\" method."
1214 (let* ((filename
1215 (tramp-gvfs-file-name (dbus-event-path-name last-input-event)))
1216 (pw-prompt
1217 (format
1218 "%s for %s "
1219 (if (string-match "\\([pP]assword\\|[pP]assphrase\\)" message)
1220 (capitalize (match-string 1 message))
1221 "Password")
1222 filename))
1223 password)
1224
1225 (condition-case nil
1226 (with-parsed-tramp-file-name filename l
1227 (when (and (zerop (length user))
1228 (not
1229 (zerop (logand flags tramp-gvfs-password-need-username))))
1230 (setq user (read-string "User name: ")))
1231 (when (and (zerop (length domain))
1232 (not
1233 (zerop (logand flags tramp-gvfs-password-need-domain))))
1234 (setq domain (read-string "Domain name: ")))
1235
1236 (tramp-message l 6 "%S %S %S %d" message user domain flags)
1237 (unless (tramp-get-connection-property l "first-password-request" nil)
1238 (tramp-clear-passwd l))
1239
1240 (setq tramp-current-method l-method
1241 tramp-current-user user
1242 tramp-current-host l-host
1243 password (tramp-read-passwd
1244 (tramp-get-connection-process l) pw-prompt))
1245
1246 ;; Return result.
1247 (if (stringp password)
1248 (list
1249 t ;; password handled.
1250 nil ;; no abort of D-Bus.
1251 password
1252 (tramp-file-name-real-user l)
1253 domain
1254 nil ;; not anonymous.
1255 0) ;; no password save.
1256 ;; No password provided.
1257 (list nil t "" (tramp-file-name-real-user l) domain nil 0)))
1258
1259 ;; When QUIT is raised, we shall return this information to D-Bus.
1260 (quit (list nil t "" "" "" nil 0)))))
1261
1262 (defun tramp-gvfs-handler-askquestion (message choices)
1263 "Implementation for the \"org.gtk.vfs.MountOperation.askQuestion\" method."
1264 (save-window-excursion
1265 (let ((enable-recursive-minibuffers t)
1266 choice)
1267
1268 (condition-case nil
1269 (with-parsed-tramp-file-name
1270 (tramp-gvfs-file-name (dbus-event-path-name last-input-event)) nil
1271 (tramp-message v 6 "%S %S" message choices)
1272
1273 ;; In theory, there can be several choices. Until now,
1274 ;; there is only the question whether to accept an unknown
1275 ;; host signature.
1276 (with-temp-buffer
1277 ;; Preserve message for `progress-reporter'.
1278 (tramp-compat-with-temp-message ""
1279 (insert message)
1280 (pop-to-buffer (current-buffer))
1281 (setq choice (if (yes-or-no-p (concat (car choices) " ")) 0 1))
1282 (tramp-message v 6 "%d" choice)))
1283
1284 ;; When the choice is "no", we set a dummy fuse-mountpoint
1285 ;; in order to leave the timeout.
1286 (unless (zerop choice)
1287 (tramp-set-file-property v "/" "fuse-mountpoint" "/"))
1288
1289 (list
1290 t ;; handled.
1291 nil ;; no abort of D-Bus.
1292 choice))
1293
1294 ;; When QUIT is raised, we shall return this information to D-Bus.
1295 (quit (list nil t 0))))))
1296
1297 (defun tramp-gvfs-handler-mounted-unmounted (mount-info)
1298 "Signal handler for the \"org.gtk.vfs.MountTracker.mounted\" and
1299 \"org.gtk.vfs.MountTracker.unmounted\" signals."
1300 (ignore-errors
1301 (let ((signal-name (dbus-event-member-name last-input-event))
1302 (elt mount-info))
1303 ;; Jump over the first elements of the mount info. Since there
1304 ;; were changes in the entries, we cannot access dedicated
1305 ;; elements.
1306 (while (stringp (car elt)) (setq elt (cdr elt)))
1307 (let* ((fuse-mountpoint (tramp-gvfs-dbus-byte-array-to-string (cadr elt)))
1308 (mount-spec (caddr elt))
1309 (default-location (tramp-gvfs-dbus-byte-array-to-string
1310 (cadddr elt)))
1311 (method (tramp-gvfs-dbus-byte-array-to-string
1312 (cadr (assoc "type" (cadr mount-spec)))))
1313 (user (tramp-gvfs-dbus-byte-array-to-string
1314 (cadr (assoc "user" (cadr mount-spec)))))
1315 (domain (tramp-gvfs-dbus-byte-array-to-string
1316 (cadr (assoc "domain" (cadr mount-spec)))))
1317 (host (tramp-gvfs-dbus-byte-array-to-string
1318 (cadr (or (assoc "host" (cadr mount-spec))
1319 (assoc "server" (cadr mount-spec))))))
1320 (port (tramp-gvfs-dbus-byte-array-to-string
1321 (cadr (assoc "port" (cadr mount-spec)))))
1322 (ssl (tramp-gvfs-dbus-byte-array-to-string
1323 (cadr (assoc "ssl" (cadr mount-spec)))))
1324 (prefix (concat (tramp-gvfs-dbus-byte-array-to-string
1325 (car mount-spec))
1326 (tramp-gvfs-dbus-byte-array-to-string
1327 (cadr (assoc "share" (cadr mount-spec)))))))
1328 (when (string-match "^smb" method)
1329 (setq method "smb"))
1330 (when (string-equal "obex" method)
1331 (setq host (tramp-bluez-device host)))
1332 (when (and (string-equal "dav" method) (string-equal "true" ssl))
1333 (setq method "davs"))
1334 (unless (zerop (length domain))
1335 (setq user (concat user tramp-prefix-domain-format domain)))
1336 (unless (zerop (length port))
1337 (setq host (concat host tramp-prefix-port-format port)))
1338 (with-parsed-tramp-file-name
1339 (tramp-make-tramp-file-name method user host "") nil
1340 (tramp-message
1341 v 6 "%s %s"
1342 signal-name (tramp-gvfs-stringify-dbus-message mount-info))
1343 (tramp-set-file-property v "/" "list-mounts" 'undef)
1344 (if (string-equal (downcase signal-name) "unmounted")
1345 (tramp-set-file-property v "/" "fuse-mountpoint" nil)
1346 ;; Set prefix, mountpoint and location.
1347 (unless (string-equal prefix "/")
1348 (tramp-set-file-property v "/" "prefix" prefix))
1349 (tramp-set-file-property v "/" "fuse-mountpoint" fuse-mountpoint)
1350 (tramp-set-file-property
1351 v "/" "default-location" default-location)))))))
1352
1353 (when tramp-gvfs-enabled
1354 (dbus-register-signal
1355 :session nil tramp-gvfs-path-mounttracker
1356 tramp-gvfs-interface-mounttracker "mounted"
1357 'tramp-gvfs-handler-mounted-unmounted)
1358 (dbus-register-signal
1359 :session nil tramp-gvfs-path-mounttracker
1360 tramp-gvfs-interface-mounttracker "Mounted"
1361 'tramp-gvfs-handler-mounted-unmounted)
1362
1363 (dbus-register-signal
1364 :session nil tramp-gvfs-path-mounttracker
1365 tramp-gvfs-interface-mounttracker "unmounted"
1366 'tramp-gvfs-handler-mounted-unmounted)
1367 (dbus-register-signal
1368 :session nil tramp-gvfs-path-mounttracker
1369 tramp-gvfs-interface-mounttracker "Unmounted"
1370 'tramp-gvfs-handler-mounted-unmounted))
1371
1372 (defun tramp-gvfs-connection-mounted-p (vec)
1373 "Check, whether the location is already mounted."
1374 (or
1375 (tramp-get-file-property vec "/" "fuse-mountpoint" nil)
1376 (catch 'mounted
1377 (dolist
1378 (elt
1379 (with-tramp-file-property vec "/" "list-mounts"
1380 (with-tramp-dbus-call-method vec t
1381 :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker
1382 tramp-gvfs-interface-mounttracker tramp-gvfs-listmounts))
1383 nil)
1384 ;; Jump over the first elements of the mount info. Since there
1385 ;; were changes in the entries, we cannot access dedicated
1386 ;; elements.
1387 (while (stringp (car elt)) (setq elt (cdr elt)))
1388 (let* ((fuse-mountpoint (tramp-gvfs-dbus-byte-array-to-string
1389 (cadr elt)))
1390 (mount-spec (caddr elt))
1391 (default-location (tramp-gvfs-dbus-byte-array-to-string
1392 (cadddr elt)))
1393 (method (tramp-gvfs-dbus-byte-array-to-string
1394 (cadr (assoc "type" (cadr mount-spec)))))
1395 (user (tramp-gvfs-dbus-byte-array-to-string
1396 (cadr (assoc "user" (cadr mount-spec)))))
1397 (domain (tramp-gvfs-dbus-byte-array-to-string
1398 (cadr (assoc "domain" (cadr mount-spec)))))
1399 (host (tramp-gvfs-dbus-byte-array-to-string
1400 (cadr (or (assoc "host" (cadr mount-spec))
1401 (assoc "server" (cadr mount-spec))))))
1402 (port (tramp-gvfs-dbus-byte-array-to-string
1403 (cadr (assoc "port" (cadr mount-spec)))))
1404 (ssl (tramp-gvfs-dbus-byte-array-to-string
1405 (cadr (assoc "ssl" (cadr mount-spec)))))
1406 (prefix (concat (tramp-gvfs-dbus-byte-array-to-string
1407 (car mount-spec))
1408 (tramp-gvfs-dbus-byte-array-to-string
1409 (cadr (assoc "share" (cadr mount-spec)))))))
1410 (when (string-match "^smb" method)
1411 (setq method "smb"))
1412 (when (string-equal "obex" method)
1413 (setq host (tramp-bluez-device host)))
1414 (when (and (string-equal "dav" method) (string-equal "true" ssl))
1415 (setq method "davs"))
1416 (when (and (string-equal "synce" method) (zerop (length user)))
1417 (setq user (or (tramp-file-name-user vec) "")))
1418 (unless (zerop (length domain))
1419 (setq user (concat user tramp-prefix-domain-format domain)))
1420 (unless (zerop (length port))
1421 (setq host (concat host tramp-prefix-port-format port)))
1422 (when (and
1423 (string-equal method (tramp-file-name-method vec))
1424 (string-equal user (or (tramp-file-name-user vec) ""))
1425 (string-equal host (tramp-file-name-host vec))
1426 (string-match (concat "^" (regexp-quote prefix))
1427 (tramp-file-name-localname vec)))
1428 ;; Set prefix, mountpoint and location.
1429 (unless (string-equal prefix "/")
1430 (tramp-set-file-property vec "/" "prefix" prefix))
1431 (tramp-set-file-property vec "/" "fuse-mountpoint" fuse-mountpoint)
1432 (tramp-set-file-property vec "/" "default-location" default-location)
1433 (throw 'mounted t)))))))
1434
1435 (defun tramp-gvfs-mount-spec-entry (key value)
1436 "Construct a mount-spec entry to be used in a mount_spec.
1437 It was \"a(say)\", but has changed to \"a{sv})\"."
1438 (if (string-match "^(aya{sv})" tramp-gvfs-mountlocation-signature)
1439 (list :dict-entry key
1440 (list :variant (tramp-gvfs-dbus-string-to-byte-array value)))
1441 (list :struct key (tramp-gvfs-dbus-string-to-byte-array value))))
1442
1443 (defun tramp-gvfs-mount-spec (vec)
1444 "Return a mount-spec for \"org.gtk.vfs.MountTracker.mountLocation\"."
1445 (let* ((method (tramp-file-name-method vec))
1446 (user (tramp-file-name-real-user vec))
1447 (domain (tramp-file-name-domain vec))
1448 (host (tramp-file-name-real-host vec))
1449 (port (tramp-file-name-port vec))
1450 (localname (tramp-file-name-localname vec))
1451 (ssl (if (string-match "^davs" method) "true" "false"))
1452 (mount-spec
1453 `(:array
1454 ,@(cond
1455 ((string-equal "smb" method)
1456 (string-match "^/?\\([^/]+\\)" localname)
1457 (list (tramp-gvfs-mount-spec-entry "type" "smb-share")
1458 (tramp-gvfs-mount-spec-entry "server" host)
1459 (tramp-gvfs-mount-spec-entry
1460 "share" (match-string 1 localname))))
1461 ((string-equal "obex" method)
1462 (list (tramp-gvfs-mount-spec-entry "type" method)
1463 (tramp-gvfs-mount-spec-entry
1464 "host" (concat "[" (tramp-bluez-address host) "]"))))
1465 ((string-match "\\`dav" method)
1466 (list (tramp-gvfs-mount-spec-entry "type" "dav")
1467 (tramp-gvfs-mount-spec-entry "host" host)
1468 (tramp-gvfs-mount-spec-entry "ssl" ssl)))
1469 (t
1470 (list (tramp-gvfs-mount-spec-entry "type" method)
1471 (tramp-gvfs-mount-spec-entry "host" host))))
1472 ,@(when user
1473 (list (tramp-gvfs-mount-spec-entry "user" user)))
1474 ,@(when domain
1475 (list (tramp-gvfs-mount-spec-entry "domain" domain)))
1476 ,@(when port
1477 (list (tramp-gvfs-mount-spec-entry
1478 "port" (number-to-string port))))))
1479 (mount-pref
1480 (if (and (string-match "\\`dav" method)
1481 (string-match "^/?[^/]+" localname))
1482 (match-string 0 localname)
1483 "/")))
1484
1485 ;; Return.
1486 `(:struct ,(tramp-gvfs-dbus-string-to-byte-array mount-pref) ,mount-spec)))
1487
1488 \f
1489 ;; Connection functions.
1490
1491 (defun tramp-gvfs-maybe-open-connection (vec)
1492 "Maybe open a connection VEC.
1493 Does not do anything if a connection is already open, but re-opens the
1494 connection if a previous connection has died for some reason."
1495 (tramp-check-proper-method-and-host vec)
1496
1497 ;; We set the file name, in case there are incoming D-Bus signals or
1498 ;; D-Bus errors.
1499 (setq tramp-gvfs-dbus-event-vector vec)
1500
1501 ;; For password handling, we need a process bound to the connection
1502 ;; buffer. Therefore, we create a dummy process. Maybe there is a
1503 ;; better solution?
1504 (unless (get-buffer-process (tramp-get-connection-buffer vec))
1505 (let ((p (make-network-process
1506 :name (tramp-buffer-name vec)
1507 :buffer (tramp-get-connection-buffer vec)
1508 :server t :host 'local :service t)))
1509 (tramp-compat-set-process-query-on-exit-flag p nil)))
1510
1511 (unless (tramp-gvfs-connection-mounted-p vec)
1512 (let* ((method (tramp-file-name-method vec))
1513 (user (tramp-file-name-user vec))
1514 (host (tramp-file-name-host vec))
1515 (localname (tramp-file-name-localname vec))
1516 (object-path
1517 (tramp-gvfs-object-path
1518 (tramp-make-tramp-file-name method user host ""))))
1519
1520 (when (and (string-equal method "smb")
1521 (string-equal localname "/"))
1522 (tramp-error vec 'file-error "Filename must contain a Windows share"))
1523
1524 (with-tramp-progress-reporter
1525 vec 3
1526 (if (zerop (length user))
1527 (format "Opening connection for %s using %s" host method)
1528 (format "Opening connection for %s@%s using %s" user host method))
1529
1530 ;; Enable `auth-source'.
1531 (tramp-set-connection-property vec "first-password-request" t)
1532
1533 ;; There will be a callback of "askPassword" when a password is
1534 ;; needed.
1535 (dbus-register-method
1536 :session dbus-service-emacs object-path
1537 tramp-gvfs-interface-mountoperation "askPassword"
1538 'tramp-gvfs-handler-askpassword)
1539 (dbus-register-method
1540 :session dbus-service-emacs object-path
1541 tramp-gvfs-interface-mountoperation "AskPassword"
1542 'tramp-gvfs-handler-askpassword)
1543
1544 ;; There could be a callback of "askQuestion" when adding fingerprint.
1545 (dbus-register-method
1546 :session dbus-service-emacs object-path
1547 tramp-gvfs-interface-mountoperation "askQuestion"
1548 'tramp-gvfs-handler-askquestion)
1549 (dbus-register-method
1550 :session dbus-service-emacs object-path
1551 tramp-gvfs-interface-mountoperation "AskQuestion"
1552 'tramp-gvfs-handler-askquestion)
1553
1554 ;; The call must be asynchronously, because of the "askPassword"
1555 ;; or "askQuestion"callbacks.
1556 (if (string-match "(so)$" tramp-gvfs-mountlocation-signature)
1557 (with-tramp-dbus-call-method vec nil
1558 :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker
1559 tramp-gvfs-interface-mounttracker tramp-gvfs-mountlocation
1560 (tramp-gvfs-mount-spec vec)
1561 `(:struct :string ,(dbus-get-unique-name :session)
1562 :object-path ,object-path))
1563 (with-tramp-dbus-call-method vec nil
1564 :session tramp-gvfs-service-daemon tramp-gvfs-path-mounttracker
1565 tramp-gvfs-interface-mounttracker tramp-gvfs-mountlocation
1566 (tramp-gvfs-mount-spec vec)
1567 :string (dbus-get-unique-name :session) :object-path object-path))
1568
1569 ;; We must wait, until the mount is applied. This will be
1570 ;; indicated by the "mounted" signal, i.e. the "fuse-mountpoint"
1571 ;; file property.
1572 (with-timeout
1573 ((or (tramp-get-method-parameter vec 'tramp-connection-timeout)
1574 tramp-connection-timeout)
1575 (if (zerop (length (tramp-file-name-user vec)))
1576 (tramp-error
1577 vec 'file-error
1578 "Timeout reached mounting %s using %s" host method)
1579 (tramp-error
1580 vec 'file-error
1581 "Timeout reached mounting %s@%s using %s" user host method)))
1582 (while (not (tramp-get-file-property vec "/" "fuse-mountpoint" nil))
1583 (read-event nil nil 0.1)))
1584
1585 ;; If `tramp-gvfs-handler-askquestion' has returned "No", it
1586 ;; is marked with the fuse-mountpoint "/". We shall react.
1587 (when (string-equal
1588 (tramp-get-file-property vec "/" "fuse-mountpoint" "") "/")
1589 (tramp-error vec 'file-error "FUSE mount denied")))))
1590
1591 ;; In `tramp-check-cached-permissions', the connection properties
1592 ;; {uig,gid}-{integer,string} are used. We set them to their local
1593 ;; counterparts.
1594 (with-tramp-connection-property
1595 vec "uid-integer" (tramp-get-local-uid 'integer))
1596 (with-tramp-connection-property
1597 vec "gid-integer" (tramp-get-local-gid 'integer))
1598 (with-tramp-connection-property
1599 vec "uid-string" (tramp-get-local-uid 'string))
1600 (with-tramp-connection-property
1601 vec "gid-string" (tramp-get-local-gid 'string)))
1602
1603 (defun tramp-gvfs-send-command (vec command &rest args)
1604 "Send the COMMAND with its ARGS to connection VEC.
1605 COMMAND is usually a command from the gvfs-* utilities.
1606 `call-process' is applied, and it returns t if the return code is zero."
1607 (with-current-buffer (tramp-get-connection-buffer vec)
1608 (tramp-gvfs-maybe-open-connection vec)
1609 (erase-buffer)
1610 (zerop (apply 'tramp-call-process vec command nil t nil args))))
1611
1612 \f
1613 ;; D-Bus BLUEZ functions.
1614
1615 (defun tramp-bluez-list-devices ()
1616 "Return all discovered bluetooth devices as list.
1617 Every entry is a list (NAME ADDRESS).
1618
1619 If `tramp-bluez-discover-devices-timeout' is an integer, and the last
1620 discovery happened more time before indicated there, a rescan will be
1621 started, which lasts some ten seconds. Otherwise, cached results will
1622 be used."
1623 ;; Reset the scanned devices list if time has passed.
1624 (and (integerp tramp-bluez-discover-devices-timeout)
1625 (integerp tramp-bluez-discovery)
1626 (> (tramp-time-diff (current-time) tramp-bluez-discovery)
1627 tramp-bluez-discover-devices-timeout)
1628 (setq tramp-bluez-devices nil))
1629
1630 ;; Rescan if needed.
1631 (unless tramp-bluez-devices
1632 (let ((object-path
1633 (with-tramp-dbus-call-method tramp-gvfs-dbus-event-vector t
1634 :system tramp-bluez-service "/"
1635 tramp-bluez-interface-manager "DefaultAdapter")))
1636 (setq tramp-bluez-devices nil
1637 tramp-bluez-discovery t)
1638 (with-tramp-dbus-call-method tramp-gvfs-dbus-event-vector nil
1639 :system tramp-bluez-service object-path
1640 tramp-bluez-interface-adapter "StartDiscovery")
1641 (while tramp-bluez-discovery
1642 (read-event nil nil 0.1))))
1643 (setq tramp-bluez-discovery (current-time))
1644 (tramp-message tramp-gvfs-dbus-event-vector 10 "%s" tramp-bluez-devices)
1645 tramp-bluez-devices)
1646
1647 (defun tramp-bluez-property-changed (property value)
1648 "Signal handler for the \"org.bluez.Adapter.PropertyChanged\" signal."
1649 (tramp-message tramp-gvfs-dbus-event-vector 6 "%s %s" property value)
1650 (cond
1651 ((string-equal property "Discovering")
1652 (unless (car value)
1653 ;; "Discovering" FALSE means discovery run has been completed.
1654 ;; We stop it, because we don't need another run.
1655 (setq tramp-bluez-discovery nil)
1656 (with-tramp-dbus-call-method tramp-gvfs-dbus-event-vector t
1657 :system tramp-bluez-service (dbus-event-path-name last-input-event)
1658 tramp-bluez-interface-adapter "StopDiscovery")))))
1659
1660 (when tramp-gvfs-enabled
1661 (dbus-register-signal
1662 :system nil nil tramp-bluez-interface-adapter "PropertyChanged"
1663 'tramp-bluez-property-changed))
1664
1665 (defun tramp-bluez-device-found (device args)
1666 "Signal handler for the \"org.bluez.Adapter.DeviceFound\" signal."
1667 (tramp-message tramp-gvfs-dbus-event-vector 6 "%s %s" device args)
1668 (let ((alias (car (cadr (assoc "Alias" args))))
1669 (address (car (cadr (assoc "Address" args)))))
1670 ;; Maybe we shall check the device class for being a proper
1671 ;; device, and call also SDP in order to find the obex service.
1672 (add-to-list 'tramp-bluez-devices (list alias address))))
1673
1674 (when tramp-gvfs-enabled
1675 (dbus-register-signal
1676 :system nil nil tramp-bluez-interface-adapter "DeviceFound"
1677 'tramp-bluez-device-found))
1678
1679 (defun tramp-bluez-parse-device-names (_ignore)
1680 "Return a list of (nil host) tuples allowed to access."
1681 (mapcar
1682 (lambda (x) (list nil (car x)))
1683 (tramp-bluez-list-devices)))
1684
1685 ;; Add completion function for OBEX method.
1686 (when (and tramp-gvfs-enabled
1687 (member tramp-bluez-service (dbus-list-known-names :system)))
1688 (tramp-set-completion-function
1689 "obex" '((tramp-bluez-parse-device-names ""))))
1690
1691 \f
1692 ;; D-Bus zeroconf functions.
1693
1694 (defun tramp-zeroconf-parse-workstation-device-names (_ignore)
1695 "Return a list of (user host) tuples allowed to access."
1696 (mapcar
1697 (lambda (x)
1698 (list nil (zeroconf-service-host x)))
1699 (zeroconf-list-services "_workstation._tcp")))
1700
1701 (defun tramp-zeroconf-parse-webdav-device-names (_ignore)
1702 "Return a list of (user host) tuples allowed to access."
1703 (mapcar
1704 (lambda (x)
1705 (let ((host (zeroconf-service-host x))
1706 (port (zeroconf-service-port x))
1707 (text (zeroconf-service-txt x))
1708 user)
1709 (when port
1710 (setq host (format "%s%s%d" host tramp-prefix-port-regexp port)))
1711 ;; A user is marked in a TXT field like "u=guest".
1712 (while text
1713 (when (string-match "u=\\(.+\\)$" (car text))
1714 (setq user (match-string 1 (car text))))
1715 (setq text (cdr text)))
1716 (list user host)))
1717 (zeroconf-list-services "_webdav._tcp")))
1718
1719 ;; Add completion function for SFTP, DAV and DAVS methods.
1720 (when (and tramp-gvfs-enabled
1721 (member zeroconf-service-avahi (dbus-list-known-names :system)))
1722 (zeroconf-init tramp-gvfs-zeroconf-domain)
1723 (tramp-set-completion-function
1724 "sftp" '((tramp-zeroconf-parse-workstation-device-names "")))
1725 (tramp-set-completion-function
1726 "dav" '((tramp-zeroconf-parse-webdav-device-names "")))
1727 (tramp-set-completion-function
1728 "davs" '((tramp-zeroconf-parse-webdav-device-names ""))))
1729
1730 \f
1731 ;; D-Bus SYNCE functions.
1732
1733 (defun tramp-synce-list-devices ()
1734 "Return all discovered synce devices as list.
1735 They are retrieved from the hal daemon."
1736 (let (tramp-synce-devices)
1737 (dolist (device
1738 (with-tramp-dbus-call-method tramp-gvfs-dbus-event-vector t
1739 :system tramp-hal-service tramp-hal-path-manager
1740 tramp-hal-interface-manager "GetAllDevices"))
1741 (when (with-tramp-dbus-call-method tramp-gvfs-dbus-event-vector t
1742 :system tramp-hal-service device tramp-hal-interface-device
1743 "PropertyExists" "sync.plugin")
1744 (let ((prop
1745 (with-tramp-dbus-call-method
1746 tramp-gvfs-dbus-event-vector t
1747 :system tramp-hal-service device tramp-hal-interface-device
1748 "GetPropertyString" "pda.pocketpc.name")))
1749 (unless (member prop tramp-synce-devices)
1750 (push prop tramp-synce-devices)))))
1751 (tramp-message tramp-gvfs-dbus-event-vector 10 "%s" tramp-synce-devices)
1752 tramp-synce-devices))
1753
1754 (defun tramp-synce-parse-device-names (_ignore)
1755 "Return a list of (nil host) tuples allowed to access."
1756 (mapcar
1757 (lambda (x) (list nil x))
1758 (tramp-synce-list-devices)))
1759
1760 ;; Add completion function for SYNCE method.
1761 (when tramp-gvfs-enabled
1762 (tramp-set-completion-function
1763 "synce" '((tramp-synce-parse-device-names ""))))
1764
1765 (add-hook 'tramp-unload-hook
1766 (lambda ()
1767 (unload-feature 'tramp-gvfs 'force)))
1768
1769 (provide 'tramp-gvfs)
1770
1771 ;;; TODO:
1772
1773 ;; * Host name completion via smb-server or smb-network.
1774 ;; * Check how two shares of the same SMB server can be mounted in
1775 ;; parallel.
1776 ;; * Apply SDP on bluetooth devices, in order to filter out obex
1777 ;; capability.
1778 ;; * Implement obex for other serial communication but bluetooth.
1779
1780 ;;; tramp-gvfs.el ends here