tramp-smb.el 78.6 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-2021 Free Software Foundation, Inc.
4

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

;; This file is part of GNU Emacs.

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

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

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

;;; Commentary:

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

;;; Code:

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

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

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

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

58 59 60 61
 ;; Add completion function for SMB method.
 (tramp-set-completion-function
  tramp-smb-method
  '((tramp-parse-netrc "~/.netrc"))))
62 63

(defcustom tramp-smb-program "smbclient"
64
  "Name of SMB client to run."
65
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
66
  :type 'string)
67

68 69 70 71
(defcustom tramp-smb-acl-program "smbcacls"
  "Name of SMB acls to run."
  :group 'tramp
  :type 'string
Michael Albinus's avatar
Michael Albinus committed
72
  :version "24.4")
73

74
(defcustom tramp-smb-conf null-device
75 76
  "Path of the \"smb.conf\" file.
If it is nil, no \"smb.conf\" will be added to the `tramp-smb-program'
77 78
call, letting the SMB client use the default one."
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
79
  :type '(choice (const nil) (file :must-match t)))
80

81 82 83 84 85 86 87 88 89 90
(defcustom tramp-smb-options nil
  "List of additional options.
They are added to the `tramp-smb-program' call via \"--option '...'\".

For example, if the deprecated SMB1 protocol shall be used, add to
this variable (\"client min protocol=NT1\") ."
  :group 'tramp
  :type '(repeat string)
  :version "28.1")

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

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

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

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

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

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

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

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

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

(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
Michael Albinus's avatar
Michael Albinus committed
321
  :version "24.3")
Michael Albinus's avatar
Michael Albinus committed
322 323 324 325 326 327

(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
Michael Albinus's avatar
Michael Albinus committed
328
  :version "24.3")
Michael Albinus's avatar
Michael Albinus committed
329

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

339
;;;###tramp-autoload
340
(defun tramp-smb-file-name-handler (operation &rest args)
341
  "Invoke the SMB related OPERATION and ARGS.
Michael Albinus's avatar
Michael Albinus committed
342 343
First arg specifies the OPERATION, second arg is a list of
arguments to pass to the OPERATION."
Michael Albinus's avatar
Michael Albinus committed
344 345 346
  (if-let ((fn (assoc operation tramp-smb-file-name-handler-alist)))
      (save-match-data (apply (cdr fn) args))
    (tramp-run-real-handler operation args)))
347

348 349
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
350 351 352
  (tramp--with-startup
   (tramp-register-foreign-file-name-handler
    #'tramp-smb-file-name-p #'tramp-smb-file-name-handler)))
353

354 355
;; File name primitives.

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
(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))
372 373 374 375 376 377 378 379 380 381 382
      ;; 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)))
383 384
      ;; We must also flush the cache of the directory, because
      ;; `file-attributes' reads the values from there.
385
      (tramp-flush-file-properties v2 v2-localname)
386 387 388 389 390 391 392 393 394 395
      (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
396
	 "error with add-name-to-file, see buffer `%s' for details"
397
	 (buffer-name))))))
398

Michael Albinus's avatar
Michael Albinus committed
399 400
(defun tramp-smb-action-with-tar (proc vec)
  "Untar from connection buffer."
401
  (if (not (process-live-p proc))
Michael Albinus's avatar
Michael Albinus committed
402 403 404 405 406 407 408 409 410 411 412 413
      (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)))))

