tramp-smb.el 76.9 KB
Newer Older
Michael Albinus's avatar
Michael Albinus committed
1
;;; tramp-smb.el --- Tramp access functions for SMB servers  -*- lexical-binding:t -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2002-2018 Free Software Foundation, Inc.
4

Michael Albinus's avatar
Michael Albinus committed
5
;; Author: Michael Albinus <michael.albinus@gmx.de>
6
;; Keywords: comm, processes
7
;; Package: tramp
8 9 10

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
23 24 25 26 27 28 29

;;; Commentary:

;; Access functions for SMB servers like SAMBA or M$ Windows from Tramp.

;;; Code:

30
(eval-when-compile (require 'cl-lib))
31 32 33
(require 'tramp)

;; Define SMB method ...
34 35
;;;###tramp-autoload
(defconst tramp-smb-method "smb"
36
  "Method to connect SAMBA and M$ SMB servers.")
37 38

;; ... and add it to the method list.
39 40
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
41 42 43 44 45
  (add-to-list 'tramp-methods
    `(,tramp-smb-method
      ;; We define an empty command, because `tramp-smb-call-winexe'
      ;; opens already the powershell.  Used in `tramp-handle-shell-command'.
      (tramp-remote-shell "")
Michael Albinus's avatar
Michael Albinus committed
46
      ;; This is just a guess.  We don't know whether the share "C$"
47 48
      ;; is available for public use, and whether the user has write
      ;; access.
49 50 51
      (tramp-tmpdir "/C$/Temp")
      ;; Another guess.  We might implement a better check later on.
      (tramp-case-insensitive t))))
52

53 54
;; Add a default for `tramp-default-user-alist'. Rule: For the SMB method,
;; the anonymous user is chosen.
55
;;;###tramp-autoload
56
(add-to-list 'tramp-default-user-alist
57
	     `(,(concat "\\`" tramp-smb-method "\\'") nil nil))
58 59

;; Add completion function for SMB method.
60 61 62 63 64
;;;###tramp-autoload
(eval-after-load 'tramp
  '(tramp-set-completion-function
    tramp-smb-method
    '((tramp-parse-netrc "~/.netrc"))))
65

66
;;;###tramp-autoload
67
(defcustom tramp-smb-program "smbclient"
68
  "Name of SMB client to run."
69
  :group 'tramp
70 71
  :type 'string
  :require 'tramp)
72

73
;;;###tramp-autoload
74 75 76 77
(defcustom tramp-smb-acl-program "smbcacls"
  "Name of SMB acls to run."
  :group 'tramp
  :type 'string
78 79
  :version "24.4"
  :require 'tramp)
80

81
;;;###tramp-autoload
82
(defcustom tramp-smb-conf "/dev/null"
83
  "Path of the smb.conf file.
84 85 86
If it is nil, no smb.conf will be added to the `tramp-smb-program'
call, letting the SMB client use the default one."
  :group 'tramp
87 88
  :type '(choice (const nil) (file :must-match t))
  :require 'tramp)
89

90
(defvar tramp-smb-version nil
91
  "Version string of the SMB client.")
92

Michael Albinus's avatar
Michael Albinus committed
93 94 95 96 97 98 99 100 101 102 103 104
(defconst tramp-smb-server-version
  "Domain=\\[[^]]*\\] OS=\\[[^]]*\\] Server=\\[[^]]*\\]"
  "Regexp of SMB server identification.")

(defconst tramp-smb-prompt "^\\(smb:\\|PS\\) .+> \\|^\\s-+Server\\s-+Comment$"
  "Regexp used as prompt in smbclient or powershell.")

(defconst tramp-smb-wrong-passwd-regexp
  (regexp-opt
   '("NT_STATUS_LOGON_FAILURE"
     "NT_STATUS_WRONG_PASSWORD"))
  "Regexp for login error strings of SMB servers.")
105 106 107 108

(defconst tramp-smb-errors
  (mapconcat
   'identity
109 110
   `(;; Connection error / timeout / unknown command.
     "Connection\\( to \\S-+\\)? failed"
111
     "Read from server failed, maybe it closed the connection"
112
     "Call timed out: server did not respond"
113
     "\\S-+: command not found"
114
     "Server doesn't support UNIX CIFS calls"
115 116 117 118 119 120 121 122 123 124 125
     ,(regexp-opt
       '(;; Samba.
	 "ERRDOS"
	 "ERRHRD"
	 "ERRSRV"
	 "ERRbadfile"
	 "ERRbadpw"
	 "ERRfilexists"
	 "ERRnoaccess"
	 "ERRnomem"
	 "ERRnosuchshare"
126
	 ;; See /usr/include/samba-4.0/core/ntstatus.h.
127
	 ;; Windows 4.0 (Windows NT), Windows 5.0 (Windows 2000),
128
	 ;; Windows 5.1 (Windows XP), Windows 5.2 (Windows Server 2003),
129
	 ;; Windows 6.0 (Windows Vista), Windows 6.1 (Windows 7),
130
	 ;; Windows 6.3 (Windows Server 2012, Windows 10).
131 132 133 134
	 "NT_STATUS_ACCESS_DENIED"
	 "NT_STATUS_ACCOUNT_LOCKED_OUT"
	 "NT_STATUS_BAD_NETWORK_NAME"
	 "NT_STATUS_CANNOT_DELETE"
135
	 "NT_STATUS_CONNECTION_DISCONNECTED"
136
	 "NT_STATUS_CONNECTION_REFUSED"
Michael Albinus's avatar
Michael Albinus committed
137
	 "NT_STATUS_CONNECTION_RESET"
138 139 140
	 "NT_STATUS_DIRECTORY_NOT_EMPTY"
	 "NT_STATUS_DUPLICATE_NAME"
	 "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_INVALID_PARAMETER_MIX"
145 146 147 148
	 "NT_STATUS_IO_TIMEOUT"
	 "NT_STATUS_LOGON_FAILURE"
	 "NT_STATUS_NETWORK_ACCESS_DENIED"
	 "NT_STATUS_NOT_IMPLEMENTED"
149
	 "NT_STATUS_NO_LOGON_SERVERS"
150 151 152 153 154
	 "NT_STATUS_NO_SUCH_FILE"
	 "NT_STATUS_NO_SUCH_USER"
	 "NT_STATUS_OBJECT_NAME_COLLISION"
	 "NT_STATUS_OBJECT_NAME_INVALID"
	 "NT_STATUS_OBJECT_NAME_NOT_FOUND"
155
	 "NT_STATUS_OBJECT_PATH_SYNTAX_BAD"
156
	 "NT_STATUS_PASSWORD_MUST_CHANGE"
157
	 "NT_STATUS_RESOURCE_NAME_NOT_FOUND"
158
	 "NT_STATUS_REVISION_MISMATCH"
159 160 161 162
	 "NT_STATUS_SHARING_VIOLATION"
	 "NT_STATUS_TRUSTED_RELATIONSHIP_FAILURE"
	 "NT_STATUS_UNSUCCESSFUL"
	 "NT_STATUS_WRONG_PASSWORD")))
163 164 165 166
   "\\|")
  "Regexp for possible error strings of SMB servers.
Used instead of analyzing error codes of commands.")

167 168 169 170 171 172 173 174 175 176
(defconst tramp-smb-actions-with-share
  '((tramp-smb-prompt tramp-action-succeed)
    (tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (tramp-smb-errors tramp-action-permission-denied)
    (tramp-process-alive-regexp tramp-action-process-alive))
  "List of pattern/action pairs.
This list is used for login to SMB servers.

See `tramp-actions-before-shell' for more info.")
177

178 179 180 181 182 183 184
(defconst tramp-smb-actions-without-share
  '((tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (tramp-smb-errors tramp-action-permission-denied)
    (tramp-process-alive-regexp tramp-action-out-of-band))
  "List of pattern/action pairs.
This list is used for login to SMB servers.
185

186
See `tramp-actions-before-shell' for more info.")
187

Michael Albinus's avatar
Michael Albinus committed
188 189 190 191 192 193 194 195 196 197
(defconst tramp-smb-actions-with-tar
  '((tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (tramp-smb-errors tramp-action-permission-denied)
    (tramp-process-alive-regexp tramp-smb-action-with-tar))
  "List of pattern/action pairs.
This list is used for tar-like copy of directories.

See `tramp-actions-before-shell' for more info.")

Michael Albinus's avatar
Michael Albinus committed
198
(defconst tramp-smb-actions-get-acl
199 200 201
  '((tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (tramp-smb-errors tramp-action-permission-denied)
Michael Albinus's avatar
Michael Albinus committed
202 203 204 205 206 207 208 209 210 211 212
    (tramp-process-alive-regexp tramp-smb-action-get-acl))
  "List of pattern/action pairs.
This list is used for smbcacls actions.

See `tramp-actions-before-shell' for more info.")

(defconst tramp-smb-actions-set-acl
  '((tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (tramp-smb-errors tramp-action-permission-denied)
    (tramp-process-alive-regexp tramp-smb-action-set-acl))
213 214 215 216 217
  "List of pattern/action pairs.
This list is used for smbcacls actions.

See `tramp-actions-before-shell' for more info.")

218
;; New handlers should be added here.
Michael Albinus's avatar
Michael Albinus committed
219
;;;###tramp-autoload
220
(defconst tramp-smb-file-name-handler-alist
Michael Albinus's avatar
Michael Albinus committed
221
  '(;; `access-file' performed by default handler.
222
    (add-name-to-file . tramp-smb-handle-add-name-to-file)
223 224
    ;; `byte-compiler-base-file-name' performed by default handler.
    (copy-directory . tramp-smb-handle-copy-directory)
225 226 227
    (copy-file . tramp-smb-handle-copy-file)
    (delete-directory . tramp-smb-handle-delete-directory)
    (delete-file . tramp-smb-handle-delete-file)
228
    ;; `diff-latest-backup-file' performed by default handler.
229
    (directory-file-name . tramp-handle-directory-file-name)
230
    (directory-files . tramp-smb-handle-directory-files)
231
    (directory-files-and-attributes
232
     . tramp-handle-directory-files-and-attributes)
233
    (dired-compress-file . ignore)
234
    (dired-uncache . tramp-handle-dired-uncache)
235
    (expand-file-name . tramp-smb-handle-expand-file-name)
Michael Albinus's avatar
Michael Albinus committed
236
    (file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
237
    (file-acl . tramp-smb-handle-file-acl)
238
    (file-attributes . tramp-smb-handle-file-attributes)
Michael Albinus's avatar
Michael Albinus committed
239
    (file-directory-p .  tramp-handle-file-directory-p)
240
    (file-file-equal-p . tramp-handle-file-equal-p)
241 242
    (file-executable-p . tramp-handle-file-exists-p)
    (file-exists-p . tramp-handle-file-exists-p)
243
    (file-in-directory-p . tramp-handle-file-in-directory-p)
244 245 246
    (file-local-copy . tramp-smb-handle-file-local-copy)
    (file-modes . tramp-handle-file-modes)
    (file-name-all-completions . tramp-smb-handle-file-name-all-completions)
247
    (file-name-as-directory . tramp-handle-file-name-as-directory)
248
    (file-name-case-insensitive-p . tramp-handle-file-name-case-insensitive-p)
249 250 251
    (file-name-completion . tramp-handle-file-name-completion)
    (file-name-directory . tramp-handle-file-name-directory)
    (file-name-nondirectory . tramp-handle-file-name-nondirectory)
252
    ;; `file-name-sans-versions' performed by default handler.
253
    (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
254
    (file-notify-add-watch . tramp-handle-file-notify-add-watch)
Michael Albinus's avatar
Michael Albinus committed
255
    (file-notify-rm-watch . tramp-handle-file-notify-rm-watch)
256
    (file-notify-valid-p . tramp-handle-file-notify-valid-p)
257
    (file-ownership-preserved-p . ignore)
258
    (file-readable-p . tramp-handle-file-exists-p)
259
    (file-regular-p . tramp-handle-file-regular-p)
Michael Albinus's avatar
Michael Albinus committed
260
    (file-remote-p . tramp-handle-file-remote-p)
Michael Albinus's avatar
Michael Albinus committed
261
    (file-selinux-context . tramp-handle-file-selinux-context)
262
    (file-symlink-p . tramp-handle-file-symlink-p)
263
    (file-system-info . tramp-smb-handle-file-system-info)
264
    (file-truename . tramp-handle-file-truename)
265
    (file-writable-p . tramp-smb-handle-file-writable-p)
266
    (find-backup-file-name . tramp-handle-find-backup-file-name)
267 268
    ;; `find-file-noselect' performed by default handler.
    ;; `get-file-buffer' performed by default handler.
269 270 271
    (insert-directory . tramp-smb-handle-insert-directory)
    (insert-file-contents . tramp-handle-insert-file-contents)
    (load . tramp-handle-load)
272
    (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
273 274
    (make-directory . tramp-smb-handle-make-directory)
    (make-directory-internal . tramp-smb-handle-make-directory-internal)
275
    (make-nearby-temp-file . tramp-handle-make-nearby-temp-file)
276
    (make-symbolic-link . tramp-smb-handle-make-symbolic-link)
Michael Albinus's avatar
Michael Albinus committed
277
    (process-file . tramp-smb-handle-process-file)
278
    (rename-file . tramp-smb-handle-rename-file)
279
    (set-file-acl . tramp-smb-handle-set-file-acl)
280
    (set-file-modes . tramp-smb-handle-set-file-modes)
281
    (set-file-selinux-context . ignore)
282
    (set-file-times . ignore)
Michael Albinus's avatar
Michael Albinus committed
283
    (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
Michael Albinus's avatar
Michael Albinus committed
284 285
    (shell-command . tramp-handle-shell-command)
    (start-file-process . tramp-smb-handle-start-file-process)
Michael Albinus's avatar
Michael Albinus committed
286
    (substitute-in-file-name . tramp-smb-handle-substitute-in-file-name)
287
    (temporary-file-directory . tramp-handle-temporary-file-directory)
288
    (unhandled-file-name-directory . ignore)
289
    (vc-registered . ignore)
Michael Albinus's avatar
Michael Albinus committed
290 291
    (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime)
    (write-region . tramp-smb-handle-write-region))
292 293 294
  "Alist of handler functions for Tramp SMB method.
Operations not mentioned here will be handled by the default Emacs primitives.")

Michael Albinus's avatar
Michael Albinus committed
295
;; Options for remote processes via winexe.
296
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
297 298 299 300 301 302
(defcustom tramp-smb-winexe-program "winexe"
  "Name of winexe client to run.
If it isn't found in the local $PATH, the absolute path of winexe
shall be given.  This is needed for remote processes."
  :group 'tramp
  :type 'string
303 304
  :version "24.3"
  :require 'tramp)
Michael Albinus's avatar
Michael Albinus committed
305

306
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
307 308 309 310 311
(defcustom tramp-smb-winexe-shell-command "powershell.exe"
  "Shell to be used for processes on remote machines.
This must be Powershell V2 compatible."
  :group 'tramp
  :type 'string
312 313
  :version "24.3"
  :require 'tramp)
Michael Albinus's avatar
Michael Albinus committed
314

315
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
316 317 318 319 320
(defcustom tramp-smb-winexe-shell-command-switch "-file -"
  "Command switch used together with `tramp-smb-winexe-shell-command'.
This can be used to disable echo etc."
  :group 'tramp
  :type 'string
321 322
  :version "24.3"
  :require 'tramp)
Michael Albinus's avatar
Michael Albinus committed
323

324 325
;; It must be a `defsubst' in order to push the whole code into
;; tramp-loaddefs.el.  Otherwise, there would be recursive autoloading.
326 327
;;;###tramp-autoload
(defsubst tramp-smb-file-name-p (filename)
328
  "Check if it's a filename for SMB servers."
Michael Albinus's avatar
Michael Albinus committed
329 330
  (string= (tramp-file-name-method (tramp-dissect-file-name filename))
	   tramp-smb-method))
331

332
;;;###tramp-autoload
333 334 335 336 337 338
(defun tramp-smb-file-name-handler (operation &rest args)
  "Invoke the SMB related OPERATION.
First arg specifies the OPERATION, second arg is a list of arguments to
pass to the OPERATION."
  (let ((fn (assoc operation tramp-smb-file-name-handler-alist)))
    (if fn
339
	(save-match-data (apply (cdr fn) args))
340 341
      (tramp-run-real-handler operation args))))

342 343
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
Michael Albinus's avatar
Michael Albinus committed
344 345
  (tramp-register-foreign-file-name-handler
   'tramp-smb-file-name-p 'tramp-smb-file-name-handler))
346

347 348
;; File name primitives.

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
(defun tramp-smb-handle-add-name-to-file
  (filename newname &optional ok-if-already-exists)
  "Like `add-name-to-file' for Tramp files."
  (unless (tramp-equal-remote filename newname)
    (with-parsed-tramp-file-name
	(if (tramp-tramp-file-p filename) filename newname) nil
      (tramp-error
       v 'file-error
       "add-name-to-file: %s"
       "only implemented for same method, same user, same host")))
  (with-parsed-tramp-file-name filename v1
    (with-parsed-tramp-file-name newname v2
      (when (file-directory-p filename)
	(tramp-error
	 v2 'file-error
	 "add-name-to-file: %s must not be a directory" filename))
Michael Albinus's avatar
Michael Albinus committed
365 366 367 368 369 370 371 372 373 374 375
	;; Do the 'confirm if exists' thing.
	(when (file-exists-p newname)
	  ;; What to do?
	  (if (or (null ok-if-already-exists) ; not allowed to exist
		  (and (numberp ok-if-already-exists)
		       (not (yes-or-no-p
			     (format
			      "File %s already exists; make it a link anyway? "
			      v2-localname)))))
	      (tramp-error v2 'file-already-exists newname)
	    (delete-file newname)))
376 377
      ;; We must also flush the cache of the directory, because
      ;; `file-attributes' reads the values from there.
378 379
      (tramp-flush-file-properties v2 (file-name-directory v2-localname))
      (tramp-flush-file-properties v2 v2-localname)
380 381 382 383 384 385 386 387 388 389
      (unless
	  (tramp-smb-send-command
	   v1
	   (format
	    "%s \"%s\" \"%s\""
	    (if (tramp-smb-get-cifs-capabilities v1) "link" "hardlink")
	    (tramp-smb-get-localname v1)
	    (tramp-smb-get-localname v2)))
	(tramp-error
	 v2 'file-error
390
	 "error with add-name-to-file, see buffer `%s' for details"
391
	 (buffer-name))))))
392

Michael Albinus's avatar
Michael Albinus committed
393 394
(defun tramp-smb-action-with-tar (proc vec)
  "Untar from connection buffer."
395
  (if (not (process-live-p proc))
Michael Albinus's avatar
Michael Albinus committed
396 397 398 399 400 401 402 403 404 405 406 407
      (throw 'tramp-action 'process-died)

    (with-current-buffer (tramp-get-connection-buffer vec)
      (goto-char (point-min))
      (when (search-forward-regexp tramp-smb-server-version nil t)
	;; There might be a hidden password prompt.
	(widen)
	(forward-line)
	(tramp-message vec 6 (buffer-substring (point-min) (point)))
	(delete-region (point-min) (point))
	(throw 'tramp-action 'ok)))))

408
(defun tramp-smb-handle-copy-directory
409
  (dirname newname &optional keep-date parents copy-contents)
Michael Albinus's avatar
Michael Albinus committed
410
  "Like `copy-directory' for Tramp files."
411 412 413 414 415 416 417 418 419 420 421 422
  (if copy-contents
      ;; We must do it file-wise.
      (tramp-run-real-handler
       'copy-directory (list dirname newname keep-date parents copy-contents))

    (setq dirname (expand-file-name dirname)
	  newname (expand-file-name newname))
    (let ((t1 (tramp-tramp-file-p dirname))
	  (t2 (tramp-tramp-file-p newname)))
      (with-parsed-tramp-file-name (if t1 dirname newname) nil
	(with-tramp-progress-reporter
	    v 0 (format "Copying %s to %s" dirname newname)
423
	  (when (and (file-directory-p newname)
424
		     (not (tramp-compat-directory-name-p newname)))
425
	    (tramp-error v 'file-already-exists newname))
426 427 428 429 430 431 432 433 434 435
	  (cond
	   ;; We must use a local temporary directory.
	   ((and t1 t2)
	    (let ((tmpdir
		   (make-temp-name
		    (expand-file-name
		     tramp-temp-name-prefix
		     (tramp-compat-temporary-file-directory)))))
	      (unwind-protect
		  (progn
436
		    (make-directory tmpdir)
437 438
		    (copy-directory
		     dirname (file-name-as-directory tmpdir) keep-date 'parents)
439
		    (copy-directory
440 441
		     (expand-file-name (file-name-nondirectory dirname) tmpdir)
		     newname keep-date parents))
442
		(delete-directory tmpdir 'recursive))))
443 444

	   ;; We can copy recursively.
Michael Albinus's avatar
Michael Albinus committed
445
	   ;; TODO: Does not work reliably.
Michael Albinus's avatar
Michael Albinus committed
446
	   (nil ;(and (or t1 t2) (tramp-smb-get-cifs-capabilities v))
447 448 449 450 451 452 453 454 455 456
	    (when (and (file-directory-p newname)
		       (not (string-equal (file-name-nondirectory dirname)
					  (file-name-nondirectory newname))))
	      (setq newname
		    (expand-file-name
		     (file-name-nondirectory dirname) newname))
	      (if t2 (setq v (tramp-dissect-file-name newname))))
	    (if (not (file-directory-p newname))
		(make-directory newname parents))

457
	    (let* ((share (tramp-smb-get-share v))
458
		   (localname (file-name-as-directory
459
			       (replace-regexp-in-string
460 461 462 463 464
				"\\\\" "/" (tramp-smb-get-localname v))))
		   (tmpdir    (make-temp-name
			       (expand-file-name
				tramp-temp-name-prefix
				(tramp-compat-temporary-file-directory))))
465 466 467
		   (args      (list (concat "//" host "/" share) "-E"))
		   ;; We do not want to run timers.
		   timer-list timer-idle-list)
468

469 470
	      (if (not (zerop (length user)))
		  (setq args (append args (list "-U" user)))
471 472 473 474 475 476 477 478 479 480
		(setq args (append args (list "-N"))))

	      (when domain (setq args (append args (list "-W" domain))))
	      (when port   (setq args (append args (list "-p" port))))
	      (when tramp-smb-conf
		(setq args (append args (list "-s" tramp-smb-conf))))
	      (setq args
		    (if t1
			;; Source is remote.
			(append args
481 482
				(list "-D" (tramp-unquote-shell-quote-argument
					    localname)
483 484
				      "-c" (shell-quote-argument "tar qc - *")
				      "|" "tar" "xfC" "-"
485 486
				      (tramp-unquote-shell-quote-argument
				       tmpdir)))
487 488
		      ;; Target is remote.
		      (append (list "tar" "cfC" "-"
489 490
				    (tramp-unquote-shell-quote-argument dirname)
				    "." "|")
491
			      args
492 493
			      (list "-D" (tramp-unquote-shell-quote-argument
					  localname)
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
				    "-c" (shell-quote-argument "tar qx -")))))

	      (unwind-protect
		  (with-temp-buffer
		    ;; Set the transfer process properties.
		    (tramp-set-connection-property
		     v "process-name" (buffer-name (current-buffer)))
		    (tramp-set-connection-property
		     v "process-buffer" (current-buffer))

		    (when t1
		      ;; The smbclient tar command creates always
		      ;; complete paths.  We must emulate the
		      ;; directory structure, and symlink to the real
		      ;; target.
		      (make-directory
		       (expand-file-name
511 512
			".." (concat tmpdir localname))
		       'parents)
513 514 515 516 517 518
		      (make-symbolic-link
		       newname (directory-file-name (concat tmpdir localname))))

		    ;; Use an asynchronous processes.  By this,
		    ;; password can be handled.
		    (let* ((default-directory tmpdir)
519 520
			   (p (apply
			       'start-process
521 522
			       (tramp-get-connection-name v)
			       (tramp-get-connection-buffer v)
523
			       tramp-smb-program args)))
524 525 526

		      (tramp-message
		       v 6 "%s" (mapconcat 'identity (process-command p) " "))
Michael Albinus's avatar
Michael Albinus committed
527
		      (process-put p 'vector v)
528
		      (process-put p 'adjust-window-size-function 'ignore)
529
		      (set-process-query-on-exit-flag p nil)
530 531
		      (tramp-process-actions p v nil tramp-smb-actions-with-tar)

532
		      (while (process-live-p p)
533 534 535 536
			(sit-for 0.1))
		      (tramp-message v 6 "\n%s" (buffer-string))))

		;; Reset the transfer process properties.
537 538
		(tramp-flush-connection-property v "process-name")
		(tramp-flush-connection-property v "process-buffer")
539
		(when t1 (delete-directory tmpdir 'recursive))))
540 541 542

	    ;; Handle KEEP-DATE argument.
	    (when keep-date
543 544 545 546
	      (set-file-times
	       newname
	       (tramp-compat-file-attribute-modification-time
		(file-attributes dirname))))
547 548 549 550 551 552 553 554

	    ;; Set the mode.
	    (unless keep-date
	      (set-file-modes newname (tramp-default-file-modes dirname)))

	    ;; When newname did exist, we have wrong cached values.
	    (when t2
	      (with-parsed-tramp-file-name newname nil
555 556
		(tramp-flush-file-properties v (file-name-directory localname))
		(tramp-flush-file-properties v localname))))
557 558 559 560 561

	   ;; We must do it file-wise.
	   (t
	    (tramp-run-real-handler
	     'copy-directory (list dirname newname keep-date parents)))))))))
562 563

(defun tramp-smb-handle-copy-file
Michael Albinus's avatar
Michael Albinus committed
564
  (filename newname &optional ok-if-already-exists keep-date
565
   _preserve-uid-gid _preserve-extended-attributes)
566
  "Like `copy-file' for Tramp files.
Michael Albinus's avatar
Michael Albinus committed
567
KEEP-DATE has no effect in case NEWNAME resides on an SMB server.
568
PRESERVE-UID-GID and PRESERVE-EXTENDED-ATTRIBUTES are completely ignored."
569 570
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))
571
  (with-tramp-progress-reporter
Michael Albinus's avatar
Michael Albinus committed
572 573
      (tramp-dissect-file-name
       (if (tramp-tramp-file-p filename) filename newname))
574 575
      0 (format "Copying %s to %s" filename newname)

Michael Albinus's avatar
Michael Albinus committed
576
    (if (file-directory-p filename)
577
	(copy-directory filename newname keep-date 'parents 'copy-contents)
Michael Albinus's avatar
Michael Albinus committed
578 579 580 581 582 583 584 585 586 587 588

      (let ((tmpfile (file-local-copy filename)))
	(if tmpfile
	    ;; Remote filename.
	    (condition-case err
		(rename-file tmpfile newname ok-if-already-exists)
	      ((error quit)
	       (delete-file tmpfile)
	       (signal (car err) (cdr err))))

	  ;; Remote newname.
589
	  (when (and (file-directory-p newname)
590
		     (tramp-compat-directory-name-p newname))
Michael Albinus's avatar
Michael Albinus committed
591 592 593 594 595 596 597 598 599 600
	    (setq newname
		  (expand-file-name (file-name-nondirectory filename) newname)))

	  (with-parsed-tramp-file-name newname nil
	    (when (and (not ok-if-already-exists)
		       (file-exists-p newname))
	      (tramp-error v 'file-already-exists newname))

	    ;; We must also flush the cache of the directory, because
	    ;; `file-attributes' reads the values from there.
601 602
	    (tramp-flush-file-properties v (file-name-directory localname))
	    (tramp-flush-file-properties v localname)
Michael Albinus's avatar
Michael Albinus committed
603 604
	    (unless (tramp-smb-get-share v)
	      (tramp-error
605
	       v 'file-error "Target `%s' must contain a share name" newname))
Michael Albinus's avatar
Michael Albinus committed
606 607
	    (unless (tramp-smb-send-command
		     v (format "put \"%s\" \"%s\""
608 609
			       (tramp-compat-file-name-unquote filename)
			       (tramp-smb-get-localname v)))
610
	      (tramp-error
611
	       v 'file-error "Cannot copy `%s' to `%s'" filename newname))))))
612

Michael Albinus's avatar
Michael Albinus committed
613 614
    ;; KEEP-DATE handling.
    (when keep-date
615 616 617 618
      (set-file-times
       newname
       (tramp-compat-file-attribute-modification-time
	(file-attributes filename))))))
619

Michael Albinus's avatar
Michael Albinus committed
620
(defun tramp-smb-handle-delete-directory (directory &optional recursive _trash)
621
  "Like `delete-directory' for Tramp files."
622
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
623
  (when (file-exists-p directory)
624 625 626 627 628 629 630 631
    (when recursive
      (mapc
       (lambda (file)
	 (if (file-directory-p file)
	     (delete-directory file recursive)
	   (delete-file file)))
       ;; We do not want to delete "." and "..".
       (directory-files directory 'full directory-files-no-dot-files-regexp)))
632

Michael Albinus's avatar
Michael Albinus committed
633
    (with-parsed-tramp-file-name directory nil
634
      ;; We must also flush the cache of the directory, because
635
      ;; `file-attributes' reads the values from there.
636 637
      (tramp-flush-file-properties v (file-name-directory localname))
      (tramp-flush-directory-properties v localname)
638 639 640 641 642 643 644 645 646 647
      (unless (tramp-smb-send-command
	       v (format
		  "%s \"%s\""
		  (if (tramp-smb-get-cifs-capabilities v) "posix_rmdir" "rmdir")
		  (tramp-smb-get-localname v)))
	;; Error.
	(with-current-buffer (tramp-get-connection-buffer v)
	  (goto-char (point-min))
	  (search-forward-regexp tramp-smb-errors nil t)
	  (tramp-error
648 649 650 651 652 653
	   v 'file-error "%s `%s'" (match-string 0) directory)))

      ;; "rmdir" does not report an error.  So we check ourselves.
      (when (file-exists-p directory)
	(tramp-error
	 v 'file-error "`%s' not removed." directory)))))
654

655
(defun tramp-smb-handle-delete-file (filename &optional _trash)
656
  "Like `delete-file' for Tramp files."
657
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
658 659
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
660
      ;; We must also flush the cache of the directory, because
661
      ;; `file-attributes' reads the values from there.
662 663
      (tramp-flush-file-properties v (file-name-directory localname))
      (tramp-flush-file-properties v localname)
664 665 666 667 668 669 670 671 672 673
      (unless (tramp-smb-send-command
	       v (format
		  "%s \"%s\""
		  (if (tramp-smb-get-cifs-capabilities v) "posix_unlink" "rm")
		  (tramp-smb-get-localname v)))
	;; Error.
	(with-current-buffer (tramp-get-connection-buffer v)
	  (goto-char (point-min))
	  (search-forward-regexp tramp-smb-errors nil t)
	  (tramp-error
674
	   v 'file-error "%s `%s'" (match-string 0) filename))))))
675 676 677

(defun tramp-smb-handle-directory-files
  (directory &optional full match nosort)
678 679
  "Like `directory-files' for Tramp files."
  (let ((result (mapcar 'directory-file-name
680
			(file-name-all-completions "" directory))))
681
    ;; Discriminate with regexp.
682 683 684 685 686
    (when match
      (setq result
	    (delete nil
		    (mapcar (lambda (x) (when (string-match match x) x))
			    result))))
687
    ;; Append directory.
688 689 690
    (when full
      (setq result
	    (mapcar
691
	     (lambda (x) (format "%s/%s" directory x))
692
	     result)))
693
    ;; Sort them if necessary.
694
    (unless nosort (setq result (sort result 'string-lessp)))
Michael Albinus's avatar
Michael Albinus committed
695
    result))
696

697 698 699 700 701 702 703 704 705 706 707 708 709
(defun tramp-smb-handle-expand-file-name (name &optional dir)
  "Like `expand-file-name' for Tramp files."
  ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
  (setq dir (or dir default-directory "/"))
  ;; Unless NAME is absolute, concat DIR and NAME.
  (unless (file-name-absolute-p name)
    (setq name (concat (file-name-as-directory dir) name)))
  ;; If NAME is not a Tramp file, run the real handler.
  (if (not (tramp-tramp-file-p name))
      (tramp-run-real-handler 'expand-file-name (list name nil))
    ;; Dissect NAME.
    (with-parsed-tramp-file-name name nil
      ;; Tilde expansion if necessary.  We use the user name as share,
Paul Eggert's avatar
Paul Eggert committed
710
      ;; which is often the case in domains.
711
      (when (string-match "\\`/?~\\([^/]*\\)" localname)
712 713
	(setq localname
	      (replace-match
714
	       (if (zerop (length (match-string 1 localname)))
715
		   user
716
		 (match-string 1 localname))
717
	       nil nil localname)))
718 719 720
      ;; Make the file name absolute.
      (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
	(setq localname (concat "/" localname)))
721 722 723
      ;; No tilde characters in file name, do normal
      ;; `expand-file-name' (this does "/./" and "/../").
      (tramp-make-tramp-file-name
724
       method user domain host port
725 726
       (tramp-run-real-handler 'expand-file-name (list localname))))))

Michael Albinus's avatar
Michael Albinus committed
727
(defun tramp-smb-action-get-acl (proc vec)
728
  "Read ACL data from connection buffer."
729
  (unless (process-live-p proc)
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
    ;; Accept pending output.
    (while (tramp-accept-process-output proc 0.1))
    (with-current-buffer (tramp-get-connection-buffer vec)
      ;; There might be a hidden password prompt.
      (widen)
      (tramp-message vec 10 "\n%s" (buffer-string))
      (goto-char (point-min))
      (while (and (not (eobp)) (not (looking-at "^REVISION:")))
	(forward-line)
	(delete-region (point-min) (point)))
      (while (and (not (eobp)) (looking-at "^.+:.+"))
 	(forward-line))
      (delete-region (point) (point-max))
      (throw 'tramp-action 'ok))))

745 746
(defun tramp-smb-handle-file-acl (filename)
  "Like `file-acl' for Tramp files."
Michael Albinus's avatar
Michael Albinus committed
747 748 749 750 751 752 753
  (ignore-errors
    (with-parsed-tramp-file-name filename nil
      (with-tramp-file-property v localname "file-acl"
	(when (executable-find tramp-smb-acl-program)
	  (let* ((share     (tramp-smb-get-share v))
		 (localname (replace-regexp-in-string
			     "\\\\" "/" (tramp-smb-get-localname v)))
754 755 756
		 (args      (list (concat "//" host "/" share) "-E"))
		 ;; We do not want to run timers.
		 timer-list timer-idle-list)
Michael Albinus's avatar
Michael Albinus committed
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788

	    (if (not (zerop (length user)))
		(setq args (append args (list "-U" user)))
	      (setq args (append args (list "-N"))))

	    (when domain (setq args (append args (list "-W" domain))))
	    (when port   (setq args (append args (list "-p" port))))
	    (when tramp-smb-conf
	      (setq args (append args (list "-s" tramp-smb-conf))))
	    (setq
	     args
	     (append args (list (tramp-unquote-shell-quote-argument localname)
				"2>/dev/null")))

	    (unwind-protect
		(with-temp-buffer
		  ;; Set the transfer process properties.
		  (tramp-set-connection-property
		   v "process-name" (buffer-name (current-buffer)))
		  (tramp-set-connection-property
		   v "process-buffer" (current-buffer))

		  ;; Use an asynchronous process.  By this, password can
		  ;; be handled.
		  (let ((p (apply
			    'start-process
			    (tramp-get-connection-name v)
			    (tramp-get-connection-buffer v)
			    tramp-smb-acl-program args)))

		    (tramp-message
		     v 6 "%s" (mapconcat 'identity (process-command p) " "))
Michael Albinus's avatar
Michael Albinus committed
789
		    (process-put p 'vector v)
Michael Albinus's avatar
Michael Albinus committed
790 791 792 793 794 795 796
		    (process-put p 'adjust-window-size-function 'ignore)
		    (set-process-query-on-exit-flag p nil)
		    (tramp-process-actions p v nil tramp-smb-actions-get-acl)
		    (when (> (point-max) (point-min))
		      (substring-no-properties (buffer-string)))))

	      ;; Reset the transfer process properties.
797 798
	      (tramp-flush-connection-property v "process-name")
	      (tramp-flush-connection-property v "process-buffer"))))))))
799

800
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
801
  "Like `file-attributes' for Tramp files."
802
  (unless id-format (setq id-format 'integer))
803 804
  (ignore-errors
    (with-parsed-tramp-file-name filename nil
805 806
      (with-tramp-file-property
	  v localname (format "file-attributes-%s" id-format)
807
	(if (tramp-smb-get-stat-capability v)
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
	    (tramp-smb-do-file-attributes-with-stat v id-format)
	  ;; Reading just the filename entry via "dir localname" is not
	  ;; possible, because when filename is a directory, some
	  ;; smbclient versions return the content of the directory, and
	  ;; other versions don't.  Therefore, the whole content of the
	  ;; upper directory is retrieved, and the entry of the filename
	  ;; is extracted from.
	  (let* ((entries (tramp-smb-get-file-entries
			   (file-name-directory filename)))
		 (entry (assoc (file-name-nondirectory filename) entries))
		 (uid (if (equal id-format 'string) "nobody" -1))
		 (gid (if (equal id-format 'string) "nogroup" -1))
		 (inode (tramp-get-inode v))
		 (device (tramp-get-device v)))

	    ;; Check result.
	    (when entry
	      (list (and (string-match "d" (nth 1 entry))
			 t)        ;0 file type
		    -1	           ;1 link count
		    uid	           ;2 uid
		    gid	           ;3 gid
		    '(0 0)	   ;4 atime
		    (nth 3 entry)  ;5 mtime
		    '(0 0)	   ;6 ctime
		    (nth 2 entry)  ;7 size
		    (nth 1 entry)  ;8 mode
		    nil	           ;9 gid weird
		    inode	   ;10 inode number
		    device)))))))) ;11 file system number
838

839
(defun tramp-smb-do-file-attributes-with-stat (vec &optional id-format)
840
  "Implement `file-attributes' for Tramp files using stat command."
841 842
  (tramp-message
   vec 5 "file attributes with stat: %s" (tramp-file-name-localname vec))
Michael Albinus's avatar
Michael Albinus committed
843
  (with-current-buffer (tramp-get-connection-buffer vec)
844
    (let* (size id link uid gid atime mtime ctime mode inode)
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
      (when (tramp-smb-send-command
	     vec (format "stat \"%s\"" (tramp-smb-get-localname vec)))

	;; Loop the listing.
	(goto-char (point-min))
	(unless (re-search-forward tramp-smb-errors nil t)
	  (while (not (eobp))
	    (cond
	     ((looking-at
	       "Size:\\s-+\\([0-9]+\\)\\s-+Blocks:\\s-+[0-9]+\\s-+\\(\\w+\\)")
	      (setq size (string-to-number (match-string 1))
		    id (if (string-equal "directory" (match-string 2)) t
			 (if (string-equal "symbolic" (match-string 2)) ""))))
	     ((looking-at
	       "Inode:\\s-+\\([0-9]+\\)\\s-+Links:\\s-+\\([0-9]+\\)")
	      (setq inode (string-to-number (match-string 1))
		    link (string-to-number (match-string 2))))
	     ((looking-at
	       "Access:\\s-+([0-9]+/\\(\\S-+\\))\\s-+Uid:\\s-+\\([0-9]+\\)\\s-+Gid:\\s-+\\([0-9]+\\)")
	      (setq mode (match-string 1)
		    uid (if (equal id-format 'string) (match-string 2)
			  (string-to-number (match-string 2)))
		    gid (if (equal id-format 'string) (match-string 3)
			  (string-to-number (match-string 3)))))
	     ((looking-at
	       "Access:\\s-+\\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\)\\s-+\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)")
	      (setq atime
		    (encode-time
		     (string-to-number (match-string 6)) ;; sec
		     (string-to-number (match-string 5)) ;; min
		     (string-to-number (match-string 4)) ;; hour
		     (string-to-number (match-string 3)) ;; day
		     (string-to-number (match-string 2)) ;; month
		     (string-to-number (match-string 1))))) ;; year
	     ((looking-at
	       "Modify:\\s-+\\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\)\\s-+\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)")
	      (setq mtime
		    (encode-time
		     (string-to-number (match-string 6)) ;; sec
		     (string-to-number (match-string 5)) ;; min
		     (string-to-number (match-string 4)) ;; hour
		     (string-to-number (match-string 3)) ;; day
		     (string-to-number (match-string 2)) ;; month
		     (string-to-number (match-string 1))))) ;; year
	     ((looking-at
	       "Change:\\s-+\\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\)\\s-+\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)")
	      (setq ctime
		    (encode-time
		     (string-to-number (match-string 6)) ;; sec
		     (string-to-number (match-string 5)) ;; min
		     (string-to-number (match-string 4)) ;; hour
		     (string-to-number (match-string 3)) ;; day
		     (string-to-number (match-string 2)) ;; month
		     (string-to-number (match-string 1)))))) ;; year
	    (forward-line))
Michael Albinus's avatar
Michael Albinus committed
900 901 902 903 904 905 906 907 908 909

	  ;; Resolve symlink.
	  (when (and (stringp id)
		     (tramp-smb-send-command
		      vec
		      (format "readlink \"%s\"" (tramp-smb-get-localname vec))))
	    (goto-char (point-min))
	    (and (looking-at ".+ -> \\(.+\\)")
		 (setq id (match-string 1))))

910
	  ;; Return the result.
911 912 913
	  (when (or id link uid gid atime mtime ctime size mode inode)
	    (list id link uid gid atime mtime ctime size mode nil inode
		  (tramp-get-device vec))))))))
914 915

(defun tramp-smb-handle-file-local-copy (filename)
916
  "Like `file-local-copy' for Tramp files."
917 918
  (with-parsed-tramp-file-name (file-truename filename) nil
    (unless (file-exists-p (file-truename filename))
919
      (tramp-error
Michael Albinus's avatar
Michael Albinus committed
920
       v tramp-file-missing
921
       "Cannot make local copy of non-existing file `%s'" filename))
922
    (let ((tmpfile (tramp-compat-make-temp-file filename)))
923
      (with-tramp-progress-reporter
924 925 926 927 928
	  v 3 (format "Fetching %s to tmp file %s" filename tmpfile)
	(unless (tramp-smb-send-command
		 v (format "get \"%s\" \"%s\""
			   (tramp-smb-get-localname v) tmpfile))
	  ;; Oops, an error.  We shall cleanup.
929
	  (delete-file tmpfile)
930
	  (tramp-error
931
	   v 'file-error "Cannot make local copy of file `%s'" filename)))
932
      tmpfile)))
933 934 935 936

;; This function should return "foo/" for directories and "bar" for
;; files.
(defun tramp-smb-handle-file-name-all-completions (filename directory)
937 938 939
  "Like `file-name-all-completions' for Tramp files."
  (all-completions
   filename
Michael Albinus's avatar
Michael Albinus committed
940
   (with-parsed-tramp-file-name (expand-file-name directory) nil
941
     (with-tramp-file-property v localname "file-name-all-completions"
942
       (save-match-data
Michael Albinus's avatar
Michael Albinus committed
943 944 945 946 947