]> code.delx.au - gnu-emacs/blob - lisp/net/tramp-smb.el
Merge from origin/emacs-25
[gnu-emacs] / lisp / net / tramp-smb.el
1 ;;; tramp-smb.el --- Tramp access functions for SMB servers
2
3 ;; Copyright (C) 2002-2016 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 SMB servers like SAMBA or M$ Windows from Tramp.
27
28 ;;; Code:
29
30 (require 'tramp)
31
32 ;; Pacify byte-compiler.
33 (eval-when-compile
34 (require 'cl))
35
36 ;; Define SMB method ...
37 ;;;###tramp-autoload
38 (defconst tramp-smb-method "smb"
39 "Method to connect SAMBA and M$ SMB servers.")
40
41 ;; ... and add it to the method list.
42 ;;;###tramp-autoload
43 (unless (memq system-type '(cygwin windows-nt))
44 (add-to-list 'tramp-methods
45 `(,tramp-smb-method
46 ;; We define an empty command, because `tramp-smb-call-winexe'
47 ;; opens already the powershell. Used in `tramp-handle-shell-command'.
48 (tramp-remote-shell "")
49 ;; This is just a guess. We don't know whether the share "C$"
50 ;; is available for public use, and whether the user has write
51 ;; access.
52 (tramp-tmpdir "/C$/Temp"))))
53
54 ;; Add a default for `tramp-default-method-alist'. Rule: If there is
55 ;; a domain in USER, it must be the SMB method.
56 ;;;###tramp-autoload
57 (add-to-list 'tramp-default-method-alist
58 `(nil ,tramp-prefix-domain-regexp ,tramp-smb-method))
59
60 ;; Add a default for `tramp-default-user-alist'. Rule: For the SMB method,
61 ;; the anonymous user is chosen.
62 ;;;###tramp-autoload
63 (add-to-list 'tramp-default-user-alist
64 `(,(concat "\\`" tramp-smb-method "\\'") nil nil))
65
66 ;; Add completion function for SMB method.
67 ;;;###tramp-autoload
68 (eval-after-load 'tramp
69 '(tramp-set-completion-function
70 tramp-smb-method
71 '((tramp-parse-netrc "~/.netrc"))))
72
73 ;;;###tramp-autoload
74 (defcustom tramp-smb-program "smbclient"
75 "Name of SMB client to run."
76 :group 'tramp
77 :type 'string)
78
79 ;;;###tramp-autoload
80 (defcustom tramp-smb-acl-program "smbcacls"
81 "Name of SMB acls to run."
82 :group 'tramp
83 :type 'string
84 :version "24.4")
85
86 ;;;###tramp-autoload
87 (defcustom tramp-smb-conf "/dev/null"
88 "Path of the smb.conf file.
89 If it is nil, no smb.conf will be added to the `tramp-smb-program'
90 call, letting the SMB client use the default one."
91 :group 'tramp
92 :type '(choice (const nil) (file :must-match t)))
93
94 (defvar tramp-smb-version nil
95 "Version string of the SMB client.")
96
97 (defconst tramp-smb-server-version
98 "Domain=\\[[^]]*\\] OS=\\[[^]]*\\] Server=\\[[^]]*\\]"
99 "Regexp of SMB server identification.")
100
101 (defconst tramp-smb-prompt "^\\(smb:\\|PS\\) .+> \\|^\\s-+Server\\s-+Comment$"
102 "Regexp used as prompt in smbclient or powershell.")
103
104 (defconst tramp-smb-wrong-passwd-regexp
105 (regexp-opt
106 '("NT_STATUS_LOGON_FAILURE"
107 "NT_STATUS_WRONG_PASSWORD"))
108 "Regexp for login error strings of SMB servers.")
109
110 (defconst tramp-smb-errors
111 (mapconcat
112 'identity
113 `(;; Connection error / timeout / unknown command.
114 "Connection\\( to \\S-+\\)? failed"
115 "Read from server failed, maybe it closed the connection"
116 "Call timed out: server did not respond"
117 "\\S-+: command not found"
118 "Server doesn't support UNIX CIFS calls"
119 ,(regexp-opt
120 '(;; Samba.
121 "ERRDOS"
122 "ERRHRD"
123 "ERRSRV"
124 "ERRbadfile"
125 "ERRbadpw"
126 "ERRfilexists"
127 "ERRnoaccess"
128 "ERRnomem"
129 "ERRnosuchshare"
130 ;; Windows 4.0 (Windows NT), Windows 5.0 (Windows 2000),
131 ;; Windows 5.1 (Windows XP), Windows 5.2 (Windows Server 2003),
132 ;; Windows 6.0 (Windows Vista), Windows 6.1 (Windows 7).
133 "NT_STATUS_ACCESS_DENIED"
134 "NT_STATUS_ACCOUNT_LOCKED_OUT"
135 "NT_STATUS_BAD_NETWORK_NAME"
136 "NT_STATUS_CANNOT_DELETE"
137 "NT_STATUS_CONNECTION_REFUSED"
138 "NT_STATUS_DIRECTORY_NOT_EMPTY"
139 "NT_STATUS_DUPLICATE_NAME"
140 "NT_STATUS_FILE_IS_A_DIRECTORY"
141 "NT_STATUS_HOST_UNREACHABLE"
142 "NT_STATUS_IMAGE_ALREADY_LOADED"
143 "NT_STATUS_INVALID_LEVEL"
144 "NT_STATUS_IO_TIMEOUT"
145 "NT_STATUS_LOGON_FAILURE"
146 "NT_STATUS_NETWORK_ACCESS_DENIED"
147 "NT_STATUS_NOT_IMPLEMENTED"
148 "NT_STATUS_NO_LOGON_SERVERS"
149 "NT_STATUS_NO_SUCH_FILE"
150 "NT_STATUS_NO_SUCH_USER"
151 "NT_STATUS_OBJECT_NAME_COLLISION"
152 "NT_STATUS_OBJECT_NAME_INVALID"
153 "NT_STATUS_OBJECT_NAME_NOT_FOUND"
154 "NT_STATUS_SHARING_VIOLATION"
155 "NT_STATUS_TRUSTED_RELATIONSHIP_FAILURE"
156 "NT_STATUS_UNSUCCESSFUL"
157 "NT_STATUS_WRONG_PASSWORD")))
158 "\\|")
159 "Regexp for possible error strings of SMB servers.
160 Used instead of analyzing error codes of commands.")
161
162 (defconst tramp-smb-actions-with-share
163 '((tramp-smb-prompt tramp-action-succeed)
164 (tramp-password-prompt-regexp tramp-action-password)
165 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
166 (tramp-smb-errors tramp-action-permission-denied)
167 (tramp-process-alive-regexp tramp-action-process-alive))
168 "List of pattern/action pairs.
169 This list is used for login to SMB servers.
170
171 See `tramp-actions-before-shell' for more info.")
172
173 (defconst tramp-smb-actions-without-share
174 '((tramp-password-prompt-regexp tramp-action-password)
175 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
176 (tramp-smb-errors tramp-action-permission-denied)
177 (tramp-process-alive-regexp tramp-action-out-of-band))
178 "List of pattern/action pairs.
179 This list is used for login to SMB servers.
180
181 See `tramp-actions-before-shell' for more info.")
182
183 (defconst tramp-smb-actions-with-tar
184 '((tramp-password-prompt-regexp tramp-action-password)
185 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
186 (tramp-smb-errors tramp-action-permission-denied)
187 (tramp-process-alive-regexp tramp-smb-action-with-tar))
188 "List of pattern/action pairs.
189 This list is used for tar-like copy of directories.
190
191 See `tramp-actions-before-shell' for more info.")
192
193 (defconst tramp-smb-actions-get-acl
194 '((tramp-password-prompt-regexp tramp-action-password)
195 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
196 (tramp-smb-errors tramp-action-permission-denied)
197 (tramp-process-alive-regexp tramp-smb-action-get-acl))
198 "List of pattern/action pairs.
199 This list is used for smbcacls actions.
200
201 See `tramp-actions-before-shell' for more info.")
202
203 (defconst tramp-smb-actions-set-acl
204 '((tramp-password-prompt-regexp tramp-action-password)
205 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
206 (tramp-smb-errors tramp-action-permission-denied)
207 (tramp-process-alive-regexp tramp-smb-action-set-acl))
208 "List of pattern/action pairs.
209 This list is used for smbcacls actions.
210
211 See `tramp-actions-before-shell' for more info.")
212
213 ;; New handlers should be added here.
214 (defconst tramp-smb-file-name-handler-alist
215 '(;; `access-file' performed by default handler.
216 (add-name-to-file . tramp-smb-handle-add-name-to-file)
217 ;; `byte-compiler-base-file-name' performed by default handler.
218 (copy-directory . tramp-smb-handle-copy-directory)
219 (copy-file . tramp-smb-handle-copy-file)
220 (delete-directory . tramp-smb-handle-delete-directory)
221 (delete-file . tramp-smb-handle-delete-file)
222 ;; `diff-latest-backup-file' performed by default handler.
223 (directory-file-name . tramp-handle-directory-file-name)
224 (directory-files . tramp-smb-handle-directory-files)
225 (directory-files-and-attributes
226 . tramp-handle-directory-files-and-attributes)
227 (dired-compress-file . ignore)
228 (dired-uncache . tramp-handle-dired-uncache)
229 (expand-file-name . tramp-smb-handle-expand-file-name)
230 (file-accessible-directory-p . tramp-smb-handle-file-directory-p)
231 (file-acl . tramp-smb-handle-file-acl)
232 (file-attributes . tramp-smb-handle-file-attributes)
233 (file-directory-p . tramp-smb-handle-file-directory-p)
234 (file-file-equal-p . tramp-handle-file-equal-p)
235 (file-executable-p . tramp-handle-file-exists-p)
236 (file-exists-p . tramp-handle-file-exists-p)
237 (file-in-directory-p . tramp-handle-file-in-directory-p)
238 (file-local-copy . tramp-smb-handle-file-local-copy)
239 (file-modes . tramp-handle-file-modes)
240 (file-name-all-completions . tramp-smb-handle-file-name-all-completions)
241 (file-name-as-directory . tramp-handle-file-name-as-directory)
242 (file-name-completion . tramp-handle-file-name-completion)
243 (file-name-directory . tramp-handle-file-name-directory)
244 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
245 ;; `file-name-sans-versions' performed by default handler.
246 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
247 (file-notify-add-watch . tramp-handle-file-notify-add-watch)
248 (file-notify-rm-watch . tramp-handle-file-notify-rm-watch)
249 (file-notify-valid-p . tramp-handle-file-notify-valid-p)
250 (file-ownership-preserved-p . ignore)
251 (file-readable-p . tramp-handle-file-exists-p)
252 (file-regular-p . tramp-handle-file-regular-p)
253 (file-remote-p . tramp-handle-file-remote-p)
254 ;; `file-selinux-context' performed by default handler.
255 (file-symlink-p . tramp-handle-file-symlink-p)
256 ;; `file-truename' performed by default handler.
257 (file-writable-p . tramp-smb-handle-file-writable-p)
258 (find-backup-file-name . tramp-handle-find-backup-file-name)
259 ;; `find-file-noselect' performed by default handler.
260 ;; `get-file-buffer' performed by default handler.
261 (insert-directory . tramp-smb-handle-insert-directory)
262 (insert-file-contents . tramp-handle-insert-file-contents)
263 (load . tramp-handle-load)
264 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
265 (make-directory . tramp-smb-handle-make-directory)
266 (make-directory-internal . tramp-smb-handle-make-directory-internal)
267 (make-symbolic-link . tramp-smb-handle-make-symbolic-link)
268 (process-file . tramp-smb-handle-process-file)
269 (rename-file . tramp-smb-handle-rename-file)
270 (set-file-acl . tramp-smb-handle-set-file-acl)
271 (set-file-modes . tramp-smb-handle-set-file-modes)
272 (set-file-selinux-context . ignore)
273 (set-file-times . ignore)
274 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
275 (shell-command . tramp-handle-shell-command)
276 (start-file-process . tramp-smb-handle-start-file-process)
277 (substitute-in-file-name . tramp-smb-handle-substitute-in-file-name)
278 (unhandled-file-name-directory . ignore)
279 (vc-registered . ignore)
280 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime)
281 (write-region . tramp-smb-handle-write-region))
282 "Alist of handler functions for Tramp SMB method.
283 Operations not mentioned here will be handled by the default Emacs primitives.")
284
285 ;; Options for remote processes via winexe.
286 ;;;###tramp-autoload
287 (defcustom tramp-smb-winexe-program "winexe"
288 "Name of winexe client to run.
289 If it isn't found in the local $PATH, the absolute path of winexe
290 shall be given. This is needed for remote processes."
291 :group 'tramp
292 :type 'string
293 :version "24.3")
294
295 ;;;###tramp-autoload
296 (defcustom tramp-smb-winexe-shell-command "powershell.exe"
297 "Shell to be used for processes on remote machines.
298 This must be Powershell V2 compatible."
299 :group 'tramp
300 :type 'string
301 :version "24.3")
302
303 ;;;###tramp-autoload
304 (defcustom tramp-smb-winexe-shell-command-switch "-file -"
305 "Command switch used together with `tramp-smb-winexe-shell-command'.
306 This can be used to disable echo etc."
307 :group 'tramp
308 :type 'string
309 :version "24.3")
310
311 ;; It must be a `defsubst' in order to push the whole code into
312 ;; tramp-loaddefs.el. Otherwise, there would be recursive autoloading.
313 ;;;###tramp-autoload
314 (defsubst tramp-smb-file-name-p (filename)
315 "Check if it's a filename for SMB servers."
316 (string= (tramp-file-name-method (tramp-dissect-file-name filename))
317 tramp-smb-method))
318
319 ;;;###tramp-autoload
320 (defun tramp-smb-file-name-handler (operation &rest args)
321 "Invoke the SMB related OPERATION.
322 First arg specifies the OPERATION, second arg is a list of arguments to
323 pass to the OPERATION."
324 (let ((fn (assoc operation tramp-smb-file-name-handler-alist)))
325 (if fn
326 (save-match-data (apply (cdr fn) args))
327 (tramp-run-real-handler operation args))))
328
329 ;;;###tramp-autoload
330 (unless (memq system-type '(cygwin windows-nt))
331 (add-to-list 'tramp-foreign-file-name-handler-alist
332 (cons 'tramp-smb-file-name-p 'tramp-smb-file-name-handler)))
333
334
335 ;; File name primitives.
336
337 (defun tramp-smb-handle-add-name-to-file
338 (filename newname &optional ok-if-already-exists)
339 "Like `add-name-to-file' for Tramp files."
340 (unless (tramp-equal-remote filename newname)
341 (with-parsed-tramp-file-name
342 (if (tramp-tramp-file-p filename) filename newname) nil
343 (tramp-error
344 v 'file-error
345 "add-name-to-file: %s"
346 "only implemented for same method, same user, same host")))
347 (with-parsed-tramp-file-name filename v1
348 (with-parsed-tramp-file-name newname v2
349 (when (file-directory-p filename)
350 (tramp-error
351 v2 'file-error
352 "add-name-to-file: %s must not be a directory" filename))
353 (when (and (not ok-if-already-exists)
354 (file-exists-p newname)
355 (not (numberp ok-if-already-exists))
356 (y-or-n-p
357 (format
358 "File %s already exists; make it a new name anyway? "
359 newname)))
360 (tramp-error
361 v2 'file-error
362 "add-name-to-file: file %s already exists" newname))
363 ;; We must also flush the cache of the directory, because
364 ;; `file-attributes' reads the values from there.
365 (tramp-flush-file-property v2 (file-name-directory v2-localname))
366 (tramp-flush-file-property v2 v2-localname)
367 (unless
368 (tramp-smb-send-command
369 v1
370 (format
371 "%s \"%s\" \"%s\""
372 (if (tramp-smb-get-cifs-capabilities v1) "link" "hardlink")
373 (tramp-smb-get-localname v1)
374 (tramp-smb-get-localname v2)))
375 (tramp-error
376 v2 'file-error
377 "error with add-name-to-file, see buffer `%s' for details"
378 (buffer-name))))))
379
380 (defun tramp-smb-action-with-tar (proc vec)
381 "Untar from connection buffer."
382 (if (not (memq (process-status proc) '(run open)))
383 (throw 'tramp-action 'process-died)
384
385 (with-current-buffer (tramp-get-connection-buffer vec)
386 (goto-char (point-min))
387 (when (search-forward-regexp tramp-smb-server-version nil t)
388 ;; There might be a hidden password prompt.
389 (widen)
390 (forward-line)
391 (tramp-message vec 6 (buffer-substring (point-min) (point)))
392 (delete-region (point-min) (point))
393 (throw 'tramp-action 'ok)))))
394
395 (defun tramp-smb-handle-copy-directory
396 (dirname newname &optional keep-date parents copy-contents)
397 "Like `copy-directory' for Tramp files."
398 (if copy-contents
399 ;; We must do it file-wise.
400 (tramp-run-real-handler
401 'copy-directory (list dirname newname keep-date parents copy-contents))
402
403 (setq dirname (expand-file-name dirname)
404 newname (expand-file-name newname))
405 (let ((t1 (tramp-tramp-file-p dirname))
406 (t2 (tramp-tramp-file-p newname)))
407 (with-parsed-tramp-file-name (if t1 dirname newname) nil
408 (with-tramp-progress-reporter
409 v 0 (format "Copying %s to %s" dirname newname)
410 (cond
411 ;; We must use a local temporary directory.
412 ((and t1 t2)
413 (let ((tmpdir
414 (make-temp-name
415 (expand-file-name
416 tramp-temp-name-prefix
417 (tramp-compat-temporary-file-directory)))))
418 (unwind-protect
419 (progn
420 (make-directory tmpdir)
421 (copy-directory dirname tmpdir keep-date 'parents)
422 (copy-directory
423 (expand-file-name (file-name-nondirectory dirname) tmpdir)
424 newname keep-date parents))
425 (delete-directory tmpdir 'recursive))))
426
427 ;; We can copy recursively.
428 ((or t1 t2)
429 (when (and (file-directory-p newname)
430 (not (string-equal (file-name-nondirectory dirname)
431 (file-name-nondirectory newname))))
432 (setq newname
433 (expand-file-name
434 (file-name-nondirectory dirname) newname))
435 (if t2 (setq v (tramp-dissect-file-name newname))))
436 (if (not (file-directory-p newname))
437 (make-directory newname parents))
438
439 (setq tramp-current-method (tramp-file-name-method v)
440 tramp-current-user (tramp-file-name-user v)
441 tramp-current-host (tramp-file-name-real-host v))
442
443 (let* ((real-user (tramp-file-name-real-user v))
444 (real-host (tramp-file-name-real-host v))
445 (domain (tramp-file-name-domain v))
446 (port (tramp-file-name-port v))
447 (share (tramp-smb-get-share v))
448 (localname (file-name-as-directory
449 (replace-regexp-in-string
450 "\\\\" "/" (tramp-smb-get-localname v))))
451 (tmpdir (make-temp-name
452 (expand-file-name
453 tramp-temp-name-prefix
454 (tramp-compat-temporary-file-directory))))
455 (args (list (concat "//" real-host "/" share) "-E")))
456
457 (if (not (zerop (length real-user)))
458 (setq args (append args (list "-U" real-user)))
459 (setq args (append args (list "-N"))))
460
461 (when domain (setq args (append args (list "-W" domain))))
462 (when port (setq args (append args (list "-p" port))))
463 (when tramp-smb-conf
464 (setq args (append args (list "-s" tramp-smb-conf))))
465 (setq args
466 (if t1
467 ;; Source is remote.
468 (append args
469 (list "-D" (shell-quote-argument localname)
470 "-c" (shell-quote-argument "tar qc - *")
471 "|" "tar" "xfC" "-"
472 (shell-quote-argument tmpdir)))
473 ;; Target is remote.
474 (append (list "tar" "cfC" "-"
475 (shell-quote-argument dirname) "." "|")
476 args
477 (list "-D" (shell-quote-argument localname)
478 "-c" (shell-quote-argument "tar qx -")))))
479
480 (unwind-protect
481 (with-temp-buffer
482 ;; Set the transfer process properties.
483 (tramp-set-connection-property
484 v "process-name" (buffer-name (current-buffer)))
485 (tramp-set-connection-property
486 v "process-buffer" (current-buffer))
487
488 (when t1
489 ;; The smbclient tar command creates always
490 ;; complete paths. We must emulate the
491 ;; directory structure, and symlink to the real
492 ;; target.
493 (make-directory
494 (expand-file-name
495 ".." (concat tmpdir localname)) 'parents)
496 (make-symbolic-link
497 newname (directory-file-name (concat tmpdir localname))))
498
499 ;; Use an asynchronous processes. By this,
500 ;; password can be handled.
501 (let* ((default-directory tmpdir)
502 (p (apply
503 'start-process
504 (tramp-get-connection-name v)
505 (tramp-get-connection-buffer v)
506 tramp-smb-program args)))
507
508 (tramp-message
509 v 6 "%s" (mapconcat 'identity (process-command p) " "))
510 (tramp-set-connection-property p "vector" v)
511 (set-process-query-on-exit-flag p nil)
512 (tramp-process-actions p v nil tramp-smb-actions-with-tar)
513
514 (while (memq (process-status p) '(run open))
515 (sit-for 0.1))
516 (tramp-message v 6 "\n%s" (buffer-string))))
517
518 ;; Reset the transfer process properties.
519 (tramp-set-connection-property v "process-name" nil)
520 (tramp-set-connection-property v "process-buffer" nil)
521 (when t1 (delete-directory tmpdir 'recurse))))
522
523 ;; Handle KEEP-DATE argument.
524 (when keep-date
525 (set-file-times newname (nth 5 (file-attributes dirname))))
526
527 ;; Set the mode.
528 (unless keep-date
529 (set-file-modes newname (tramp-default-file-modes dirname)))
530
531 ;; When newname did exist, we have wrong cached values.
532 (when t2
533 (with-parsed-tramp-file-name newname nil
534 (tramp-flush-file-property v (file-name-directory localname))
535 (tramp-flush-file-property v localname))))
536
537 ;; We must do it file-wise.
538 (t
539 (tramp-run-real-handler
540 'copy-directory (list dirname newname keep-date parents)))))))))
541
542 (defun tramp-smb-handle-copy-file
543 (filename newname &optional ok-if-already-exists keep-date
544 _preserve-uid-gid _preserve-extended-attributes)
545 "Like `copy-file' for Tramp files.
546 KEEP-DATE has no effect in case NEWNAME resides on an SMB server.
547 PRESERVE-UID-GID and PRESERVE-EXTENDED-ATTRIBUTES are completely ignored."
548 (setq filename (expand-file-name filename)
549 newname (expand-file-name newname))
550 (with-tramp-progress-reporter
551 (tramp-dissect-file-name
552 (if (tramp-tramp-file-p filename) filename newname))
553 0 (format "Copying %s to %s" filename newname)
554
555 (if (file-directory-p filename)
556 (tramp-compat-copy-directory
557 filename newname keep-date 'parents 'copy-contents)
558
559 (let ((tmpfile (file-local-copy filename)))
560 (if tmpfile
561 ;; Remote filename.
562 (condition-case err
563 (rename-file tmpfile newname ok-if-already-exists)
564 ((error quit)
565 (delete-file tmpfile)
566 (signal (car err) (cdr err))))
567
568 ;; Remote newname.
569 (when (file-directory-p newname)
570 (setq newname
571 (expand-file-name (file-name-nondirectory filename) newname)))
572
573 (with-parsed-tramp-file-name newname nil
574 (when (and (not ok-if-already-exists)
575 (file-exists-p newname))
576 (tramp-error v 'file-already-exists newname))
577
578 ;; We must also flush the cache of the directory, because
579 ;; `file-attributes' reads the values from there.
580 (tramp-flush-file-property v (file-name-directory localname))
581 (tramp-flush-file-property v localname)
582 (unless (tramp-smb-get-share v)
583 (tramp-error
584 v 'file-error "Target `%s' must contain a share name" newname))
585 (unless (tramp-smb-send-command
586 v (format "put \"%s\" \"%s\""
587 filename (tramp-smb-get-localname v)))
588 (tramp-error
589 v 'file-error "Cannot copy `%s' to `%s'" filename newname))))))
590
591 ;; KEEP-DATE handling.
592 (when keep-date
593 (set-file-times newname (nth 5 (file-attributes filename))))))
594
595 (defun tramp-smb-handle-delete-directory (directory &optional recursive)
596 "Like `delete-directory' for Tramp files."
597 (setq directory (directory-file-name (expand-file-name directory)))
598 (when (file-exists-p directory)
599 (if recursive
600 (mapc
601 (lambda (file)
602 (if (file-directory-p file)
603 (delete-directory file recursive)
604 (delete-file file)))
605 ;; We do not want to delete "." and "..".
606 (directory-files
607 directory 'full "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")))
608
609 (with-parsed-tramp-file-name directory nil
610 ;; We must also flush the cache of the directory, because
611 ;; `file-attributes' reads the values from there.
612 (tramp-flush-file-property v (file-name-directory localname))
613 (tramp-flush-directory-property v localname)
614 (unless (tramp-smb-send-command
615 v (format
616 "%s \"%s\""
617 (if (tramp-smb-get-cifs-capabilities v) "posix_rmdir" "rmdir")
618 (tramp-smb-get-localname v)))
619 ;; Error.
620 (with-current-buffer (tramp-get-connection-buffer v)
621 (goto-char (point-min))
622 (search-forward-regexp tramp-smb-errors nil t)
623 (tramp-error
624 v 'file-error "%s `%s'" (match-string 0) directory))))))
625
626 (defun tramp-smb-handle-delete-file (filename &optional _trash)
627 "Like `delete-file' for Tramp files."
628 (setq filename (expand-file-name filename))
629 (when (file-exists-p filename)
630 (with-parsed-tramp-file-name filename nil
631 ;; We must also flush the cache of the directory, because
632 ;; `file-attributes' reads the values from there.
633 (tramp-flush-file-property v (file-name-directory localname))
634 (tramp-flush-file-property v localname)
635 (unless (tramp-smb-send-command
636 v (format
637 "%s \"%s\""
638 (if (tramp-smb-get-cifs-capabilities v) "posix_unlink" "rm")
639 (tramp-smb-get-localname v)))
640 ;; Error.
641 (with-current-buffer (tramp-get-connection-buffer v)
642 (goto-char (point-min))
643 (search-forward-regexp tramp-smb-errors nil t)
644 (tramp-error
645 v 'file-error "%s `%s'" (match-string 0) filename))))))
646
647 (defun tramp-smb-handle-directory-files
648 (directory &optional full match nosort)
649 "Like `directory-files' for Tramp files."
650 (let ((result (mapcar 'directory-file-name
651 (file-name-all-completions "" directory))))
652 ;; Discriminate with regexp.
653 (when match
654 (setq result
655 (delete nil
656 (mapcar (lambda (x) (when (string-match match x) x))
657 result))))
658 ;; Append directory.
659 (when full
660 (setq result
661 (mapcar
662 (lambda (x) (format "%s/%s" directory x))
663 result)))
664 ;; Sort them if necessary.
665 (unless nosort (setq result (sort result 'string-lessp)))
666 ;; Remove double entries.
667 (delete-dups result)))
668
669 (defun tramp-smb-handle-expand-file-name (name &optional dir)
670 "Like `expand-file-name' for Tramp files."
671 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
672 (setq dir (or dir default-directory "/"))
673 ;; Unless NAME is absolute, concat DIR and NAME.
674 (unless (file-name-absolute-p name)
675 (setq name (concat (file-name-as-directory dir) name)))
676 ;; If NAME is not a Tramp file, run the real handler.
677 (if (not (tramp-tramp-file-p name))
678 (tramp-run-real-handler 'expand-file-name (list name nil))
679 ;; Dissect NAME.
680 (with-parsed-tramp-file-name name nil
681 ;; Tilde expansion if necessary. We use the user name as share,
682 ;; which is often the case in domains.
683 (when (string-match "\\`/?~\\([^/]*\\)" localname)
684 (setq localname
685 (replace-match
686 (if (zerop (length (match-string 1 localname)))
687 (tramp-file-name-real-user v)
688 (match-string 1 localname))
689 nil nil localname)))
690 ;; Make the file name absolute.
691 (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
692 (setq localname (concat "/" localname)))
693 ;; No tilde characters in file name, do normal
694 ;; `expand-file-name' (this does "/./" and "/../").
695 (tramp-make-tramp-file-name
696 method user host
697 (tramp-run-real-handler 'expand-file-name (list localname))))))
698
699 (defun tramp-smb-action-get-acl (proc vec)
700 "Read ACL data from connection buffer."
701 (when (not (memq (process-status proc) '(run open)))
702 ;; Accept pending output.
703 (while (tramp-accept-process-output proc 0.1))
704 (with-current-buffer (tramp-get-connection-buffer vec)
705 ;; There might be a hidden password prompt.
706 (widen)
707 (tramp-message vec 10 "\n%s" (buffer-string))
708 (goto-char (point-min))
709 (while (and (not (eobp)) (not (looking-at "^REVISION:")))
710 (forward-line)
711 (delete-region (point-min) (point)))
712 (while (and (not (eobp)) (looking-at "^.+:.+"))
713 (forward-line))
714 (delete-region (point) (point-max))
715 (throw 'tramp-action 'ok))))
716
717 (defun tramp-smb-handle-file-acl (filename)
718 "Like `file-acl' for Tramp files."
719 (with-parsed-tramp-file-name filename nil
720 (with-tramp-file-property v localname "file-acl"
721 (when (executable-find tramp-smb-acl-program)
722
723 (setq tramp-current-method (tramp-file-name-method v)
724 tramp-current-user (tramp-file-name-user v)
725 tramp-current-host (tramp-file-name-real-host v))
726
727 (let* ((real-user (tramp-file-name-real-user v))
728 (real-host (tramp-file-name-real-host v))
729 (domain (tramp-file-name-domain v))
730 (port (tramp-file-name-port v))
731 (share (tramp-smb-get-share v))
732 (localname (replace-regexp-in-string
733 "\\\\" "/" (tramp-smb-get-localname v)))
734 (args (list (concat "//" real-host "/" share) "-E")))
735
736 (if (not (zerop (length real-user)))
737 (setq args (append args (list "-U" real-user)))
738 (setq args (append args (list "-N"))))
739
740 (when domain (setq args (append args (list "-W" domain))))
741 (when port (setq args (append args (list "-p" port))))
742 (when tramp-smb-conf
743 (setq args (append args (list "-s" tramp-smb-conf))))
744 (setq
745 args
746 (append args (list (shell-quote-argument localname) "2>/dev/null")))
747
748 (unwind-protect
749 (with-temp-buffer
750 ;; Set the transfer process properties.
751 (tramp-set-connection-property
752 v "process-name" (buffer-name (current-buffer)))
753 (tramp-set-connection-property
754 v "process-buffer" (current-buffer))
755
756 ;; Use an asynchronous processes. By this, password
757 ;; can be handled.
758 (let ((p (apply
759 'start-process
760 (tramp-get-connection-name v)
761 (tramp-get-connection-buffer v)
762 tramp-smb-acl-program args)))
763
764 (tramp-message
765 v 6 "%s" (mapconcat 'identity (process-command p) " "))
766 (tramp-set-connection-property p "vector" v)
767 (set-process-query-on-exit-flag p nil)
768 (tramp-process-actions p v nil tramp-smb-actions-get-acl)
769 (when (> (point-max) (point-min))
770 (substring-no-properties (buffer-string)))))
771
772 ;; Reset the transfer process properties.
773 (tramp-set-connection-property v "process-name" nil)
774 (tramp-set-connection-property v "process-buffer" nil)))))))
775
776 (defun tramp-smb-handle-file-attributes (filename &optional id-format)
777 "Like `file-attributes' for Tramp files."
778 (unless id-format (setq id-format 'integer))
779 (ignore-errors
780 (with-parsed-tramp-file-name filename nil
781 (with-tramp-file-property
782 v localname (format "file-attributes-%s" id-format)
783 (if (tramp-smb-get-stat-capability v)
784 (tramp-smb-do-file-attributes-with-stat v id-format)
785 ;; Reading just the filename entry via "dir localname" is not
786 ;; possible, because when filename is a directory, some
787 ;; smbclient versions return the content of the directory, and
788 ;; other versions don't. Therefore, the whole content of the
789 ;; upper directory is retrieved, and the entry of the filename
790 ;; is extracted from.
791 (let* ((entries (tramp-smb-get-file-entries
792 (file-name-directory filename)))
793 (entry (assoc (file-name-nondirectory filename) entries))
794 (uid (if (equal id-format 'string) "nobody" -1))
795 (gid (if (equal id-format 'string) "nogroup" -1))
796 (inode (tramp-get-inode v))
797 (device (tramp-get-device v)))
798
799 ;; Check result.
800 (when entry
801 (list (and (string-match "d" (nth 1 entry))
802 t) ;0 file type
803 -1 ;1 link count
804 uid ;2 uid
805 gid ;3 gid
806 '(0 0) ;4 atime
807 (nth 3 entry) ;5 mtime
808 '(0 0) ;6 ctime
809 (nth 2 entry) ;7 size
810 (nth 1 entry) ;8 mode
811 nil ;9 gid weird
812 inode ;10 inode number
813 device)))))))) ;11 file system number
814
815 (defun tramp-smb-do-file-attributes-with-stat (vec &optional id-format)
816 "Implement `file-attributes' for Tramp files using stat command."
817 (tramp-message
818 vec 5 "file attributes with stat: %s" (tramp-file-name-localname vec))
819 (with-current-buffer (tramp-get-connection-buffer vec)
820 (let* (size id link uid gid atime mtime ctime mode inode)
821 (when (tramp-smb-send-command
822 vec (format "stat \"%s\"" (tramp-smb-get-localname vec)))
823
824 ;; Loop the listing.
825 (goto-char (point-min))
826 (unless (re-search-forward tramp-smb-errors nil t)
827 (while (not (eobp))
828 (cond
829 ((looking-at
830 "Size:\\s-+\\([0-9]+\\)\\s-+Blocks:\\s-+[0-9]+\\s-+\\(\\w+\\)")
831 (setq size (string-to-number (match-string 1))
832 id (if (string-equal "directory" (match-string 2)) t
833 (if (string-equal "symbolic" (match-string 2)) ""))))
834 ((looking-at
835 "Inode:\\s-+\\([0-9]+\\)\\s-+Links:\\s-+\\([0-9]+\\)")
836 (setq inode (string-to-number (match-string 1))
837 link (string-to-number (match-string 2))))
838 ((looking-at
839 "Access:\\s-+([0-9]+/\\(\\S-+\\))\\s-+Uid:\\s-+\\([0-9]+\\)\\s-+Gid:\\s-+\\([0-9]+\\)")
840 (setq mode (match-string 1)
841 uid (if (equal id-format 'string) (match-string 2)
842 (string-to-number (match-string 2)))
843 gid (if (equal id-format 'string) (match-string 3)
844 (string-to-number (match-string 3)))))
845 ((looking-at
846 "Access:\\s-+\\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\)\\s-+\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)")
847 (setq atime
848 (encode-time
849 (string-to-number (match-string 6)) ;; sec
850 (string-to-number (match-string 5)) ;; min
851 (string-to-number (match-string 4)) ;; hour
852 (string-to-number (match-string 3)) ;; day
853 (string-to-number (match-string 2)) ;; month
854 (string-to-number (match-string 1))))) ;; year
855 ((looking-at
856 "Modify:\\s-+\\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\)\\s-+\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)")
857 (setq mtime
858 (encode-time
859 (string-to-number (match-string 6)) ;; sec
860 (string-to-number (match-string 5)) ;; min
861 (string-to-number (match-string 4)) ;; hour
862 (string-to-number (match-string 3)) ;; day
863 (string-to-number (match-string 2)) ;; month
864 (string-to-number (match-string 1))))) ;; year
865 ((looking-at
866 "Change:\\s-+\\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\)\\s-+\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)")
867 (setq ctime
868 (encode-time
869 (string-to-number (match-string 6)) ;; sec
870 (string-to-number (match-string 5)) ;; min
871 (string-to-number (match-string 4)) ;; hour
872 (string-to-number (match-string 3)) ;; day
873 (string-to-number (match-string 2)) ;; month
874 (string-to-number (match-string 1)))))) ;; year
875 (forward-line))
876 ;; Return the result.
877 (list id link uid gid atime mtime ctime size mode nil inode
878 (tramp-get-device vec)))))))
879
880 (defun tramp-smb-handle-file-directory-p (filename)
881 "Like `file-directory-p' for Tramp files."
882 (and (file-exists-p filename)
883 (eq ?d (aref (nth 8 (file-attributes filename)) 0))))
884
885 (defun tramp-smb-handle-file-local-copy (filename)
886 "Like `file-local-copy' for Tramp files."
887 (with-parsed-tramp-file-name filename nil
888 (unless (file-exists-p filename)
889 (tramp-error
890 v 'file-error
891 "Cannot make local copy of non-existing file `%s'" filename))
892 (let ((tmpfile (tramp-compat-make-temp-file filename)))
893 (with-tramp-progress-reporter
894 v 3 (format "Fetching %s to tmp file %s" filename tmpfile)
895 (unless (tramp-smb-send-command
896 v (format "get \"%s\" \"%s\""
897 (tramp-smb-get-localname v) tmpfile))
898 ;; Oops, an error. We shall cleanup.
899 (delete-file tmpfile)
900 (tramp-error
901 v 'file-error "Cannot make local copy of file `%s'" filename)))
902 tmpfile)))
903
904 ;; This function should return "foo/" for directories and "bar" for
905 ;; files.
906 (defun tramp-smb-handle-file-name-all-completions (filename directory)
907 "Like `file-name-all-completions' for Tramp files."
908 (all-completions
909 filename
910 (with-parsed-tramp-file-name directory nil
911 (with-tramp-file-property v localname "file-name-all-completions"
912 (save-match-data
913 (let ((entries (tramp-smb-get-file-entries directory)))
914 (mapcar
915 (lambda (x)
916 (list
917 (if (string-match "d" (nth 1 x))
918 (file-name-as-directory (nth 0 x))
919 (nth 0 x))))
920 entries)))))))
921
922 (defun tramp-smb-handle-file-writable-p (filename)
923 "Like `file-writable-p' for Tramp files."
924 (if (file-exists-p filename)
925 (string-match "w" (or (nth 8 (file-attributes filename)) ""))
926 (let ((dir (file-name-directory filename)))
927 (and (file-exists-p dir)
928 (file-writable-p dir)))))
929
930 (defun tramp-smb-handle-insert-directory
931 (filename switches &optional wildcard full-directory-p)
932 "Like `insert-directory' for Tramp files."
933 (setq filename (expand-file-name filename))
934 (unless switches (setq switches ""))
935 ;; Mark trailing "/".
936 (when (and (zerop (length (file-name-nondirectory filename)))
937 (not full-directory-p))
938 (setq switches (concat switches "F")))
939 (if full-directory-p
940 ;; Called from `dired-add-entry'.
941 (setq filename (file-name-as-directory filename))
942 (setq filename (directory-file-name filename)))
943 (with-parsed-tramp-file-name filename nil
944 (with-tramp-progress-reporter v 0 (format "Opening directory %s" filename)
945 (save-match-data
946 (let ((base (file-name-nondirectory filename))
947 ;; We should not destroy the cache entry.
948 (entries (copy-sequence
949 (tramp-smb-get-file-entries
950 (file-name-directory filename)))))
951
952 (when wildcard
953 (string-match "\\." base)
954 (setq base (replace-match "\\\\." nil nil base))
955 (string-match "\\*" base)
956 (setq base (replace-match ".*" nil nil base))
957 (string-match "\\?" base)
958 (setq base (replace-match ".?" nil nil base)))
959
960 ;; Filter entries.
961 (setq entries
962 (delq
963 nil
964 (if (or wildcard (zerop (length base)))
965 ;; Check for matching entries.
966 (mapcar
967 (lambda (x)
968 (when (string-match
969 (format "^%s" base) (nth 0 x))
970 x))
971 entries)
972 ;; We just need the only and only entry FILENAME.
973 (list (assoc base entries)))))
974
975 ;; Sort entries.
976 (setq entries
977 (sort
978 entries
979 (lambda (x y)
980 (if (string-match "t" switches)
981 ;; Sort by date.
982 (time-less-p (nth 3 y) (nth 3 x))
983 ;; Sort by name.
984 (string-lessp (nth 0 x) (nth 0 y))))))
985
986 ;; Handle "-F" switch.
987 (when (string-match "F" switches)
988 (mapc
989 (lambda (x)
990 (when (not (zerop (length (car x))))
991 (cond
992 ((char-equal ?d (string-to-char (nth 1 x)))
993 (setcar x (concat (car x) "/")))
994 ((char-equal ?x (string-to-char (nth 1 x)))
995 (setcar x (concat (car x) "*"))))))
996 entries))
997
998 ;; Print entries.
999 (mapc
1000 (lambda (x)
1001 (when (not (zerop (length (nth 0 x))))
1002 (when (string-match "l" switches)
1003 (let ((attr
1004 (when (tramp-smb-get-stat-capability v)
1005 (ignore-errors
1006 (file-attributes filename 'string)))))
1007 (insert
1008 (format
1009 "%10s %3d %-8s %-8s %8s %s "
1010 (or (nth 8 attr) (nth 1 x)) ; mode
1011 (or (nth 1 attr) 1) ; inode
1012 (or (nth 2 attr) "nobody") ; uid
1013 (or (nth 3 attr) "nogroup") ; gid
1014 (or (nth 7 attr) (nth 2 x)) ; size
1015 (format-time-string
1016 (if (time-less-p (time-subtract (current-time) (nth 3 x))
1017 tramp-half-a-year)
1018 "%b %e %R"
1019 "%b %e %Y")
1020 (nth 3 x)))))) ; date
1021
1022 ;; We mark the file name. The inserted name could be
1023 ;; from somewhere else, so we use the relative file name
1024 ;; of `default-directory'.
1025 (let ((start (point)))
1026 (insert
1027 (format
1028 "%s\n"
1029 (file-relative-name
1030 (expand-file-name
1031 (nth 0 x) (file-name-directory filename))
1032 (when full-directory-p (file-name-directory filename)))))
1033 (put-text-property start (1- (point)) 'dired-filename t))
1034 (forward-line)
1035 (beginning-of-line)))
1036 entries))))))
1037
1038 (defun tramp-smb-handle-make-directory (dir &optional parents)
1039 "Like `make-directory' for Tramp files."
1040 (setq dir (directory-file-name (expand-file-name dir)))
1041 (unless (file-name-absolute-p dir)
1042 (setq dir (expand-file-name dir default-directory)))
1043 (with-parsed-tramp-file-name dir nil
1044 (save-match-data
1045 (let* ((ldir (file-name-directory dir)))
1046 ;; Make missing directory parts.
1047 (when (and parents
1048 (tramp-smb-get-share v)
1049 (not (file-directory-p ldir)))
1050 (make-directory ldir parents))
1051 ;; Just do it.
1052 (when (file-directory-p ldir)
1053 (make-directory-internal dir))
1054 (unless (file-directory-p dir)
1055 (tramp-error v 'file-error "Couldn't make directory %s" dir))))))
1056
1057 (defun tramp-smb-handle-make-directory-internal (directory)
1058 "Like `make-directory-internal' for Tramp files."
1059 (setq directory (directory-file-name (expand-file-name directory)))
1060 (unless (file-name-absolute-p directory)
1061 (setq directory (expand-file-name directory default-directory)))
1062 (with-parsed-tramp-file-name directory nil
1063 (save-match-data
1064 (let* ((file (tramp-smb-get-localname v)))
1065 (when (file-directory-p (file-name-directory directory))
1066 (tramp-smb-send-command
1067 v
1068 (if (tramp-smb-get-cifs-capabilities v)
1069 (format "posix_mkdir \"%s\" %o" file (default-file-modes))
1070 (format "mkdir \"%s\"" file)))
1071 ;; We must also flush the cache of the directory, because
1072 ;; `file-attributes' reads the values from there.
1073 (tramp-flush-file-property v (file-name-directory localname))
1074 (tramp-flush-file-property v localname))
1075 (unless (file-directory-p directory)
1076 (tramp-error
1077 v 'file-error "Couldn't make directory %s" directory))))))
1078
1079 (defun tramp-smb-handle-make-symbolic-link
1080 (filename linkname &optional ok-if-already-exists)
1081 "Like `make-symbolic-link' for Tramp files.
1082 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1083 the symlink. If LINKNAME is a Tramp file, only the localname component is
1084 used as the target of the symlink.
1085
1086 If LINKNAME is a Tramp file and the localname component is relative, then
1087 it is expanded first, before the localname component is taken. Note that
1088 this can give surprising results if the user/host for the source and
1089 target of the symlink differ."
1090 (unless (tramp-equal-remote filename linkname)
1091 (with-parsed-tramp-file-name
1092 (if (tramp-tramp-file-p filename) filename linkname) nil
1093 (tramp-error
1094 v 'file-error
1095 "make-symbolic-link: %s"
1096 "only implemented for same method, same user, same host")))
1097 (with-parsed-tramp-file-name filename v1
1098 (with-parsed-tramp-file-name linkname v2
1099 (when (file-directory-p filename)
1100 (tramp-error
1101 v2 'file-error
1102 "make-symbolic-link: %s must not be a directory" filename))
1103 (when (and (not ok-if-already-exists)
1104 (file-exists-p linkname)
1105 (not (numberp ok-if-already-exists))
1106 (y-or-n-p
1107 (format
1108 "File %s already exists; make it a new name anyway? "
1109 linkname)))
1110 (tramp-error
1111 v2 'file-error
1112 "make-symbolic-link: file %s already exists" linkname))
1113 (unless (tramp-smb-get-cifs-capabilities v1)
1114 (tramp-error v2 'file-error "make-symbolic-link not supported"))
1115 ;; We must also flush the cache of the directory, because
1116 ;; `file-attributes' reads the values from there.
1117 (tramp-flush-file-property v2 (file-name-directory v2-localname))
1118 (tramp-flush-file-property v2 v2-localname)
1119 (unless
1120 (tramp-smb-send-command
1121 v1
1122 (format
1123 "symlink \"%s\" \"%s\""
1124 (tramp-smb-get-localname v1)
1125 (tramp-smb-get-localname v2)))
1126 (tramp-error
1127 v2 'file-error
1128 "error with make-symbolic-link, see buffer `%s' for details"
1129 (buffer-name))))))
1130
1131 (defun tramp-smb-handle-process-file
1132 (program &optional infile destination display &rest args)
1133 "Like `process-file' for Tramp files."
1134 ;; The implementation is not complete yet.
1135 (when (and (numberp destination) (zerop destination))
1136 (error "Implementation does not handle immediate return"))
1137
1138 (with-parsed-tramp-file-name default-directory nil
1139 (let* ((name (file-name-nondirectory program))
1140 (name1 name)
1141 (i 0)
1142 input tmpinput outbuf command ret)
1143
1144 ;; Determine input.
1145 (when infile
1146 (setq infile (expand-file-name infile))
1147 (if (tramp-equal-remote default-directory infile)
1148 ;; INFILE is on the same remote host.
1149 (setq input (with-parsed-tramp-file-name infile nil localname))
1150 ;; INFILE must be copied to remote host.
1151 (setq input (tramp-make-tramp-temp-file v)
1152 tmpinput (tramp-make-tramp-file-name method user host input))
1153 (copy-file infile tmpinput t))
1154 ;; Transform input into a filename powershell does understand.
1155 (setq input (format "//%s%s" host input)))
1156
1157 ;; Determine output.
1158 (cond
1159 ;; Just a buffer.
1160 ((bufferp destination)
1161 (setq outbuf destination))
1162 ;; A buffer name.
1163 ((stringp destination)
1164 (setq outbuf (get-buffer-create destination)))
1165 ;; (REAL-DESTINATION ERROR-DESTINATION)
1166 ((consp destination)
1167 ;; output.
1168 (cond
1169 ((bufferp (car destination))
1170 (setq outbuf (car destination)))
1171 ((stringp (car destination))
1172 (setq outbuf (get-buffer-create (car destination))))
1173 ((car destination)
1174 (setq outbuf (current-buffer))))
1175 ;; stderr.
1176 (tramp-message v 2 "%s" "STDERR not supported"))
1177 ;; 't
1178 (destination
1179 (setq outbuf (current-buffer))))
1180
1181 ;; Construct command.
1182 (setq command (mapconcat 'identity (cons program args) " ")
1183 command (if input
1184 (format
1185 "get-content %s | & %s"
1186 (tramp-smb-shell-quote-argument input) command)
1187 (format "& %s" command)))
1188
1189 (while (get-process name1)
1190 ;; NAME must be unique as process name.
1191 (setq i (1+ i)
1192 name1 (format "%s<%d>" name i)))
1193
1194 ;; Set the new process properties.
1195 (tramp-set-connection-property v "process-name" name1)
1196 (tramp-set-connection-property
1197 v "process-buffer"
1198 (or outbuf (generate-new-buffer tramp-temp-buffer-name)))
1199
1200 ;; Call it.
1201 (condition-case nil
1202 (with-current-buffer (tramp-get-connection-buffer v)
1203 ;; Preserve buffer contents.
1204 (narrow-to-region (point-max) (point-max))
1205 (tramp-smb-call-winexe v)
1206 (when (tramp-smb-get-share v)
1207 (tramp-smb-send-command
1208 v (format "cd \"//%s%s\"" host (file-name-directory localname))))
1209 (tramp-smb-send-command v command)
1210 ;; Preserve command output.
1211 (narrow-to-region (point-max) (point-max))
1212 (let ((p (tramp-get-connection-process v)))
1213 (tramp-smb-send-command v "exit $lasterrorcode")
1214 (while (memq (process-status p) '(run open))
1215 (sleep-for 0.1)
1216 (setq ret (process-exit-status p))))
1217 (delete-region (point-min) (point-max))
1218 (widen))
1219
1220 ;; When the user did interrupt, we should do it also. We use
1221 ;; return code -1 as marker.
1222 (quit
1223 (setq ret -1))
1224 ;; Handle errors.
1225 (error
1226 (setq ret 1)))
1227
1228 ;; We should redisplay the output.
1229 (when (and display outbuf (get-buffer-window outbuf t)) (redisplay))
1230
1231 ;; Cleanup. We remove all file cache values for the connection,
1232 ;; because the remote process could have changed them.
1233 (tramp-set-connection-property v "process-name" nil)
1234 (tramp-set-connection-property v "process-buffer" nil)
1235 (when tmpinput (delete-file tmpinput))
1236 (unless outbuf
1237 (kill-buffer (tramp-get-connection-property v "process-buffer" nil)))
1238
1239 (unless process-file-side-effects
1240 (tramp-flush-directory-property v ""))
1241
1242 ;; Return exit status.
1243 (if (equal ret -1)
1244 (keyboard-quit)
1245 ret))))
1246
1247 (defun tramp-smb-handle-rename-file
1248 (filename newname &optional ok-if-already-exists)
1249 "Like `rename-file' for Tramp files."
1250 (setq filename (expand-file-name filename)
1251 newname (expand-file-name newname))
1252
1253 (when (and (not ok-if-already-exists)
1254 (file-exists-p newname))
1255 (tramp-error
1256 (tramp-dissect-file-name
1257 (if (tramp-tramp-file-p filename) filename newname))
1258 'file-already-exists newname))
1259
1260 (with-tramp-progress-reporter
1261 (tramp-dissect-file-name
1262 (if (tramp-tramp-file-p filename) filename newname))
1263 0 (format "Renaming %s to %s" filename newname)
1264
1265 (if (and (not (file-exists-p newname))
1266 (tramp-equal-remote filename newname)
1267 (string-equal
1268 (tramp-smb-get-share (tramp-dissect-file-name filename))
1269 (tramp-smb-get-share (tramp-dissect-file-name newname))))
1270 ;; We can rename directly.
1271 (with-parsed-tramp-file-name filename v1
1272 (with-parsed-tramp-file-name newname v2
1273
1274 ;; We must also flush the cache of the directory, because
1275 ;; `file-attributes' reads the values from there.
1276 (tramp-flush-file-property v1 (file-name-directory v1-localname))
1277 (tramp-flush-file-property v1 v1-localname)
1278 (tramp-flush-file-property v2 (file-name-directory v2-localname))
1279 (tramp-flush-file-property v2 v2-localname)
1280 (unless (tramp-smb-get-share v2)
1281 (tramp-error
1282 v2 'file-error "Target `%s' must contain a share name" newname))
1283 (unless (tramp-smb-send-command
1284 v2 (format "rename \"%s\" \"%s\""
1285 (tramp-smb-get-localname v1)
1286 (tramp-smb-get-localname v2)))
1287 (tramp-error v2 'file-error "Cannot rename `%s'" filename))))
1288
1289 ;; We must rename via copy.
1290 (copy-file
1291 filename newname ok-if-already-exists 'keep-time 'preserve-uid-gid)
1292 (if (file-directory-p filename)
1293 (delete-directory filename 'recursive)
1294 (delete-file filename)))))
1295
1296 (defun tramp-smb-action-set-acl (proc vec)
1297 "Read ACL data from connection buffer."
1298 (when (not (memq (process-status proc) '(run open)))
1299 ;; Accept pending output.
1300 (while (tramp-accept-process-output proc 0.1))
1301 (with-current-buffer (tramp-get-connection-buffer vec)
1302 (tramp-message vec 10 "\n%s" (buffer-string))
1303 (throw 'tramp-action 'ok))))
1304
1305 (defun tramp-smb-handle-set-file-acl (filename acl-string)
1306 "Like `set-file-acl' for Tramp files."
1307 (ignore-errors
1308 (with-parsed-tramp-file-name filename nil
1309 (when (and (stringp acl-string) (executable-find tramp-smb-acl-program))
1310 (setq tramp-current-method (tramp-file-name-method v)
1311 tramp-current-user (tramp-file-name-user v)
1312 tramp-current-host (tramp-file-name-real-host v))
1313 (tramp-set-file-property v localname "file-acl" 'undef)
1314
1315 (let* ((real-user (tramp-file-name-real-user v))
1316 (real-host (tramp-file-name-real-host v))
1317 (domain (tramp-file-name-domain v))
1318 (port (tramp-file-name-port v))
1319 (share (tramp-smb-get-share v))
1320 (localname (replace-regexp-in-string
1321 "\\\\" "/" (tramp-smb-get-localname v)))
1322 (args (list (concat "//" real-host "/" share) "-E" "-S"
1323 (replace-regexp-in-string
1324 "\n" "," acl-string))))
1325
1326 (if (not (zerop (length real-user)))
1327 (setq args (append args (list "-U" real-user)))
1328 (setq args (append args (list "-N"))))
1329
1330 (when domain (setq args (append args (list "-W" domain))))
1331 (when port (setq args (append args (list "-p" port))))
1332 (when tramp-smb-conf
1333 (setq args (append args (list "-s" tramp-smb-conf))))
1334 (setq
1335 args
1336 (append args (list (shell-quote-argument localname)
1337 "&&" "echo" "tramp_exit_status" "0"
1338 "||" "echo" "tramp_exit_status" "1")))
1339
1340 (unwind-protect
1341 (with-temp-buffer
1342 ;; Set the transfer process properties.
1343 (tramp-set-connection-property
1344 v "process-name" (buffer-name (current-buffer)))
1345 (tramp-set-connection-property
1346 v "process-buffer" (current-buffer))
1347
1348 ;; Use an asynchronous processes. By this, password can
1349 ;; be handled.
1350 (let ((p (apply
1351 'start-process
1352 (tramp-get-connection-name v)
1353 (tramp-get-connection-buffer v)
1354 tramp-smb-acl-program args)))
1355
1356 (tramp-message
1357 v 6 "%s" (mapconcat 'identity (process-command p) " "))
1358 (tramp-set-connection-property p "vector" v)
1359 (set-process-query-on-exit-flag p nil)
1360 (tramp-process-actions p v nil tramp-smb-actions-set-acl)
1361 (goto-char (point-max))
1362 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t)
1363 (tramp-error
1364 v 'file-error
1365 "Couldn't find exit status of `%s'" tramp-smb-acl-program))
1366 (skip-chars-forward "^ ")
1367 (when (zerop (read (current-buffer)))
1368 ;; Success.
1369 (tramp-set-file-property v localname "file-acl" acl-string)
1370 t)))
1371
1372 ;; Reset the transfer process properties.
1373 (tramp-set-connection-property v "process-name" nil)
1374 (tramp-set-connection-property v "process-buffer" nil)))))))
1375
1376 (defun tramp-smb-handle-set-file-modes (filename mode)
1377 "Like `set-file-modes' for Tramp files."
1378 (with-parsed-tramp-file-name filename nil
1379 (when (tramp-smb-get-cifs-capabilities v)
1380 (tramp-flush-file-property v localname)
1381 (unless (tramp-smb-send-command
1382 v (format "chmod \"%s\" %o" (tramp-smb-get-localname v) mode))
1383 (tramp-error
1384 v 'file-error "Error while changing file's mode %s" filename)))))
1385
1386 ;; We use BUFFER also as connection buffer during setup. Because of
1387 ;; this, its original contents must be saved, and restored once
1388 ;; connection has been setup.
1389 (defun tramp-smb-handle-start-file-process (name buffer program &rest args)
1390 "Like `start-file-process' for Tramp files."
1391 (with-parsed-tramp-file-name default-directory nil
1392 (let ((command (mapconcat 'identity (cons program args) " "))
1393 (bmp (and (buffer-live-p buffer) (buffer-modified-p buffer)))
1394 (name1 name)
1395 (i 0))
1396 (unwind-protect
1397 (save-excursion
1398 (save-restriction
1399 (unless buffer
1400 ;; BUFFER can be nil. We use a temporary buffer.
1401 (setq buffer (generate-new-buffer tramp-temp-buffer-name)))
1402 (while (get-process name1)
1403 ;; NAME must be unique as process name.
1404 (setq i (1+ i)
1405 name1 (format "%s<%d>" name i)))
1406 ;; Set the new process properties.
1407 (tramp-set-connection-property v "process-name" name1)
1408 (tramp-set-connection-property v "process-buffer" buffer)
1409 ;; Activate narrowing in order to save BUFFER contents.
1410 (with-current-buffer (tramp-get-connection-buffer v)
1411 (let ((buffer-undo-list t))
1412 (narrow-to-region (point-max) (point-max))
1413 (tramp-smb-call-winexe v)
1414 (when (tramp-smb-get-share v)
1415 (tramp-smb-send-command
1416 v (format
1417 "cd \"//%s%s\""
1418 host (file-name-directory localname))))
1419 (tramp-message v 6 "(%s); exit" command)
1420 (tramp-send-string v command)))
1421 ;; Return value.
1422 (tramp-get-connection-process v)))
1423
1424 ;; Save exit.
1425 (with-current-buffer (tramp-get-connection-buffer v)
1426 (if (string-match tramp-temp-buffer-name (buffer-name))
1427 (progn
1428 (set-process-buffer (tramp-get-connection-process v) nil)
1429 (kill-buffer (current-buffer)))
1430 (set-buffer-modified-p bmp)))
1431 (tramp-set-connection-property v "process-name" nil)
1432 (tramp-set-connection-property v "process-buffer" nil)))))
1433
1434 (defun tramp-smb-handle-substitute-in-file-name (filename)
1435 "Like `handle-substitute-in-file-name' for Tramp files.
1436 \"//\" substitutes only in the local filename part. Catches
1437 errors for shares like \"C$/\", which are common in Microsoft Windows."
1438 (with-parsed-tramp-file-name filename nil
1439 ;; Ignore in LOCALNAME everything before "//".
1440 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
1441 (setq filename
1442 (concat (file-remote-p filename)
1443 (replace-match "\\1" nil nil localname)))))
1444 (condition-case nil
1445 (tramp-run-real-handler 'substitute-in-file-name (list filename))
1446 (error filename)))
1447
1448 (defun tramp-smb-handle-write-region
1449 (start end filename &optional append visit lockname confirm)
1450 "Like `write-region' for Tramp files."
1451 (setq filename (expand-file-name filename))
1452 (with-parsed-tramp-file-name filename nil
1453 (when (and confirm (file-exists-p filename))
1454 (unless (y-or-n-p (format "File %s exists; overwrite anyway? "
1455 filename))
1456 (tramp-error v 'file-error "File not overwritten")))
1457 ;; We must also flush the cache of the directory, because
1458 ;; `file-attributes' reads the values from there.
1459 (tramp-flush-file-property v (file-name-directory localname))
1460 (tramp-flush-file-property v localname)
1461 (let ((curbuf (current-buffer))
1462 (tmpfile (tramp-compat-make-temp-file filename)))
1463 (when (and append (file-exists-p filename))
1464 (copy-file filename tmpfile 'ok))
1465 ;; We say `no-message' here because we don't want the visited file
1466 ;; modtime data to be clobbered from the temp file. We call
1467 ;; `set-visited-file-modtime' ourselves later on.
1468 (tramp-run-real-handler
1469 'write-region
1470 (if confirm ; don't pass this arg unless defined for backward compat.
1471 (list start end tmpfile append 'no-message lockname confirm)
1472 (list start end tmpfile append 'no-message lockname)))
1473
1474 (with-tramp-progress-reporter
1475 v 3 (format "Moving tmp file %s to %s" tmpfile filename)
1476 (unwind-protect
1477 (unless (tramp-smb-send-command
1478 v (format "put %s \"%s\""
1479 tmpfile (tramp-smb-get-localname v)))
1480 (tramp-error v 'file-error "Cannot write `%s'" filename))
1481 (delete-file tmpfile)))
1482
1483 (unless (equal curbuf (current-buffer))
1484 (tramp-error
1485 v 'file-error
1486 "Buffer has changed from `%s' to `%s'" curbuf (current-buffer)))
1487 (when (eq visit t)
1488 (set-visited-file-modtime)))))
1489
1490
1491 ;; Internal file name functions.
1492
1493 (defun tramp-smb-get-share (vec)
1494 "Returns the share name of LOCALNAME."
1495 (save-match-data
1496 (let ((localname (tramp-file-name-localname vec)))
1497 (when (string-match "^/?\\([^/]+\\)/" localname)
1498 (match-string 1 localname)))))
1499
1500 (defun tramp-smb-get-localname (vec)
1501 "Returns the file name of LOCALNAME.
1502 If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"."
1503 (save-match-data
1504 (let ((localname (tramp-file-name-localname vec)))
1505 (setq
1506 localname
1507 (if (string-match "^/?[^/]+\\(/.*\\)" localname)
1508 ;; There is a share, separated by "/".
1509 (if (not (tramp-smb-get-cifs-capabilities vec))
1510 (mapconcat
1511 (lambda (x) (if (equal x ?/) "\\" (char-to-string x)))
1512 (match-string 1 localname) "")
1513 (match-string 1 localname))
1514 ;; There is just a share.
1515 (if (string-match "^/?\\([^/]+\\)$" localname)
1516 (match-string 1 localname)
1517 "")))
1518
1519 ;; Sometimes we have discarded `substitute-in-file-name'.
1520 (when (string-match "\\(\\$\\$\\)\\(/\\|$\\)" localname)
1521 (setq localname (replace-match "$" nil nil localname 1)))
1522
1523 localname)))
1524
1525 ;; Share names of a host are cached. It is very unlikely that the
1526 ;; shares do change during connection.
1527 (defun tramp-smb-get-file-entries (directory)
1528 "Read entries which match DIRECTORY.
1529 Either the shares are listed, or the `dir' command is executed.
1530 Result is a list of (LOCALNAME MODE SIZE MONTH DAY TIME YEAR)."
1531 (with-parsed-tramp-file-name (file-name-as-directory directory) nil
1532 (setq localname (or localname "/"))
1533 (with-tramp-file-property v localname "file-entries"
1534 (with-current-buffer (tramp-get-connection-buffer v)
1535 (let* ((share (tramp-smb-get-share v))
1536 (cache (tramp-get-connection-property v "share-cache" nil))
1537 res entry)
1538
1539 (if (and (not share) cache)
1540 ;; Return cached shares.
1541 (setq res cache)
1542
1543 ;; Read entries.
1544 (if share
1545 (tramp-smb-send-command
1546 v (format "dir \"%s*\"" (tramp-smb-get-localname v)))
1547 ;; `tramp-smb-maybe-open-connection' lists also the share names.
1548 (tramp-smb-maybe-open-connection v))
1549
1550 ;; Loop the listing.
1551 (goto-char (point-min))
1552 (if (re-search-forward tramp-smb-errors nil t)
1553 (tramp-error v 'file-error "%s `%s'" (match-string 0) directory)
1554 (while (not (eobp))
1555 (setq entry (tramp-smb-read-file-entry share))
1556 (forward-line)
1557 (when entry (push entry res))))
1558
1559 ;; Cache share entries.
1560 (unless share
1561 (tramp-set-connection-property v "share-cache" res)))
1562
1563 ;; Add directory itself.
1564 (push '("" "drwxrwxrwx" 0 (0 0)) res)
1565
1566 ;; Return entries.
1567 (delq nil res))))))
1568
1569 ;; Return either a share name (if SHARE is nil), or a file name.
1570 ;;
1571 ;; If shares are listed, the following format is expected:
1572 ;;
1573 ;; Disk| - leading spaces
1574 ;; [^|]+| - share name, 14 char
1575 ;; .* - comment
1576 ;;
1577 ;; Entries provided by smbclient DIR aren't fully regular.
1578 ;; They should have the format
1579 ;;
1580 ;; \s-\{2,2} - leading spaces
1581 ;; \S-\(.*\S-\)\s-* - file name, 30 chars, left bound
1582 ;; \s-+[ADHRSV]* - permissions, 7 chars, right bound
1583 ;; \s- - space delimiter
1584 ;; \s-+[0-9]+ - size, 8 chars, right bound
1585 ;; \s-\{2,2\} - space delimiter
1586 ;; \w\{3,3\} - weekday
1587 ;; \s- - space delimiter
1588 ;; \w\{3,3\} - month
1589 ;; \s- - space delimiter
1590 ;; [ 12][0-9] - day
1591 ;; \s- - space delimiter
1592 ;; [0-9]\{2,2\}:[0-9]\{2,2\}:[0-9]\{2,2\} - time
1593 ;; \s- - space delimiter
1594 ;; [0-9]\{4,4\} - year
1595 ;;
1596 ;; samba/src/client.c (http://samba.org/doxygen/samba/client_8c-source.html)
1597 ;; has function display_finfo:
1598 ;;
1599 ;; d_printf(" %-30s%7.7s %8.0f %s",
1600 ;; finfo->name,
1601 ;; attrib_string(finfo->mode),
1602 ;; (double)finfo->size,
1603 ;; asctime(LocalTime(&t)));
1604 ;;
1605 ;; in Samba 1.9, there's the following code:
1606 ;;
1607 ;; DEBUG(0,(" %-30s%7.7s%10d %s",
1608 ;; CNV_LANG(finfo->name),
1609 ;; attrib_string(finfo->mode),
1610 ;; finfo->size,
1611 ;; asctime(LocalTime(&t))));
1612 ;;
1613 ;; Problems:
1614 ;; * Modern regexp constructs, like spy groups and counted repetitions, aren't
1615 ;; available in older Emacsen.
1616 ;; * The length of constructs (file name, size) might exceed the default.
1617 ;; * File names might contain spaces.
1618 ;; * Permissions might be empty.
1619 ;;
1620 ;; So we try to analyze backwards.
1621 (defun tramp-smb-read-file-entry (share)
1622 "Parse entry in SMB output buffer.
1623 If SHARE is result, entries are of type dir. Otherwise, shares are listed.
1624 Result is the list (LOCALNAME MODE SIZE MTIME)."
1625 ;; We are called from `tramp-smb-get-file-entries', which sets the
1626 ;; current buffer.
1627 (let ((line (buffer-substring (point) (point-at-eol)))
1628 localname mode size month day hour min sec year mtime)
1629
1630 (if (not share)
1631
1632 ;; Read share entries.
1633 (when (string-match "^Disk|\\([^|]+\\)|" line)
1634 (setq localname (match-string 1 line)
1635 mode "dr-xr-xr-x"
1636 size 0))
1637
1638 ;; Real listing.
1639 (block nil
1640
1641 ;; year.
1642 (if (string-match "\\([0-9]+\\)$" line)
1643 (setq year (string-to-number (match-string 1 line))
1644 line (substring line 0 -5))
1645 (return))
1646
1647 ;; time.
1648 (if (string-match "\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)$" line)
1649 (setq hour (string-to-number (match-string 1 line))
1650 min (string-to-number (match-string 2 line))
1651 sec (string-to-number (match-string 3 line))
1652 line (substring line 0 -9))
1653 (return))
1654
1655 ;; day.
1656 (if (string-match "\\([0-9]+\\)$" line)
1657 (setq day (string-to-number (match-string 1 line))
1658 line (substring line 0 -3))
1659 (return))
1660
1661 ;; month.
1662 (if (string-match "\\(\\w+\\)$" line)
1663 (setq month (match-string 1 line)
1664 line (substring line 0 -4))
1665 (return))
1666
1667 ;; weekday.
1668 (if (string-match "\\(\\w+\\)$" line)
1669 (setq line (substring line 0 -5))
1670 (return))
1671
1672 ;; size.
1673 (if (string-match "\\([0-9]+\\)$" line)
1674 (let ((length (- (max 10 (1+ (length (match-string 1 line)))))))
1675 (setq size (string-to-number (match-string 1 line)))
1676 (when (string-match "\\([ADHRSV]+\\)" (substring line length))
1677 (setq length (+ length (match-end 0))))
1678 (setq line (substring line 0 length)))
1679 (return))
1680
1681 ;; mode: ARCH, DIR, HIDDEN, RONLY, SYSTEM, VOLID.
1682 (if (string-match "\\([ADHRSV]+\\)?$" line)
1683 (setq
1684 mode (or (match-string 1 line) "")
1685 mode (save-match-data (format
1686 "%s%s"
1687 (if (string-match "D" mode) "d" "-")
1688 (mapconcat
1689 (lambda (_x) "") " "
1690 (concat "r" (if (string-match "R" mode) "-" "w") "x"))))
1691 line (substring line 0 -6))
1692 (return))
1693
1694 ;; localname.
1695 (if (string-match "^\\s-+\\(\\S-\\(.*\\S-\\)?\\)\\s-*$" line)
1696 (setq localname (match-string 1 line))
1697 (return))))
1698
1699 (when (and localname mode size)
1700 (setq mtime
1701 (if (and sec min hour day month year)
1702 (encode-time
1703 sec min hour day
1704 (cdr (assoc (downcase month) tramp-parse-time-months))
1705 year)
1706 '(0 0)))
1707 (list localname mode size mtime))))
1708
1709 (defun tramp-smb-get-cifs-capabilities (vec)
1710 "Check, whether the SMB server supports POSIX commands."
1711 ;; When we are not logged in yet, we return nil.
1712 (if (let ((p (tramp-get-connection-process vec)))
1713 (and p (processp p) (memq (process-status p) '(run open))))
1714 (with-tramp-connection-property
1715 (tramp-get-connection-process vec) "cifs-capabilities"
1716 (save-match-data
1717 (when (tramp-smb-send-command vec "posix")
1718 (with-current-buffer (tramp-get-connection-buffer vec)
1719 (goto-char (point-min))
1720 (when
1721 (re-search-forward "Server supports CIFS capabilities" nil t)
1722 (member
1723 "pathnames"
1724 (split-string
1725 (buffer-substring (point) (point-at-eol)) nil 'omit)))))))))
1726
1727 (defun tramp-smb-get-stat-capability (vec)
1728 "Check, whether the SMB server supports the STAT command."
1729 ;; When we are not logged in yet, we return nil.
1730 (if (and (tramp-smb-get-share vec)
1731 (let ((p (tramp-get-connection-process vec)))
1732 (and p (processp p) (memq (process-status p) '(run open)))))
1733 (with-tramp-connection-property
1734 (tramp-get-connection-process vec) "stat-capability"
1735 (tramp-smb-send-command vec "stat \"/\""))))
1736
1737
1738 ;; Connection functions.
1739
1740 (defun tramp-smb-send-command (vec command)
1741 "Send the COMMAND to connection VEC.
1742 Returns nil if there has been an error message from smbclient."
1743 (tramp-smb-maybe-open-connection vec)
1744 (tramp-message vec 6 "%s" command)
1745 (tramp-send-string vec command)
1746 (tramp-smb-wait-for-output vec))
1747
1748 (defun tramp-smb-maybe-open-connection (vec &optional argument)
1749 "Maybe open a connection to HOST, log in as USER, using `tramp-smb-program'.
1750 Does not do anything if a connection is already open, but re-opens the
1751 connection if a previous connection has died for some reason.
1752 If ARGUMENT is non-nil, use it as argument for
1753 `tramp-smb-winexe-program', and suppress any checks."
1754 (tramp-check-proper-method-and-host vec)
1755
1756 (let* ((share (tramp-smb-get-share vec))
1757 (buf (tramp-get-connection-buffer vec))
1758 (p (get-buffer-process buf)))
1759
1760 ;; Check whether we still have the same smbclient version.
1761 ;; Otherwise, we must delete the connection cache, because
1762 ;; capabilities migh have changed.
1763 (unless (or argument (processp p))
1764 (let ((default-directory (tramp-compat-temporary-file-directory))
1765 (command (concat tramp-smb-program " -V")))
1766
1767 (unless tramp-smb-version
1768 (unless (executable-find tramp-smb-program)
1769 (tramp-error
1770 vec 'file-error
1771 "Cannot find command %s in %s" tramp-smb-program exec-path))
1772 (setq tramp-smb-version (shell-command-to-string command))
1773 (tramp-message vec 6 command)
1774 (tramp-message vec 6 "\n%s" tramp-smb-version)
1775 (if (string-match "[ \t\n\r]+\\'" tramp-smb-version)
1776 (setq tramp-smb-version
1777 (replace-match "" nil nil tramp-smb-version))))
1778
1779 (unless (string-equal
1780 tramp-smb-version
1781 (tramp-get-connection-property
1782 vec "smbclient-version" tramp-smb-version))
1783 (tramp-flush-directory-property vec "")
1784 (tramp-flush-connection-property vec))
1785
1786 (tramp-set-connection-property
1787 vec "smbclient-version" tramp-smb-version)))
1788
1789 ;; If too much time has passed since last command was sent, look
1790 ;; whether there has been an error message; maybe due to
1791 ;; connection timeout.
1792 (with-current-buffer buf
1793 (goto-char (point-min))
1794 (when (and (> (tramp-time-diff
1795 (current-time)
1796 (tramp-get-connection-property
1797 p "last-cmd-time" '(0 0 0)))
1798 60)
1799 p (processp p) (memq (process-status p) '(run open))
1800 (re-search-forward tramp-smb-errors nil t))
1801 (delete-process p)
1802 (setq p nil)))
1803
1804 ;; Check whether it is still the same share.
1805 (unless
1806 (and p (processp p) (memq (process-status p) '(run open))
1807 (or argument
1808 (string-equal
1809 share
1810 (tramp-get-connection-property p "smb-share" ""))))
1811
1812 (save-match-data
1813 ;; There might be unread output from checking for share names.
1814 (when buf (with-current-buffer buf (erase-buffer)))
1815 (when (and p (processp p)) (delete-process p))
1816
1817 (let* ((user (tramp-file-name-user vec))
1818 (host (tramp-file-name-host vec))
1819 (real-user (tramp-file-name-real-user vec))
1820 (real-host (tramp-file-name-real-host vec))
1821 (domain (tramp-file-name-domain vec))
1822 (port (tramp-file-name-port vec))
1823 args)
1824
1825 (cond
1826 (argument
1827 (setq args (list (concat "//" real-host))))
1828 (share
1829 (setq args (list (concat "//" real-host "/" share))))
1830 (t
1831 (setq args (list "-g" "-L" real-host ))))
1832
1833 (if (not (zerop (length real-user)))
1834 (setq args (append args (list "-U" real-user)))
1835 (setq args (append args (list "-N"))))
1836
1837 (when domain (setq args (append args (list "-W" domain))))
1838 (when port (setq args (append args (list "-p" port))))
1839 (when tramp-smb-conf
1840 (setq args (append args (list "-s" tramp-smb-conf))))
1841 (when argument
1842 (setq args (append args (list argument))))
1843
1844 ;; OK, let's go.
1845 (with-tramp-progress-reporter
1846 vec 3
1847 (format "Opening connection for //%s%s/%s"
1848 (if (not (zerop (length user))) (concat user "@") "")
1849 host (or share ""))
1850
1851 (let* ((coding-system-for-read nil)
1852 (process-connection-type tramp-process-connection-type)
1853 (p (let ((default-directory
1854 (tramp-compat-temporary-file-directory)))
1855 (apply #'start-process
1856 (tramp-get-connection-name vec)
1857 (tramp-get-connection-buffer vec)
1858 (if argument
1859 tramp-smb-winexe-program tramp-smb-program)
1860 args))))
1861
1862 (tramp-message
1863 vec 6 "%s" (mapconcat 'identity (process-command p) " "))
1864 (tramp-set-connection-property p "vector" vec)
1865 (set-process-query-on-exit-flag p nil)
1866
1867 ;; Set variables for computing the prompt for reading password.
1868 (setq tramp-current-method tramp-smb-method
1869 tramp-current-user user
1870 tramp-current-host host)
1871
1872 (condition-case err
1873 (let (tramp-message-show-message)
1874 ;; Play login scenario.
1875 (tramp-process-actions
1876 p vec nil
1877 (if (or argument share)
1878 tramp-smb-actions-with-share
1879 tramp-smb-actions-without-share))
1880
1881 ;; Check server version.
1882 (unless argument
1883 (with-current-buffer (tramp-get-connection-buffer vec)
1884 (goto-char (point-min))
1885 (search-forward-regexp tramp-smb-server-version nil t)
1886 (let ((smbserver-version (match-string 0)))
1887 (unless
1888 (string-equal
1889 smbserver-version
1890 (tramp-get-connection-property
1891 vec "smbserver-version" smbserver-version))
1892 (tramp-flush-directory-property vec "")
1893 (tramp-flush-connection-property vec))
1894 (tramp-set-connection-property
1895 vec "smbserver-version" smbserver-version))))
1896
1897 ;; Set chunksize to 1. smbclient reads its input
1898 ;; character by character; if we send the string
1899 ;; at once, it is read painfully slow.
1900 (tramp-set-connection-property p "smb-share" share)
1901 (tramp-set-connection-property p "chunksize" 1)
1902
1903 ;; Mark it as connected.
1904 (tramp-set-connection-property p "connected" t))
1905
1906 ;; Check for the error reason. If it was due to wrong
1907 ;; password, reestablish the connection. We cannot
1908 ;; handle this in `tramp-process-actions', because
1909 ;; smbclient does not ask for the password, again.
1910 (error
1911 (with-current-buffer (tramp-get-connection-buffer vec)
1912 (goto-char (point-min))
1913 (if (and (boundp 'auth-sources)
1914 (symbol-value 'auth-sources)
1915 (search-forward-regexp
1916 tramp-smb-wrong-passwd-regexp nil t))
1917 ;; Disable `auth-source' and `password-cache'.
1918 (let (auth-sources)
1919 (tramp-message
1920 vec 3 "Retry connection with new password")
1921 (tramp-cleanup-connection vec t)
1922 (tramp-smb-maybe-open-connection vec argument))
1923 ;; Propagate the error.
1924 (signal (car err) (cdr err)))))))))))))
1925
1926 ;; We don't use timeouts. If needed, the caller shall wrap around.
1927 (defun tramp-smb-wait-for-output (vec)
1928 "Wait for output from smbclient command.
1929 Returns nil if an error message has appeared."
1930 (with-current-buffer (tramp-get-connection-buffer vec)
1931 (let ((p (get-buffer-process (current-buffer)))
1932 (found (progn (goto-char (point-min))
1933 (re-search-forward tramp-smb-prompt nil t)))
1934 (err (progn (goto-char (point-min))
1935 (re-search-forward tramp-smb-errors nil t)))
1936 buffer-read-only)
1937
1938 ;; Algorithm: get waiting output. See if last line contains
1939 ;; `tramp-smb-prompt' sentinel or `tramp-smb-errors' strings.
1940 ;; If not, wait a bit and again get waiting output.
1941 (while (and (not found) (not err) (memq (process-status p) '(run open)))
1942
1943 ;; Accept pending output.
1944 (tramp-accept-process-output p 0.1)
1945
1946 ;; Search for prompt.
1947 (goto-char (point-min))
1948 (setq found (re-search-forward tramp-smb-prompt nil t))
1949
1950 ;; Search for errors.
1951 (goto-char (point-min))
1952 (setq err (re-search-forward tramp-smb-errors nil t)))
1953
1954 ;; When the process is still alive, read pending output.
1955 (while (and (not found) (memq (process-status p) '(run open)))
1956
1957 ;; Accept pending output.
1958 (tramp-accept-process-output p 0.1)
1959
1960 ;; Search for prompt.
1961 (goto-char (point-min))
1962 (setq found (re-search-forward tramp-smb-prompt nil t)))
1963
1964 (tramp-message vec 6 "\n%s" (buffer-string))
1965
1966 ;; Remove prompt.
1967 (when found
1968 (goto-char (point-max))
1969 (re-search-backward tramp-smb-prompt nil t)
1970 (delete-region (point) (point-max)))
1971
1972 ;; Return value is whether no error message has appeared.
1973 (not err))))
1974
1975 (defun tramp-smb-kill-winexe-function ()
1976 "Send SIGKILL to the winexe process."
1977 (ignore-errors
1978 (let ((p (get-buffer-process (current-buffer))))
1979 (when (and p (processp p) (memq (process-status p) '(run open)))
1980 (signal-process (process-id p) 'SIGINT)))))
1981
1982 (defun tramp-smb-call-winexe (vec)
1983 "Apply a remote command, if possible, using `tramp-smb-winexe-program'."
1984
1985 ;; Check for program.
1986 (unless (executable-find tramp-smb-winexe-program)
1987 (tramp-error
1988 vec 'file-error "Cannot find program: %s" tramp-smb-winexe-program))
1989
1990 ;; winexe does not supports ports.
1991 (when (tramp-file-name-port vec)
1992 (tramp-error vec 'file-error "Port not supported for remote processes"))
1993
1994 (tramp-smb-maybe-open-connection
1995 vec
1996 (format
1997 "%s %s"
1998 tramp-smb-winexe-shell-command tramp-smb-winexe-shell-command-switch))
1999
2000 (set (make-local-variable 'kill-buffer-hook)
2001 '(tramp-smb-kill-winexe-function))
2002
2003 ;; Suppress "^M". Shouldn't we specify utf8?
2004 (set-process-coding-system (tramp-get-connection-process vec) 'raw-text-dos)
2005
2006 ;; Set width to 128. This avoids mixing prompt and long error messages.
2007 (tramp-smb-send-command vec "$rawui = (Get-Host).UI.RawUI")
2008 (tramp-smb-send-command vec "$bufsize = $rawui.BufferSize")
2009 (tramp-smb-send-command vec "$winsize = $rawui.WindowSize")
2010 (tramp-smb-send-command vec "$bufsize.Width = 128")
2011 (tramp-smb-send-command vec "$winsize.Width = 128")
2012 (tramp-smb-send-command vec "$rawui.BufferSize = $bufsize")
2013 (tramp-smb-send-command vec "$rawui.WindowSize = $winsize"))
2014
2015 (defun tramp-smb-shell-quote-argument (s)
2016 "Similar to `shell-quote-argument', but uses windows cmd syntax."
2017 (let ((system-type 'ms-dos))
2018 (shell-quote-argument s)))
2019
2020 (add-hook 'tramp-unload-hook
2021 (lambda ()
2022 (unload-feature 'tramp-smb 'force)))
2023
2024 (provide 'tramp-smb)
2025
2026 ;;; TODO:
2027
2028 ;; * Return more comprehensive file permission string.
2029 ;; * Try to remove the inclusion of dummy "" directory. Seems to be at
2030 ;; several places, especially in `tramp-smb-handle-insert-directory'.
2031 ;; * Ignore case in file names.
2032
2033 ;;; tramp-smb.el ends here