tramp-smb.el 74.3 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

;;; Commentary:

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

;;; Code:

(require 'tramp)

Michael Albinus's avatar
Michael Albinus committed
32 33 34 35
;; Pacify byte-compiler.
(eval-when-compile
  (require 'cl))

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

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

;; Add a default for `tramp-default-method-alist'. Rule: If there is
;; a domain in USER, it must be the SMB method.
58
;;;###tramp-autoload
59
(add-to-list 'tramp-default-method-alist
60
	     `(nil ,tramp-prefix-domain-regexp ,tramp-smb-method))
61 62 63

;; Add a default for `tramp-default-user-alist'. Rule: For the SMB method,
;; the anonymous user is chosen.
64
;;;###tramp-autoload
65
(add-to-list 'tramp-default-user-alist
66
	     `(,(concat "\\`" tramp-smb-method "\\'") nil nil))
67 68

;; Add completion function for SMB method.
69 70 71 72 73
;;;###tramp-autoload
(eval-after-load 'tramp
  '(tramp-set-completion-function
    tramp-smb-method
    '((tramp-parse-netrc "~/.netrc"))))
74

75
;;;###tramp-autoload
76
(defcustom tramp-smb-program "smbclient"
77
  "Name of SMB client to run."
78
  :group 'tramp
79 80
  :type 'string
  :require 'tramp)
81

82
;;;###tramp-autoload
83 84 85 86
(defcustom tramp-smb-acl-program "smbcacls"
  "Name of SMB acls to run."
  :group 'tramp
  :type 'string
87 88
  :version "24.4"
  :require 'tramp)
89

90
;;;###tramp-autoload
91
(defcustom tramp-smb-conf "/dev/null"
92
  "Path of the smb.conf file.
93 94 95
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
96 97
  :type '(choice (const nil) (file :must-match t))
  :require 'tramp)
98

99
(defvar tramp-smb-version nil
100
  "Version string of the SMB client.")
101

Michael Albinus's avatar
Michael Albinus committed
102 103 104 105 106 107 108 109 110 111 112 113
(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.")
114 115 116 117

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

169 170 171 172 173 174 175 176 177 178
(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.")
179

180 181 182 183 184 185 186
(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.
187

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

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

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

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

316
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
317 318 319 320 321
(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
322 323
  :version "24.3"
  :require 'tramp)
Michael Albinus's avatar
Michael Albinus committed
324

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

333
;;;###tramp-autoload
334 335 336 337 338 339
(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
340
	(save-match-data (apply (cdr fn) args))
341 342
      (tramp-run-real-handler operation args))))

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

348 349
;; File name primitives.

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
(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))
      (when (and (not ok-if-already-exists)
		 (file-exists-p newname)
		 (not (numberp ok-if-already-exists))
		 (y-or-n-p
		  (format
		   "File %s already exists; make it a new name anyway? "
		   newname)))
	(tramp-error
	 v2 'file-error
	 "add-name-to-file: file %s already exists" newname))
      ;; 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)
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 (tramp-compat-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 423 424 425 426 427 428 429 430 431 432
  (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
433
		    (make-directory tmpdir)
434 435
		    (copy-directory dirname tmpdir keep-date 'parents)
		    (copy-directory
436 437
		     (expand-file-name (file-name-nondirectory dirname) tmpdir)
		     newname keep-date parents))
438
		(delete-directory tmpdir 'recursive))))
439 440

	   ;; We can copy recursively.
441
	   ((and (or t1 t2) (tramp-smb-get-cifs-capabilities v))
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
	    (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))

	    (setq tramp-current-method (tramp-file-name-method v)
		  tramp-current-user (tramp-file-name-user v)
		  tramp-current-host (tramp-file-name-real-host v))

	    (let* ((real-user (tramp-file-name-real-user v))
		   (real-host (tramp-file-name-real-host v))
		   (domain    (tramp-file-name-domain v))
		   (port      (tramp-file-name-port v))
		   (share     (tramp-smb-get-share v))
		   (localname (file-name-as-directory
462
			       (replace-regexp-in-string
463 464 465 466 467
				"\\\\" "/" (tramp-smb-get-localname v))))
		   (tmpdir    (make-temp-name
			       (expand-file-name
				tramp-temp-name-prefix
				(tramp-compat-temporary-file-directory))))
468
		   (args      (list (concat "//" real-host "/" share) "-E")))
469 470 471 472 473 474 475 476 477 478 479 480 481

	      (if (not (zerop (length real-user)))
		  (setq args (append args (list "-U" real-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
		    (if t1
			;; Source is remote.
			(append args
482 483
				(list "-D" (tramp-unquote-shell-quote-argument
					    localname)
484 485
				      "-c" (shell-quote-argument "tar qc - *")
				      "|" "tar" "xfC" "-"
486 487
				      (tramp-unquote-shell-quote-argument
				       tmpdir)))
488 489
		      ;; Target is remote.
		      (append (list "tar" "cfC" "-"
490 491
				    (tramp-unquote-shell-quote-argument dirname)
				    "." "|")
492
			      args
493 494
			      (list "-D" (tramp-unquote-shell-quote-argument
					  localname)
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
				    "-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
512 513
			".." (concat tmpdir localname))
		       'parents)
514 515 516 517 518 519
		      (make-symbolic-link
		       newname (directory-file-name (concat tmpdir localname))))

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

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

533
		      (while (tramp-compat-process-live-p p)
534 535 536 537 538 539
			(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)
540
		(when t1 (delete-directory tmpdir 'recurse))))
541 542 543

	    ;; Handle KEEP-DATE argument.
	    (when keep-date
544 545 546 547
	      (set-file-times
	       newname
	       (tramp-compat-file-attribute-modification-time
		(file-attributes dirname))))
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

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

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

Michael Albinus's avatar
Michael Albinus committed
577
    (if (file-directory-p filename)
578 579
	(tramp-compat-copy-directory
	 filename newname keep-date 'parents 'copy-contents)
Michael Albinus's avatar
Michael Albinus committed
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

      (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
606
	       v 'file-error "Target `%s' must contain a share name" newname))
Michael Albinus's avatar
Michael Albinus committed
607 608
	    (unless (tramp-smb-send-command
		     v (format "put \"%s\" \"%s\""
609 610
			       (tramp-compat-file-name-unquote filename)
			       (tramp-smb-get-localname v)))
611
	      (tramp-error
612
	       v 'file-error "Cannot copy `%s' to `%s'" filename newname))))))
613

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

Michael Albinus's avatar
Michael Albinus committed
621
(defun tramp-smb-handle-delete-directory (directory &optional recursive _trash)
622
  "Like `delete-directory' for Tramp files."
623
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
624
  (when (file-exists-p directory)
625 626 627 628 629 630 631 632
    (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)))
633

Michael Albinus's avatar
Michael Albinus committed
634
    (with-parsed-tramp-file-name directory nil
635
      ;; We must also flush the cache of the directory, because
636
      ;; `file-attributes' reads the values from there.
637 638
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-directory-property v localname)
639 640 641 642 643 644 645 646 647 648
      (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
649
	   v 'file-error "%s `%s'" (match-string 0) directory))))))
650

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

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

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

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

741 742 743 744
(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"
745 746 747 748 749 750 751 752 753 754 755
      (when (executable-find tramp-smb-acl-program)

	(setq tramp-current-method (tramp-file-name-method v)
	      tramp-current-user (tramp-file-name-user v)
	      tramp-current-host (tramp-file-name-real-host v))

	(let* ((real-user (tramp-file-name-real-user v))
	       (real-host (tramp-file-name-real-host v))
	       (domain    (tramp-file-name-domain v))
	       (port      (tramp-file-name-port v))
	       (share     (tramp-smb-get-share v))
756
	       (localname (replace-regexp-in-string
757 758 759 760 761 762 763 764 765 766 767 768 769
			   "\\\\" "/" (tramp-smb-get-localname v)))
	       (args      (list (concat "//" real-host "/" share) "-E")))

	  (if (not (zerop (length real-user)))
	      (setq args (append args (list "-U" real-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
770 771
	   (append args (list (tramp-unquote-shell-quote-argument localname)
			      "2>/dev/null")))
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790

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

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

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

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

(defun tramp-smb-handle-file-directory-p (filename)
907 908
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
909 910 911
       (eq ?d
	   (aref (tramp-compat-file-attribute-modes (file-attributes filename))
		 0))))
912 913

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

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

(defun tramp-smb-handle-file-writable-p (filename)
951 952
  "Like `file-writable-p' for Tramp files."
  (if (file-exists-p filename)
953 954 955
      (string-match
       "w"
       (or (tramp-compat-file-attribute-modes (file-attributes filename)) ""))
956 957 958
    (let ((dir (file-name-directory filename)))
      (and (file-exists-p dir)
	   (file-writable-p dir)))))
959 960 961

(defun tramp-smb-handle-insert-directory
  (filename switches &optional wildcard full-directory-p)
962
  "Like `insert-directory' for Tramp files."
963
  (setq filename (expand-file-name filename))
964
  (unless switches (setq switches ""))
965 966 967 968
  ;; Mark trailing "/".
  (when (and (zerop (length (file-name-nondirectory filename)))
	     (not full-directory-p))
    (setq switches (concat switches "F")))
969 970 971 972
  (if full-directory-p
      ;; Called from `dired-add-entry'.
      (setq filename (file-name-as-directory filename))
    (setq filename (directory-file-name filename)))
Michael Albinus's avatar
Michael Albinus committed
973
  (with-parsed-tramp-file-name filename nil
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003