tramp-smb.el 73.4 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 <http://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 133 134 135 136
	 "NT_STATUS_ACCESS_DENIED"
	 "NT_STATUS_ACCOUNT_LOCKED_OUT"
	 "NT_STATUS_BAD_NETWORK_NAME"
	 "NT_STATUS_CANNOT_DELETE"
	 "NT_STATUS_CONNECTION_REFUSED"
	 "NT_STATUS_DIRECTORY_NOT_EMPTY"
	 "NT_STATUS_DUPLICATE_NAME"
	 "NT_STATUS_FILE_IS_A_DIRECTORY"
137
	 "NT_STATUS_HOST_UNREACHABLE"
138
	 "NT_STATUS_IMAGE_ALREADY_LOADED"
139
	 "NT_STATUS_INVALID_LEVEL"
140
	 "NT_STATUS_INVALID_PARAMETER_MIX"
141 142 143 144
	 "NT_STATUS_IO_TIMEOUT"
	 "NT_STATUS_LOGON_FAILURE"
	 "NT_STATUS_NETWORK_ACCESS_DENIED"
	 "NT_STATUS_NOT_IMPLEMENTED"
145
	 "NT_STATUS_NO_LOGON_SERVERS"
146 147 148 149 150
	 "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"
151
	 "NT_STATUS_PASSWORD_MUST_CHANGE"
152 153 154 155
	 "NT_STATUS_SHARING_VIOLATION"
	 "NT_STATUS_TRUSTED_RELATIONSHIP_FAILURE"
	 "NT_STATUS_UNSUCCESSFUL"
	 "NT_STATUS_WRONG_PASSWORD")))
156 157 158 159
   "\\|")
  "Regexp for possible error strings of SMB servers.
Used instead of analyzing error codes of commands.")

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

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

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

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

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

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

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

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

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

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

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

339 340
;; File name primitives.

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
(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
357 358 359 360 361 362 363 364 365 366 367
	;; 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)))
368 369 370 371
      ;; 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)
372 373 374 375 376 377 378 379 380 381
      (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
382
	 "error with add-name-to-file, see buffer `%s' for details"
383
	 (buffer-name))))))
384

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

