tramp-smb.el 76.7 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-2017 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 30 31 32

;;; Commentary:

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

;;; Code:

(require 'tramp)

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

;; ... and add it to the method list.
38 39
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
40 41 42 43 44
  (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
45
      ;; This is just a guess.  We don't know whether the share "C$"
46 47
      ;; is available for public use, and whether the user has write
      ;; access.
48 49 50
      (tramp-tmpdir "/C$/Temp")
      ;; Another guess.  We might implement a better check later on.
      (tramp-case-insensitive t))))
51

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

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

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

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

80
;;;###tramp-autoload
81
(defcustom tramp-smb-conf "/dev/null"
82
  "Path of the smb.conf file.
83 84 85
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
86 87
  :type '(choice (const nil) (file :must-match t))
  :require 'tramp)
88

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

Michael Albinus's avatar
Michael Albinus committed
92 93 94 95 96 97 98 99 100 101 102 103
(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.")
104 105 106 107

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

162 163 164 165 166 167 168 169 170 171
(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.")
172

173 174 175 176 177 178 179
(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.
180

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

Michael Albinus's avatar
Michael Albinus committed
183 184 185 186 187 188 189 190 191 192
(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
193
(defconst tramp-smb-actions-get-acl
194 195 196
  '((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
197 198 199 200 201 202 203 204 205 206 207
    (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))
208 209 210 211 212
  "List of pattern/action pairs.
This list is used for smbcacls actions.

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

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

301
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
302 303 304 305 306
(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
307 308
  :version "24.3"
  :require 'tramp)
Michael Albinus's avatar
Michael Albinus committed
309

310
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
311 312 313 314 315
(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
316 317
  :version "24.3"
  :require 'tramp)
Michael Albinus's avatar
Michael Albinus committed
318

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

327
;;;###tramp-autoload
328 329 330 331 332 333
(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
334
	(save-match-data (apply (cdr fn) args))
335 336
      (tramp-run-real-handler operation args))))

337 338
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
Michael Albinus's avatar
Michael Albinus committed
339 340
  (tramp-register-foreign-file-name-handler
   'tramp-smb-file-name-p 'tramp-smb-file-name-handler))
341

342 343
;; File name primitives.

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
(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
360 361 362 363 364 365 366 367 368 369 370
	;; 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)))
371 372 373 374
      ;; We must also flush the cache of the directory, because
      ;; `file-attributes' reads the values from there.
      (tramp-flush-file-property v2 (file-name-directory v2-localname))
      (tramp-flush-file-property v2 v2-localname)
375 376 377 378 379 380 381 382 383 384
      (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
385
	 "error with add-name-to-file, see buffer `%s' for details"
386
	 (buffer-name))))))
387

Michael Albinus's avatar
Michael Albinus committed
388 389
(defun tramp-smb-action-with-tar (proc vec)
  "Untar from connection buffer."
390
  (if (not (process-live-p proc))
Michael Albinus's avatar
Michael Albinus committed
391 392 393 394 395 396 397 398 399 400 401 402
      (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)))))