414
(defun tramp-smb-handle-copy-directory
415
  (dirname newname &optional keep-date parents copy-contents)
Michael Albinus's avatar
Michael Albinus committed
416
  "Like `copy-directory' for Tramp files."
417 418 419
  (if copy-contents
      ;; We must do it file-wise.
      (tramp-run-real-handler
420
       #'copy-directory (list dirname newname keep-date parents copy-contents))
421 422 423 424 425 426 427 428

    (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)
Michael Albinus's avatar
Michael Albinus committed
429
	  (unless (file-exists-p dirname)
Michael Albinus's avatar
Michael Albinus committed
430
	    (tramp-compat-file-missing v dirname))
431
	  (when (and (file-directory-p newname)
Michael Albinus's avatar
Michael Albinus committed
432
		     (not (directory-name-p newname)))
433
	    (tramp-error v 'file-already-exists newname))
434 435 436
	  (cond
	   ;; We must use a local temporary directory.
	   ((and t1 t2)
437
	    (let ((tmpdir (tramp-compat-make-temp-name)))
438 439
	      (unwind-protect
		  (progn
440
		    (make-directory tmpdir)
441 442
		    (copy-directory
		     dirname (file-name-as-directory tmpdir) keep-date 'parents)
443
		    (copy-directory
444 445
		     (expand-file-name (file-name-nondirectory dirname) tmpdir)
		     newname keep-date parents))
446
		(delete-directory tmpdir 'recursive))))
447 448

	   ;; We can copy recursively.
Michael Albinus's avatar
Michael Albinus committed
449
	   ;; TODO: Does not work reliably.
Michael Albinus's avatar
Michael Albinus committed
450
	   (nil ;(and (or t1 t2) (tramp-smb-get-cifs-capabilities v))
451 452 453 454 455 456 457 458 459 460
	    (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))

461
	    (let* ((share (tramp-smb-get-share v))
462
		   (localname (file-name-as-directory
463 464
			       (tramp-compat-string-replace
				"\\" "/" (tramp-smb-get-localname v))))
465
		   (tmpdir    (tramp-compat-make-temp-name))
466 467
		   (args      (list (concat "//" host "/" share) "-E"))
		   (options   tramp-smb-options))
468

469 470
	      (if (not (zerop (length user)))
		  (setq args (append args (list "-U" user)))
471 472 473 474 475 476
		(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))))
477 478 479 480
	      (while options
		(setq args
		      (append args `("--option" ,(format "%s" (car options))))
		      options (cdr options)))
481 482 483 484
	      (setq args
		    (if t1
			;; Source is remote.
			(append args
485 486
				(list "-D" (tramp-unquote-shell-quote-argument
					    localname)
487 488
				      "-c" (tramp-unquote-shell-quote-argument
					    "tar qc - *")
489
				      "|" "tar" "xfC" "-"
490 491
				      (tramp-unquote-shell-quote-argument
				       tmpdir)))
492 493
		      ;; Target is remote.
		      (append (list "tar" "cfC" "-"
494 495
				    (tramp-unquote-shell-quote-argument dirname)
				    "." "|")
496
			      args
497 498
			      (list "-D" (tramp-unquote-shell-quote-argument
					  localname)
499 500
				    "-c" (tramp-unquote-shell-quote-argument
					  "tar qx -")))))
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516

	      (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
517 518
			".." (concat tmpdir localname))
		       'parents)
519 520 521 522 523 524
		      (make-symbolic-link
		       newname (directory-file-name (concat tmpdir localname))))

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

		      (tramp-message
Michael Albinus's avatar
Michael Albinus committed
532
		       v 6 "%s" (string-join (process-command p) " "))
Michael Albinus's avatar
Michael Albinus committed
533
		      (process-put p 'vector v)
534
		      (process-put p 'adjust-window-size-function #'ignore)
535
		      (set-process-query-on-exit-flag p nil)
536 537
		      (tramp-process-actions p v nil tramp-smb-actions-with-tar)

538
		      (while (process-live-p p)
539
			(sleep-for 0.1))
540 541 542
		      (tramp-message v 6 "\n%s" (buffer-string))))

		;; Reset the transfer process properties.
543 544
		(tramp-flush-connection-property v "process-name")
		(tramp-flush-connection-property v "process-buffer")
545
		(when t1 (delete-directory tmpdir 'recursive))))
546 547 548

	    ;; Handle KEEP-DATE argument.
	    (when keep-date
549
	      (tramp-compat-set-file-times
550 551
	       newname
	       (tramp-compat-file-attribute-modification-time
552 553
		(file-attributes dirname))
	       (unless ok-if-already-exists 'nofollow)))
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
562
		(tramp-flush-file-properties v localname))))
563 564 565 566

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

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

Michael Albinus's avatar
Michael Albinus committed
582
    (if (file-directory-p filename)
583
	(copy-directory filename newname keep-date 'parents 'copy-contents)
Michael Albinus's avatar
Michael Albinus committed
584

Michael Albinus's avatar
Michael Albinus committed
585
      (unless (file-exists-p filename)
Michael Albinus's avatar
Michael Albinus committed
586
	(tramp-compat-file-missing
Michael Albinus's avatar
Michael Albinus committed
587 588
	 (tramp-dissect-file-name
	  (if (tramp-tramp-file-p filename) filename newname))
Michael Albinus's avatar
Michael Albinus committed
589
	 filename))
Michael Albinus's avatar
Michael Albinus committed
590

Michael Albinus's avatar
Michael Albinus committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
      (if-let ((tmpfile (file-local-copy filename)))
	  ;; 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 (and (file-directory-p newname)
		   (directory-name-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))
608
	  (when (and (file-directory-p newname)
Michael Albinus's avatar
Michael Albinus committed
609 610
		     (not (directory-name-p newname)))
	    (tramp-error v 'file-error "File is a directory %s" newname))
Michael Albinus's avatar
Michael Albinus committed
611

Michael Albinus's avatar
Michael Albinus committed
612 613 614 615 616 617 618 619 620 621 622 623
	  ;; We must also flush the cache of the directory, because
	  ;; `file-attributes' reads the values from there.
	  (tramp-flush-file-properties v localname)
	  (unless (tramp-smb-get-share v)
	    (tramp-error
	     v 'file-error "Target `%s' must contain a share name" newname))
	  (unless (tramp-smb-send-command
		   v (format "put \"%s\" \"%s\""
			     (tramp-compat-file-name-unquote filename)
			     (tramp-smb-get-localname v)))
	    (tramp-error
	     v 'file-error "Cannot copy `%s' to `%s'" filename newname)))))
624

Michael Albinus's avatar
Michael Albinus committed
625 626
    ;; KEEP-DATE handling.
    (when keep-date
627
      (tramp-compat-set-file-times
628 629
       newname
       (tramp-compat-file-attribute-modification-time
630 631
	(file-attributes filename))
       (unless ok-if-already-exists 'nofollow)))))
632

633
(defun tramp-smb-handle-delete-directory (directory &optional recursive trash)
634
  "Like `delete-directory' for Tramp files."
635 636 637 638 639 640 641 642 643 644 645
  (tramp-skeleton-delete-directory directory recursive trash
    (when (file-exists-p directory)
      (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)))

646
      ;; We must also flush the cache of the directory, because
647
      ;; `file-attributes' reads the values from there.
648
      (tramp-flush-directory-properties v localname)
649 650 651
      (unless (tramp-smb-send-command
	       v (format
		  "%s \"%s\""
652 653
		  (if (tramp-smb-get-cifs-capabilities v)
		      "posix_rmdir" "rmdir")
654 655 656 657 658
		  (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)
659
	  (tramp-error v 'file-error "%s `%s'" (match-string 0) directory)))
660 661 662

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

665
(defun tramp-smb-handle-delete-file (filename &optional trash)
666
  "Like `delete-file' for Tramp files."
667
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
668 669
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
670
      ;; We must also flush the cache of the directory, because
671
      ;; `file-attributes' reads the values from there.
672
      (tramp-flush-file-properties v localname)
673 674 675 676 677 678 679 680 681 682 683 684
      (if (and delete-by-moving-to-trash trash)
	  (move-file-to-trash filename)
	(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 v 'file-error "%s `%s'" (match-string 0) filename)))))))
685 686

(defun tramp-smb-handle-directory-files
687
  (directory &optional full match nosort count)
688
  "Like `directory-files' for Tramp files."
Michael Albinus's avatar
Michael Albinus committed
689
  (unless (file-exists-p directory)
Michael Albinus's avatar
Michael Albinus committed
690
    (tramp-compat-file-missing (tramp-dissect-file-name directory) directory))
691
  (let ((result (mapcar #'directory-file-name
692
			(file-name-all-completions "" directory))))
693
    ;; Discriminate with regexp.
694 695 696
    (when match
      (setq result
	    (delete nil
697
		    (mapcar (lambda (x) (when (string-match-p match x) x))
698
			    result))))
699

700 701 702 703
    ;; Sort them if necessary.
    (unless nosort
      (setq result (sort result #'string-lessp)))

704
    ;; Return count number of results.
705 706 707
    (when (and (natnump count) (> count 0))
      (setq result (nbutlast result (- (length result) count))))

Michael Albinus's avatar
Michael Albinus committed
708
    ;; Prepend directory.
709 710 711
    (when full
      (setq result
	    (mapcar
Michael Albinus's avatar
Michael Albinus committed
712
	     (lambda (x) (format "%s/%s" (directory-file-name directory) x))
713
	     result)))
714

Michael Albinus's avatar
Michael Albinus committed
715
    result))
716

717 718 719 720
(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 "/"))
721 722
  ;; Handle empty NAME.
  (when (zerop (length name)) (setq name "."))
723 724 725 726 727
  ;; 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))
728
      (tramp-run-real-handler #'expand-file-name (list name nil))
729 730 731
    ;; 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
732
      ;; which is often the case in domains.
733
      (when (string-match "\\`/?~\\([^/]*\\)" localname)
734 735
	(setq localname
	      (replace-match
736
	       (if (zerop (length (match-string 1 localname)))
737
		   user
738
		 (match-string 1 localname))
739
	       nil nil localname)))
740
      ;; Make the file name absolute.
741
      (unless (tramp-run-real-handler #'file-name-absolute-p (list localname))
742
	(setq localname (concat "/" localname)))
Michael Albinus's avatar
Michael Albinus committed
743 744 745
     ;; Do not keep "/..".
      (when (string-match-p "^/\\.\\.?$" localname)
	(setq localname "/"))
746 747 748
      ;; No tilde characters in file name, do normal
      ;; `expand-file-name' (this does "/./" and "/../").
      (tramp-make-tramp-file-name
749
       v (tramp-run-real-handler #'expand-file-name (list localname))))))
750

Michael Albinus's avatar
Michael Albinus committed
751
(defun tramp-smb-action-get-acl (proc vec)
752
  "Read ACL data from connection buffer."
753
  (unless (process-live-p proc)
754
    ;; Accept pending output.
755
    (while (tramp-accept-process-output proc))
756 757 758 759 760
    (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))
761
      (while (and (not (eobp)) (not (looking-at-p "^REVISION:")))
762 763
	(forward-line)
	(delete-region (point-min) (point)))
764
      (while (and (not (eobp)) (looking-at-p "^.+:.+"))
765 766 767 768
 	(forward-line))
      (delete-region (point) (point-max))
      (throw 'tramp-action 'ok))))

769 770
(defun tramp-smb-handle-file-acl (filename)
  "Like `file-acl' for Tramp files."
Michael Albinus's avatar
Michael Albinus committed
771 772 773 774 775
  (ignore-errors
    (with-parsed-tramp-file-name filename nil
      (with-tramp-file-property v localname "file-acl"
	(when (executable-find tramp-smb-acl-program)
	  (let* ((share     (tramp-smb-get-share v))
776 777
		 (localname (tramp-compat-string-replace
			     "\\" "/" (tramp-smb-get-localname v)))
778 779
		 (args      (list (concat "//" host "/" share) "-E"))
		 (options   tramp-smb-options))
Michael Albinus's avatar
Michael Albinus committed
780 781 782 783 784 785 786 787 788

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

	    (when domain (setq args (append args (list "-W" domain))))
	    (when port   (setq args (append args (list "-p" port))))
	    (when tramp-smb-conf
	      (setq args (append args (list "-s" tramp-smb-conf))))
789 790 791 792
	    (while options
	      (setq args
		    (append args `("--option" ,(format "%s" (car options))))
		    options (cdr options)))
Michael Albinus's avatar
Michael Albinus committed
793 794 795
	    (setq
	     args
	     (append args (list (tramp-unquote-shell-quote-argument localname)
796
				(concat "2>" (tramp-get-remote-null-device v)))))
Michael Albinus's avatar
Michael Albinus committed
797 798 799 800 801 802 803 804 805 806 807 808

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

		  ;; Use an asynchronous process.  By this, password can
		  ;; be handled.
		  (let ((p (apply
809
			    #'start-process
Michael Albinus's avatar
Michael Albinus committed
810 811 812 813 814
			    (tramp-get-connection-name v)
			    (tramp-get-connection-buffer v)
			    tramp-smb-acl-program args)))

		    (tramp-message
Michael Albinus's avatar
Michael Albinus committed
815
		     v 6 "%s" (string-join (process-command p) " "))
Michael Albinus's avatar
Michael Albinus committed
816
		    (process-put p 'vector v)
817
		    (process-put p 'adjust-window-size-function #'ignore)
Michael Albinus's avatar
Michael Albinus committed
818 819 820 821 822 823
		    (set-process-query-on-exit-flag p nil)
		    (tramp-process-actions p v nil tramp-smb-actions-get-acl)
		    (when (> (point-max) (point-min))
		      (substring-no-properties (buffer-string)))))

	      ;; Reset the transfer process properties.
824 825
	      (tramp-flush-connection-property v "process-name")
	      (tramp-flush-connection-property v "process-buffer"))))))))
826

827
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
828
  "Like `file-attributes' for Tramp files."
829
  (unless id-format (setq id-format 'integer))
830 831
  (ignore-errors
    (with-parsed-tramp-file-name filename nil
832 833
      (with-tramp-file-property
	  v localname (format "file-attributes-%s" id-format)
834
	(if (tramp-smb-get-stat-capability v)
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
	    (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
852
	      (list (and (string-match-p "d" (nth 1 entry))
853 854 855 856 857 858 859 860 861 862 863 864
			 t)              ;0 file type
		    -1	                 ;1 link count
		    uid	                 ;2 uid
		    gid	                 ;3 gid
		    tramp-time-dont-know ;4 atime
		    (nth 3 entry)        ;5 mtime
		    tramp-time-dont-know ;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