400
(defun tramp-smb-handle-copy-directory
401
  (dirname newname &optional keep-date parents copy-contents)
Michael Albinus's avatar
Michael Albinus committed
402
  "Like `copy-directory' for Tramp files."
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
  (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)
	  (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
425
		    (make-directory tmpdir)
426 427
		    (copy-directory dirname tmpdir keep-date 'parents)
		    (copy-directory
428 429
		     (expand-file-name (file-name-nondirectory dirname) tmpdir)
		     newname keep-date parents))
430
		(delete-directory tmpdir 'recursive))))
431 432

	   ;; We can copy recursively.
433
	   ((and (or t1 t2) (tramp-smb-get-cifs-capabilities v))
434 435 436 437 438 439 440 441 442 443
	    (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))

444
	    ;; Set variables for computing the prompt for reading password.
445 446
	    (setq tramp-current-method method
		  tramp-current-user user
447 448 449
		  tramp-current-domain domain
		  tramp-current-host host
		  tramp-current-port port)
450

451
	    (let* ((share (tramp-smb-get-share v))
452
		   (localname (file-name-as-directory
453
			       (replace-regexp-in-string
454 455 456 457 458
				"\\\\" "/" (tramp-smb-get-localname v))))
		   (tmpdir    (make-temp-name
			       (expand-file-name
				tramp-temp-name-prefix
				(tramp-compat-temporary-file-directory))))
459
		   (args      (list (concat "//" host "/" share) "-E")))
460

461 462
	      (if (not (zerop (length user)))
		  (setq args (append args (list "-U" user)))
463 464 465 466 467 468 469 470 471 472
		(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
473 474
				(list "-D" (tramp-unquote-shell-quote-argument
					    localname)
475 476
				      "-c" (shell-quote-argument "tar qc - *")
				      "|" "tar" "xfC" "-"
477 478
				      (tramp-unquote-shell-quote-argument
				       tmpdir)))
479 480
		      ;; Target is remote.
		      (append (list "tar" "cfC" "-"
481 482
				    (tramp-unquote-shell-quote-argument dirname)
				    "." "|")
483
			      args
484 485
			      (list "-D" (tramp-unquote-shell-quote-argument
					  localname)
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
				    "-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
503 504
			".." (concat tmpdir localname))
		       'parents)
505 506 507 508 509 510
		      (make-symbolic-link
		       newname (directory-file-name (concat tmpdir localname))))

		    ;; Use an asynchronous processes.  By this,
		    ;; password can be handled.
		    (let* ((default-directory tmpdir)
511 512
			   (p (apply
			       'start-process
513 514
			       (tramp-get-connection-name v)
			       (tramp-get-connection-buffer v)
515
			       tramp-smb-program args)))
516 517 518 519

		      (tramp-message
		       v 6 "%s" (mapconcat 'identity (process-command p) " "))
		      (tramp-set-connection-property p "vector" v)
520
		      (process-put p 'adjust-window-size-function 'ignore)
521
		      (set-process-query-on-exit-flag p nil)
522 523
		      (tramp-process-actions p v nil tramp-smb-actions-with-tar)

524
		      (while (process-live-p p)
525 526 527 528 529 530
			(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)
531
		(when t1 (delete-directory tmpdir 'recurse))))
532 533 534

	    ;; Handle KEEP-DATE argument.
	    (when keep-date
535 536 537 538
	      (set-file-times
	       newname
	       (tramp-compat-file-attribute-modification-time
		(file-attributes dirname))))
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

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

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

Michael Albinus's avatar
Michael Albinus committed
568
    (if (file-directory-p filename)
569
	(copy-directory
570
	 filename newname keep-date 'parents 'copy-contents)
Michael Albinus's avatar
Michael Albinus committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

      (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.
	  (when (file-directory-p newname)
	    (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
597
	       v 'file-error "Target `%s' must contain a share name" newname))
Michael Albinus's avatar
Michael Albinus committed
598 599
	    (unless (tramp-smb-send-command
		     v (format "put \"%s\" \"%s\""
600 601
			       (tramp-compat-file-name-unquote filename)
			       (tramp-smb-get-localname v)))
602
	      (tramp-error
603
	       v 'file-error "Cannot copy `%s' to `%s'" filename newname))))))
604

Michael Albinus's avatar
Michael Albinus committed
605 606
    ;; KEEP-DATE handling.
    (when keep-date
607 608 609 610
      (set-file-times
       newname
       (tramp-compat-file-attribute-modification-time
	(file-attributes filename))))))
611

Michael Albinus's avatar
Michael Albinus committed
612
(defun tramp-smb-handle-delete-directory (directory &optional recursive _trash)
613
  "Like `delete-directory' for Tramp files."
614
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
615
  (when (file-exists-p directory)
616 617 618 619 620 621 622 623
    (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)))
624

Michael Albinus's avatar
Michael Albinus committed
625
    (with-parsed-tramp-file-name directory nil
626
      ;; We must also flush the cache of the directory, because
627
      ;; `file-attributes' reads the values from there.
628 629
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-directory-property v localname)
630 631 632 633 634 635 636 637 638 639
      (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
640
	   v 'file-error "%s `%s'" (match-string 0) directory))))))
641

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

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

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

Michael Albinus's avatar
Michael Albinus committed
714
(defun tramp-smb-action-get-acl (proc vec)
715
  "Read ACL data from connection buffer."
716
  (unless (process-live-p proc)
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
    ;; 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))))

732 733 734 735
(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"
736
      (when (executable-find tramp-smb-acl-program)
737
	;; Set variables for computing the prompt for reading password.
738 739
	(setq tramp-current-method method
	      tramp-current-user user
740 741 742
	      tramp-current-domain domain
	      tramp-current-host host
	      tramp-current-port port)
743

744
	(let* ((share     (tramp-smb-get-share v))
745
	       (localname (replace-regexp-in-string
746
			   "\\\\" "/" (tramp-smb-get-localname v)))
747
	       (args      (list (concat "//" host "/" share) "-E")))
748

749 750
	  (if (not (zerop (length user)))
	      (setq args (append args (list "-U" user)))
751 752 753 754 755 756 757 758
	    (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
759 760
	   (append args (list (tramp-unquote-shell-quote-argument localname)
			      "2>/dev/null")))
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

	  (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
780
		  (tramp-set-connection-property p "vector" v)
781
		  (process-put p 'adjust-window-size-function 'ignore)
782
		  (set-process-query-on-exit-flag p nil)
Michael Albinus's avatar
Michael Albinus committed
783
		  (tramp-process-actions p v nil tramp-smb-actions-get-acl)
784
		  (when (> (point-max) (point-min))
785
		    (substring-no-properties (buffer-string)))))
786 787 788 789

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

791
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
792
  "Like `file-attributes' for Tramp files."
793
  (unless id-format (setq id-format 'integer))
794 795
  (ignore-errors
    (with-parsed-tramp-file-name filename nil
796 797
      (with-tramp-file-property
	  v localname (format "file-attributes-%s" id-format)
798
	(if (tramp-smb-get-stat-capability v)
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
	    (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
829

830
(defun tramp-smb-do-file-attributes-with-stat (vec &optional id-format)
831
  "Implement `file-attributes' for Tramp files using stat command."
832 833
  (tramp-message
   vec 5 "file attributes with stat: %s" (tramp-file-name-localname vec))
Michael Albinus's avatar
Michael Albinus committed
834
  (with-current-buffer (tramp-get-connection-buffer vec)
835
    (let* (size id link uid gid atime mtime ctime mode inode)
836 837 838 839 840 841 842 843 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
      (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))
	  ;; Return the result.
	  (list id link uid gid atime mtime ctime size mode nil inode
		(tramp-get-device vec)))))))
894 895

(defun tramp-smb-handle-file-directory-p (filename)
896 897
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
898 899 900
       (eq ?d
	   (aref (tramp-compat-file-attribute-modes (file-attributes filename))
		 0))))
901 902

(defun tramp-smb-handle-file-local-copy (filename)
903
  "Like `file-local-copy' for Tramp files."
904
  (with-parsed-tramp-file-name filename nil
905 906
    (unless (file-exists-p filename)
      (tramp-error
Michael Albinus's avatar
Michael Albinus committed
907
       v tramp-file-missing
908
       "Cannot make local copy of non-existing file `%s'" filename))
909
    (let ((tmpfile (tramp-compat-make-temp-file filename)))
910
      (with-tramp-progress-reporter
911 912 913 914 915
	  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.
916
	  (delete-file tmpfile)
917
	  (tramp-error
918
	   v 'file-error "Cannot make local copy of file `%s'" filename)))
919
      tmpfile)))
920 921 922 923

;; This function should return "foo/" for directories and "bar" for
;; files.
(defun tramp-smb-handle-file-name-all-completions (filename directory)
924 925 926
  "Like `file-name-all-completions' for Tramp files."
  (all-completions
   filename
Michael Albinus's avatar
Michael Albinus committed
927
   (with-parsed-tramp-file-name (expand-file-name directory) nil
928
     (with-tramp-file-property v localname "file-name-all-completions"
929
       (save-match-data
Michael Albinus's avatar
Michael Albinus committed
930 931 932 933 934 935 936 937
	 (delete-dups
	  (mapcar
	   (lambda (x)
	     (list
	      (if (string-match "d" (nth 1 x))
		  (file-name-as-directory (nth 0 x))
		(nth 0 x))))
	   (tramp-smb-get-file-entries directory))))))))
938 939

(defun tramp-smb-handle-file-writable-p (filename)
940 941
  "Like `file-writable-p' for Tramp files."
  (if (file-exists-p filename)
942 943 944
      (string-match
       "w"
       (or (tramp-compat-file-attribute-modes (file-attributes filename)) ""))
945 946 947
    (let ((dir (file-name-directory filename)))
      (and (file-exists-p dir)
	   (file-writable-p dir)))))
948 949 950

(defun tramp-smb-handle-insert-directory
  (filename switches &optional wildcard full-directory-p)
951
  "Like `insert-directory' for Tramp files."
952
  (setq filename (expand-file-name