403
(defun tramp-smb-handle-copy-directory
404
  (dirname newname &optional keep-date parents copy-contents)
Michael Albinus's avatar
Michael Albinus committed
405
  "Like `copy-directory' for Tramp files."
406 407 408 409 410 411 412 413 414 415 416 417
  (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)
418
	  (when (and (file-directory-p newname)
419
		     (not (tramp-compat-directory-name-p newname)))
420
	    (tramp-error v 'file-already-exists newname))
421 422 423 424 425 426 427 428 429 430
	  (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
431
		    (make-directory tmpdir)
432 433
		    (copy-directory
		     dirname (file-name-as-directory tmpdir) keep-date 'parents)
434
		    (copy-directory
435 436
		     (expand-file-name (file-name-nondirectory dirname) tmpdir)
		     newname keep-date parents))
437
		(delete-directory tmpdir 'recursive))))
438 439

	   ;; We can copy recursively.
Michael Albinus's avatar
Michael Albinus committed
440
	   ;; TODO: Does not work reliably.
Michael Albinus's avatar
Michael Albinus committed
441
	   (nil ;(and (or t1 t2) (tramp-smb-get-cifs-capabilities v))
442 443 444 445 446 447 448 449 450 451
	    (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))

452
	    ;; Set variables for computing the prompt for reading password.
453 454
	    (setq tramp-current-method method
		  tramp-current-user user
455 456 457
		  tramp-current-domain domain
		  tramp-current-host host
		  tramp-current-port port)
458

459
	    (let* ((share (tramp-smb-get-share v))
460
		   (localname (file-name-as-directory
461
			       (replace-regexp-in-string
462 463 464 465 466
				"\\\\" "/" (tramp-smb-get-localname v))))
		   (tmpdir    (make-temp-name
			       (expand-file-name
				tramp-temp-name-prefix
				(tramp-compat-temporary-file-directory))))
467
		   (args      (list (concat "//" host "/" share) "-E")))
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 527

		      (tramp-message
		       v 6 "%s" (mapconcat 'identity (process-command p) " "))
		      (tramp-set-connection-property 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 537 538
			(sit-for 0.1))
		      (tramp-message v 6 "\n%s" (buffer-string))))

		;; Reset the transfer process properties.
		(tramp-set-connection-property v "process-name" nil)
		(tramp-set-connection-property v "process-buffer" nil)
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 555 556 557 558 559 560 561

	    ;; 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
		(tramp-flush-file-property v (file-name-directory localname))
		(tramp-flush-file-property v localname))))

	   ;; 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 601 602 603 604
	    (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.
	    (tramp-flush-file-property v (file-name-directory localname))
	    (tramp-flush-file-property v localname)
	    (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-property v (file-name-directory localname))
      (tramp-flush-directory-property 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
	   v 'file-error "%s `%s'" (match-string 0) directory))))))
649

650
(defun tramp-smb-handle-delete-file (filename &optional _trash)
651
  "Like `delete-file' for Tramp files."
652
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
653 654
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
655
      ;; We must also flush the cache of the directory, because
656
      ;; `file-attributes' reads the values from there.
657 658
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-file-property v localname)
659 660 661 662 663 664 665 666 667 668
      (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
669
	   v 'file-error "%s `%s'" (match-string 0) filename))))))
670 671 672

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

692 693 694 695 696 697 698 699 700 701 702 703 704
(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
705
      ;; which is often the case in domains.
706
      (when (string-match "\\`/?~\\([^/]*\\)" localname)
707 708
	(setq localname
	      (replace-match
709
	       (if (zerop (length (match-string 1 localname)))
710
		   user
711
		 (match-string 1 localname))
712
	       nil nil localname)))
713 714 715
      ;; Make the file name absolute.
      (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
	(setq localname (concat "/" localname)))
716 717 718
      ;; No tilde characters in file name, do normal
      ;; `expand-file-name' (this does "/./" and "/../").
      (tramp-make-tramp-file-name
719
       method user domain host port
720 721
       (tramp-run-real-handler 'expand-file-name (list localname))))))

Michael Albinus's avatar
Michael Albinus committed
722
(defun tramp-smb-action-get-acl (proc vec)
723
  "Read ACL data from connection buffer."
724
  (unless (process-live-p proc)
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    ;; 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))))

740 741 742 743
(defun tramp-smb-handle-file-acl (filename)
  "Like `file-acl' for Tramp files."
  (with-parsed-tramp-file-name filename nil
    (with-tramp-file-property v localname "file-acl"
744
      (when (executable-find tramp-smb-acl-program)
745
	;; Set variables for computing the prompt for reading password.
746 747
	(setq tramp-current-method method
	      tramp-current-user user
748 749 750
	      tramp-current-domain domain
	      tramp-current-host host
	      tramp-current-port port)
751

752
	(let* ((share     (tramp-smb-get-share v))
753
	       (localname (replace-regexp-in-string
754
			   "\\\\" "/" (tramp-smb-get-localname v)))
755
	       (args      (list (concat "//" host "/" share) "-E")))
756

757 758
	  (if (not (zerop (length user)))
	      (setq args (append args (list "-U" user)))
759 760 761 762 763 764 765 766
	    (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
767 768
	   (append args (list (tramp-unquote-shell-quote-argument localname)
			      "2>/dev/null")))
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787

	  (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 processes.  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
788
		  (tramp-set-connection-property p "vector" v)
789
		  (process-put p 'adjust-window-size-function 'ignore)
790
		  (set-process-query-on-exit-flag p nil)
Michael Albinus's avatar
Michael Albinus committed
791
		  (tramp-process-actions p v nil tramp-smb-actions-get-acl)
792
		  (when (> (point-max) (point-min))
793
		    (substring-no-properties (buffer-string)))))
794 795 796 797

	    ;; Reset the transfer process properties.
	    (tramp-set-connection-property v "process-name" nil)
	    (tramp-set-connection-property v "process-buffer" nil)))))))
798

799
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
800
  "Like `file-attributes' for Tramp files."
801
  (unless id-format (setq id-format 'integer))
802 803
  (ignore-errors
    (with-parsed-tramp-file-name filename nil
804 805
      (with-tramp-file-property
	  v localname (format "file-attributes-%s" id-format)
806
	(if (tramp-smb-get-stat-capability v)
807 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
	    (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
837

838
(defun tramp-smb-do-file-attributes-with-stat (vec &optional id-format)
839
  "Implement `file-attributes' for Tramp files using stat command."
840 841
  (tramp-message
   vec 5 "file attributes with stat: %s" (tramp-file-name-localname vec))
Michael Albinus's avatar
Michael Albinus committed
842
  (with-current-buffer (tramp-get-connection-buffer vec)
843
    (let* (size id link uid gid atime mtime ctime mode inode)
844 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
      (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
899 900 901 902 903 904 905 906 907 908

	  ;; 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))))

909
	  ;; Return the result.
910 911 912
	  (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))))))))
913 914

(defun tramp-smb-handle-file-directory-p (filename)
915 916
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
917 918 919
       (eq ?d
	   (aref (tramp-compat-file-attribute-modes (file-attributes filename))
		 0))))
920 921

(defun tramp-smb-handle-file-local-copy (filename)
922
  "Like `file-local-copy' for Tramp files."
923 924
  (with-parsed-tramp-file-name (file-truename filename) nil
    (unless (file-exists-p (file-truename filename))
925
      (tramp-error
Michael Albinus's avatar
Michael Albinus committed
926
       v tramp-file-missing
927
       "Cannot make local copy of non-existing file `%s'" filename))
928
    (let ((tmpfile (tramp-compat-make-temp-file filename)))
929
      (with-tramp-progress-reporter
930 931 932 933 934
	  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.
935
	  (delete-file tmpfile)
936
	  (tramp-error
937
	   v 'file-error "Cannot make local copy of file `%s'" filename)))
938
      tmpfile)))