tramp-smb.el 50.2 KB
Newer Older
Michael Albinus's avatar
Michael Albinus committed
1
;;; tramp-smb.el --- Tramp access functions for SMB servers
2

3
;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2009, 2010 Free Software Foundation, Inc.
5

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

;; This file is part of GNU Emacs.

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

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
24 25 26 27 28 29 30

;;; Commentary:

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

;;; Code:

Glenn Morris's avatar
Glenn Morris committed
31
(eval-when-compile (require 'cl))	; block, return
32 33 34
(require 'tramp)

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

;; ... and add it to the method list.
40 41 42
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
  (add-to-list 'tramp-methods (cons tramp-smb-method nil)))
43 44 45 46

;; Add a default for `tramp-default-method-alist'. Rule: If there is
;; a domain in USER, it must be the SMB method.
(add-to-list 'tramp-default-method-alist
47
	     `(nil ,tramp-prefix-domain-regexp ,tramp-smb-method))
48 49 50 51 52

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

;; Add completion function for SMB method.
(tramp-set-completion-function
 tramp-smb-method
 '((tramp-parse-netrc "~/.netrc")))

(defcustom tramp-smb-program "smbclient"
  "*Name of SMB client to run."
  :group 'tramp
  :type 'string)

64 65 66 67 68 69 70
(defcustom tramp-smb-conf "/dev/null"
  "*Path of the smb.conf file.
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
  :type '(choice (const nil) (file :must-match t)))

71 72 73
(defvar tramp-smb-version nil
  "*Version string of the SMB client.")

Michael Albinus's avatar
Michael Albinus committed
74
(defconst tramp-smb-prompt "^smb: .+> \\|^\\s-+Server\\s-+Comment$"
75 76 77
  "Regexp used as prompt in smbclient.")

(defconst tramp-smb-errors
78
  ;; `regexp-opt' not possible because of first string.
79 80
  (mapconcat
   'identity
81
   '(;; Connection error / timeout / unknown command.
82
     "Connection to \\S-+ failed"
83
     "Read from server failed, maybe it closed the connection"
84
     "Call timed out: server did not respond"
85 86 87
     "\\S-+: command not found"
     "Server doesn't support UNIX CIFS calls"
     ;; Samba.
88
     "ERRDOS"
89
     "ERRHRD"
90
     "ERRSRV"
91 92 93 94 95 96
     "ERRbadfile"
     "ERRbadpw"
     "ERRfilexists"
     "ERRnoaccess"
     "ERRnomem"
     "ERRnosuchshare"
97
     ;; Windows 4.0 (Windows NT), Windows 5.0 (Windows 2000),
98
     ;; Windows 5.1 (Windows XP), Windows 5.2 (Windows Server 2003).
99
     "NT_STATUS_ACCESS_DENIED"
100
     "NT_STATUS_ACCOUNT_LOCKED_OUT"
101 102
     "NT_STATUS_BAD_NETWORK_NAME"
     "NT_STATUS_CANNOT_DELETE"
103
     "NT_STATUS_CONNECTION_REFUSED"
104 105 106
     "NT_STATUS_DIRECTORY_NOT_EMPTY"
     "NT_STATUS_DUPLICATE_NAME"
     "NT_STATUS_FILE_IS_A_DIRECTORY"
107
     "NT_STATUS_LOGON_FAILURE"
108
     "NT_STATUS_NETWORK_ACCESS_DENIED"
109
     "NT_STATUS_NOT_IMPLEMENTED"
110
     "NT_STATUS_NO_SUCH_FILE"
111
     "NT_STATUS_OBJECT_NAME_COLLISION"
112 113
     "NT_STATUS_OBJECT_NAME_INVALID"
     "NT_STATUS_OBJECT_NAME_NOT_FOUND"
114
     "NT_STATUS_SHARING_VIOLATION"
115
     "NT_STATUS_TRUSTED_RELATIONSHIP_FAILURE"
116
     "NT_STATUS_WRONG_PASSWORD")
117 118 119 120
   "\\|")
  "Regexp for possible error strings of SMB servers.
Used instead of analyzing error codes of commands.")

121 122 123 124 125 126 127 128 129 130
(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.")
131

132 133 134 135 136 137 138
(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.
139

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

142 143 144
;; New handlers should be added here.
(defconst tramp-smb-file-name-handler-alist
  '(
145
    ;; `access-file' performed by default handler.
146
    (add-name-to-file . tramp-smb-handle-add-name-to-file)
147 148
    ;; `byte-compiler-base-file-name' performed by default handler.
    (copy-directory . tramp-smb-handle-copy-directory)
149 150 151
    (copy-file . tramp-smb-handle-copy-file)
    (delete-directory . tramp-smb-handle-delete-directory)
    (delete-file . tramp-smb-handle-delete-file)
152
    ;; `diff-latest-backup-file' performed by default handler.
153
    (directory-file-name . tramp-handle-directory-file-name)
154
    (directory-files . tramp-smb-handle-directory-files)
155
    (directory-files-and-attributes
156
     . tramp-handle-directory-files-and-attributes)
157 158
    (dired-call-process . ignore)
    (dired-compress-file . ignore)
159
    (dired-uncache . tramp-handle-dired-uncache)
160
    (expand-file-name . tramp-smb-handle-expand-file-name)
161 162 163
    (file-accessible-directory-p . tramp-smb-handle-file-directory-p)
    (file-attributes . tramp-smb-handle-file-attributes)
    (file-directory-p .  tramp-smb-handle-file-directory-p)
164 165
    (file-executable-p . tramp-handle-file-exists-p)
    (file-exists-p . tramp-handle-file-exists-p)
166 167 168
    (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)
169
    (file-name-as-directory . tramp-handle-file-name-as-directory)
170 171 172
    (file-name-completion . tramp-handle-file-name-completion)
    (file-name-directory . tramp-handle-file-name-directory)
    (file-name-nondirectory . tramp-handle-file-name-nondirectory)
173
    ;; `file-name-sans-versions' performed by default handler.
174
    (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
175
    (file-ownership-preserved-p . ignore)
176
    (file-readable-p . tramp-handle-file-exists-p)
177
    (file-regular-p . tramp-handle-file-regular-p)
Michael Albinus's avatar
Michael Albinus committed
178 179
    (file-remote-p . tramp-handle-file-remote-p)
    ;; `file-selinux-context' performed by default handler.
180
    (file-symlink-p . tramp-handle-file-symlink-p)
181
    ;; `file-truename' performed by default handler.
182
    (file-writable-p . tramp-smb-handle-file-writable-p)
183
    (find-backup-file-name . tramp-handle-find-backup-file-name)
184 185
    ;; `find-file-noselect' performed by default handler.
    ;; `get-file-buffer' performed by default handler.
186 187 188 189 190
    (insert-directory . tramp-smb-handle-insert-directory)
    (insert-file-contents . tramp-handle-insert-file-contents)
    (load . tramp-handle-load)
    (make-directory . tramp-smb-handle-make-directory)
    (make-directory-internal . tramp-smb-handle-make-directory-internal)
191
    (make-symbolic-link . tramp-smb-handle-make-symbolic-link)
192
    (rename-file . tramp-smb-handle-rename-file)
193
    (set-file-modes . tramp-smb-handle-set-file-modes)
Michael Albinus's avatar
Michael Albinus committed
194
    ;; `set-file-selinux-context' performed by default handler.
195
    (set-file-times . ignore)
196 197
    (set-visited-file-modtime . ignore)
    (shell-command . ignore)
Michael Albinus's avatar
Michael Albinus committed
198
    (substitute-in-file-name . tramp-smb-handle-substitute-in-file-name)
199
    (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
200 201
    (vc-registered . ignore)
    (verify-visited-file-modtime . ignore)
202 203 204 205 206
    (write-region . tramp-smb-handle-write-region)
)
  "Alist of handler functions for Tramp SMB method.
Operations not mentioned here will be handled by the default Emacs primitives.")

207 208
;;;###tramp-autoload
(defsubst tramp-smb-file-name-p (filename)
209 210
  "Check if it's a filename for SMB servers."
  (let ((v (tramp-dissect-file-name filename)))
211
    (string= (tramp-file-name-method v) tramp-smb-method)))
212

213
;;;###tramp-autoload
214 215 216 217 218 219
(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
220
	(save-match-data (apply (cdr fn) args))
221 222
      (tramp-run-real-handler operation args))))

223 224 225 226
;;;###tramp-autoload
(unless (memq system-type '(cygwin windows-nt))
  (add-to-list 'tramp-foreign-file-name-handler-alist
	       (cons 'tramp-smb-file-name-p 'tramp-smb-file-name-handler)))
227 228


229 230
;; File name primitives.

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
(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)
261 262 263 264 265 266 267 268 269 270 271 272
      (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
	 "error with add-name-to-file, see buffer `%s' for details"
	 (buffer-name))))))
273

274 275
(defun tramp-smb-handle-copy-directory
  (dirname newname &optional keep-date parents)
276
  "Like `copy-directory' for Tramp files.  KEEP-DATE is not handled."
277 278 279 280 281
  (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
282
      (cond
283
       ;; We must use a local temporary directory.
284 285 286 287 288 289 290 291
       ((and t1 t2)
	(let ((tmpdir
	       (make-temp-name
		(expand-file-name
		 tramp-temp-name-prefix
		 (tramp-compat-temporary-file-directory)))))
	  (unwind-protect
	      (progn
292 293 294
		(tramp-compat-copy-directory dirname tmpdir keep-date parents)
		(tramp-compat-copy-directory tmpdir newname keep-date parents))
	    (tramp-compat-delete-directory tmpdir 'recursive))))
295 296

       ;; We can copy recursively.
297 298
       ((or t1 t2)
	(let ((prompt (tramp-smb-send-command v "prompt"))
299
	      (recurse (tramp-smb-send-command v "recurse")))
300 301 302 303 304 305 306
	  (unless (file-directory-p newname)
	    (make-directory newname parents))
	  (unwind-protect
	      (unless
		  (and
		   prompt recurse
		   (tramp-smb-send-command
307
		    v (format "cd \"%s\"" (tramp-smb-get-localname v)))
308 309 310 311 312 313 314 315 316 317 318 319
		   (tramp-smb-send-command
		    v (format "lcd \"%s\"" (if t1 newname dirname)))
		   (if t1
		       (tramp-smb-send-command v "mget *")
		     (tramp-smb-send-command v "mput *")))
		;; 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) (if t1 dirname newname))))
320
	    ;; Go home.
321 322 323
	    (tramp-smb-send-command
	     v (format
		"cd %s" (if (tramp-smb-get-cifs-capabilities v) "/" "\\")))
324 325 326
	    ;; Toggle prompt and recurse OFF.
	    (if prompt (tramp-smb-send-command v "prompt"))
	    (if recurse (tramp-smb-send-command v "recurse")))))
327 328

       ;; We must do it file-wise.
329
       (t
330
	(tramp-run-real-handler
331
	 'copy-directory (list dirname newname keep-date parents)))))))
332 333

(defun tramp-smb-handle-copy-file
Michael Albinus's avatar
Michael Albinus committed
334 335
  (filename newname &optional ok-if-already-exists keep-date
	    preserve-uid-gid preserve-selinux-context)
336
  "Like `copy-file' for Tramp files.
337 338
KEEP-DATE is not handled in case NEWNAME resides on an SMB server.
PRESERVE-UID-GID is completely ignored."
339 340
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))
341 342 343 344 345 346 347 348 349 350 351
  (with-progress-reporter
      (tramp-dissect-file-name (if (file-remote-p filename) filename newname))
      0 (format "Copying %s to %s" filename newname)

    (let ((tmpfile (file-local-copy filename)))

      (if tmpfile
	  ;; Remote filename.
	  (condition-case err
	      (rename-file tmpfile newname ok-if-already-exists)
	    ((error quit)
352
	     (delete-file tmpfile)
353 354 355 356 357 358 359 360 361 362 363
	     (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))
364

365 366 367 368 369 370 371 372 373 374 375
	  ;; 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
	     v 'file-error "Target `%s' must contain a share name" newname))
	  (unless (tramp-smb-send-command
		   v (format "put \"%s\" \"%s\""
			     filename (tramp-smb-get-localname v)))
	    (tramp-error v 'file-error "Cannot copy `%s'" filename))))))
376 377 378

  ;; KEEP-DATE handling.
  (when keep-date (set-file-times newname (nth 5 (file-attributes filename)))))
379

380
(defun tramp-smb-handle-delete-directory (directory &optional recursive)
381
  "Like `delete-directory' for Tramp files."
382
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
383
  (when (file-exists-p directory)
384 385 386 387
    (if recursive
	(mapc
	 (lambda (file)
	   (if (file-directory-p file)
388
	       (tramp-compat-delete-directory file recursive)
389
	     (delete-file file)))
390 391 392
	 ;; We do not want to delete "." and "..".
	 (directory-files
	  directory 'full "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")))
393

Michael Albinus's avatar
Michael Albinus committed
394
    (with-parsed-tramp-file-name directory nil
395
      ;; We must also flush the cache of the directory, because
396
      ;; `file-attributes' reads the values from there.
397 398
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-directory-property v localname)
399 400 401 402 403 404 405 406 407 408 409
      (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
	   v 'file-error "%s `%s'" (match-string 0) directory))))))
410

411
(defun tramp-smb-handle-delete-file (filename &optional trash)
412
  "Like `delete-file' for Tramp files."
413
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
414 415
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
416
      ;; We must also flush the cache of the directory, because
417
      ;; `file-attributes' reads the values from there.
418 419
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-file-property v localname)
420 421 422 423 424 425 426 427 428 429 430
      (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))))))
431 432 433

(defun tramp-smb-handle-directory-files
  (directory &optional full match nosort)
434 435 436
  "Like `directory-files' for Tramp files."
  (let ((result (mapcar 'directory-file-name
			(file-name-all-completions "" directory))))
437
    ;; Discriminate with regexp.
438 439 440 441 442
    (when match
      (setq result
	    (delete nil
		    (mapcar (lambda (x) (when (string-match match x) x))
			    result))))
443
    ;; Append directory.
444 445 446 447 448
    (when full
      (setq result
	    (mapcar
	     (lambda (x) (expand-file-name x directory))
	     result)))
449
    ;; Sort them if necessary.
450
    (unless nosort (setq result (sort result 'string-lessp)))
451
    ;; That's it.
452
    result))
453

454 455 456 457 458 459 460 461 462 463 464 465 466
(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,
467 468
      ;; which is offen the case in domains.
      (when (string-match "\\`/?~\\([^/]*\\)" localname)
469 470
	(setq localname
	      (replace-match
471
	       (if (zerop (length (match-string 1 localname)))
472
		   (tramp-file-name-real-user v)
473
		 (match-string 1 localname))
474
	       nil nil localname)))
475 476 477
      ;; Make the file name absolute.
      (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
	(setq localname (concat "/" localname)))
478 479 480 481 482 483
      ;; 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))))))

484
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
485
  "Like `file-attributes' for Tramp files."
486
  (unless id-format (setq id-format 'integer))
Michael Albinus's avatar
Michael Albinus committed
487
  (with-parsed-tramp-file-name filename nil
488
    (with-file-property v localname (format "file-attributes-%s" id-format)
489
      (if (and (tramp-smb-get-share v) (tramp-smb-get-stat-capability v))
490
	  (tramp-smb-do-file-attributes-with-stat v id-format)
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
	;; 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

521
(defun tramp-smb-do-file-attributes-with-stat (vec &optional id-format)
522
  "Implement `file-attributes' for Tramp files using stat command."
523 524
  (tramp-message
   vec 5 "file attributes with stat: %s" (tramp-file-name-localname vec))
525
  (with-current-buffer (tramp-get-buffer vec)
526
    (let* (size id link uid gid atime mtime ctime mode inode)
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
      (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)))))))
585 586

(defun tramp-smb-handle-file-directory-p (filename)
587 588 589
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
       (eq ?d (aref (nth 8 (file-attributes filename)) 0))))
590 591

(defun tramp-smb-handle-file-local-copy (filename)
592
  "Like `file-local-copy' for Tramp files."
593
  (with-parsed-tramp-file-name filename nil
594 595 596 597
    (unless (file-exists-p filename)
      (tramp-error
       v 'file-error
       "Cannot make local copy of non-existing file `%s'" filename))
598
    (let ((tmpfile (tramp-compat-make-temp-file filename)))
599 600 601 602 603 604
      (with-progress-reporter
	  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.
605
	  (delete-file tmpfile)
606 607
	  (tramp-error
	   v 'file-error "Cannot make local copy of file `%s'" filename)))
608
      tmpfile)))
609 610 611 612

;; This function should return "foo/" for directories and "bar" for
;; files.
(defun tramp-smb-handle-file-name-all-completions (filename directory)
613 614 615 616 617 618 619
  "Like `file-name-all-completions' for Tramp files."
  (all-completions
   filename
   (with-parsed-tramp-file-name directory nil
     (with-file-property v localname "file-name-all-completions"
       (save-match-data
	 (let ((entries (tramp-smb-get-file-entries directory)))
620 621 622 623 624 625 626 627 628
	   (mapcar
	    (lambda (x)
	      (list
	       (if (string-match "d" (nth 1 x))
		   (file-name-as-directory (nth 0 x))
		 (nth 0 x))))
	    entries)))))))

(defun tramp-smb-handle-file-writable-p (filename)
629 630 631 632 633 634
  "Like `file-writable-p' for Tramp files."
  (if (file-exists-p filename)
      (string-match "w" (or (nth 8 (file-attributes filename)) ""))
    (let ((dir (file-name-directory filename)))
      (and (file-exists-p dir)
	   (file-writable-p dir)))))
635 636 637

(defun tramp-smb-handle-insert-directory
  (filename switches &optional wildcard full-directory-p)
638
  "Like `insert-directory' for Tramp files."
639
  (setq filename (expand-file-name filename))
640 641 642 643
  (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
644
  (with-parsed-tramp-file-name filename nil
645
    (save-match-data
646
      (let ((base (file-name-nondirectory filename))
647 648 649 650 651 652 653 654 655 656 657 658 659 660
	    ;; We should not destroy the cache entry.
	    (entries (copy-sequence
		      (tramp-smb-get-file-entries
		       (file-name-directory filename)))))

	(when wildcard
	  (string-match "\\." base)
	  (setq base (replace-match "\\\\." nil nil base))
	  (string-match "\\*" base)
	  (setq base (replace-match ".*" nil nil base))
	  (string-match "\\?" base)
	  (setq base (replace-match ".?" nil nil base)))

	;; Filter entries.
661
	(setq entries
662 663 664 665 666 667 668 669 670 671 672 673
	      (delq
	       nil
	       (if (or wildcard (zerop (length base)))
		   ;; Check for matching entries.
		   (mapcar
		    (lambda (x)
		      (when (string-match
			     (format "^%s" base) (nth 0 x))
			x))
		    entries)
		 ;; We just need the only and only entry FILENAME.
		 (list (assoc base entries)))))
674

Michael Albinus's avatar
Michael Albinus committed
675
	;; Sort entries.
676 677 678 679 680
	(setq entries
	      (sort
	       entries
	       (lambda (x y)
		 (if (string-match "t" switches)
681 682 683
		     ;; Sort by date.
		     (tramp-time-less-p (nth 3 y) (nth 3 x))
		   ;; Sort by name.
684 685
		   (string-lessp (nth 0 x) (nth 0 y))))))

Michael Albinus's avatar
Michael Albinus committed
686 687
	;; Handle "-F" switch.
	(when (string-match "F" switches)
688
	  (mapc
Michael Albinus's avatar
Michael Albinus committed
689 690 691 692 693 694 695 696 697
	   (lambda (x)
	     (when (not (zerop (length (car x))))
	       (cond
		((char-equal ?d (string-to-char (nth 1 x)))
		 (setcar x (concat (car x) "/")))
		((char-equal ?x (string-to-char (nth 1 x)))
		 (setcar x (concat (car x) "*"))))))
	   entries))

698
	;; Print entries.
699
	(mapc
700
	 (lambda (x)
701
	   (when (not (zerop (length (nth 0 x))))
702
	     (let ((attr
703
		    (when (tramp-smb-get-stat-capability v)
704
		      (ignore-errors
705
			(file-attributes filename 'string)))))
706 707
	       (insert
		(format
708
		 "%10s %3d %-8s %-8s %8s %s "
709
		 (or (nth 8 attr) (nth 1 x)) ; mode
710
		 (or (nth 1 attr) 1) ; inode
711 712
		 (or (nth 2 attr) "nobody") ; uid
		 (or (nth 3 attr) "nogroup") ; gid
713
		 (or (nth 7 attr) (nth 2 x)) ; size
714 715 716 717 718 719
		 (format-time-string
		  (if (tramp-time-less-p
		       (tramp-time-subtract (current-time) (nth 3 x))
		       tramp-half-a-year)
		      "%b %e %R"
		    "%b %e  %Y")
720
		  (nth 3 x)))) ; date
721 722 723
	       ;; We mark the file name.  The inserted name could be
	       ;; from somewhere else, so we use the relative file
	       ;; name of `default-directory'.
724
	       (let ((start (point)))
725 726 727
		 (insert
		  (format
		   "%s\n"
728 729 730
		   (file-relative-name
		    (expand-file-name
		     (nth 0 x) (file-name-directory filename)))))
731
		 (put-text-property start (1- (point)) 'dired-filename t))
732 733 734
	       (forward-line)
	       (beginning-of-line))))
	 entries)))))
735 736

(defun tramp-smb-handle-make-directory (dir &optional parents)
737
  "Like `make-directory' for Tramp files."
738 739
  (setq dir (directory-file-name (expand-file-name dir)))
  (unless (file-name-absolute-p dir)
740
    (setq dir (expand-file-name dir default-directory)))
Michael Albinus's avatar
Michael Albinus committed
741
  (with-parsed-tramp-file-name dir nil
742
    (save-match-data
743
      (let* ((ldir (file-name-directory dir)))
744
	;; Make missing directory parts.
745 746 747
	(when (and parents
		   (tramp-smb-get-share v)
		   (not (file-directory-p ldir)))
748
	  (make-directory ldir parents))
749
	;; Just do it.
750
	(when (file-directory-p ldir)
751
	  (make-directory-internal dir))
752
	(unless (file-directory-p dir)
753
	  (tramp-error v 'file-error "Couldn't make directory %s" dir))))))
754 755

(defun tramp-smb-handle-make-directory-internal (directory)
756
  "Like `make-directory-internal' for Tramp files."
757 758
  (setq directory (directory-file-name (expand-file-name directory)))
  (unless (file-name-absolute-p directory)
759
    (setq directory (expand-file-name directory default-directory)))
Michael Albinus's avatar
Michael Albinus committed
760
  (with-parsed-tramp-file-name directory nil
761
    (save-match-data
762
      (let* ((file (tramp-smb-get-localname v)))
763
	(when (file-directory-p (file-name-directory directory))
764 765
	  (tramp-smb-send-command
	   v
766
	   (if (tramp-smb-get-cifs-capabilities v)
767 768
	       (format
		"posix_mkdir \"%s\" %s"
769
		file (tramp-compat-decimal-to-octal (default-file-modes)))
770
	     (format "mkdir \"%s\"" file)))
771
	  ;; We must also flush the cache of the directory, because
772 773 774
	  ;; `file-attributes' reads the values from there.
	  (tramp-flush-file-property v (file-name-directory localname))
	  (tramp-flush-file-property v localname))
775
	(unless (file-directory-p directory)
776 777
	  (tramp-error
	   v 'file-error "Couldn't make directory %s" directory))))))
778

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 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
(defun tramp-smb-handle-make-symbolic-link
  (filename linkname &optional ok-if-already-exists)
  "Like `make-symbolic-link' for Tramp files.
If LINKNAME is a non-Tramp file, it is used verbatim as the target of
the symlink.  If LINKNAME is a Tramp file, only the localname component is
used as the target of the symlink.

If LINKNAME is a Tramp file and the localname component is relative, then
it is expanded first, before the localname component is taken.  Note that
this can give surprising results if the user/host for the source and
target of the symlink differ."
  (unless (tramp-equal-remote filename linkname)
    (with-parsed-tramp-file-name
	(if (tramp-tramp-file-p filename) filename linkname) nil
      (tramp-error
       v 'file-error
       "make-symbolic-link: %s"
       "only implemented for same method, same user, same host")))
  (with-parsed-tramp-file-name filename v1
    (with-parsed-tramp-file-name linkname v2
      (when (file-directory-p filename)
	(tramp-error
	 v2 'file-error
	 "make-symbolic-link: %s must not be a directory" filename))
      (when (and (not ok-if-already-exists)
		 (file-exists-p linkname)
		 (not (numberp ok-if-already-exists))
		 (y-or-n-p
		  (format
		   "File %s already exists; make it a new name anyway? "
		   linkname)))
	(tramp-error
	 v2 'file-error
	 "make-symbolic-link: file %s already exists" linkname))
      (unless (tramp-smb-get-cifs-capabilities v1)
	(tramp-error v2 'file-error "make-symbolic-link not supported"))
      ;; 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)
      (unless
	  (tramp-smb-send-command
	   v1
	   (format
	    "symlink \"%s\" \"%s\""
824 825
	    (tramp-smb-get-localname v1)
	    (tramp-smb-get-localname v2)))
826 827 828 829 830
	(tramp-error
	 v2 'file-error
	 "error with make-symbolic-link, see buffer `%s' for details"
	 (buffer-name))))))

831 832
(defun tramp-smb-handle-rename-file
  (filename newname &optional ok-if-already-exists)
833
  "Like `rename-file' for Tramp files."
834 835
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))
836 837 838 839 840 841 842 843 844 845 846
  (with-progress-reporter
      (tramp-dissect-file-name (if (file-remote-p filename) filename newname))
      0 (format "Renaming %s to %s" filename newname)

    (let ((tmpfile (file-local-copy filename)))

      (if tmpfile
	  ;; Remote filename.
	  (condition-case err
	      (rename-file tmpfile newname ok-if-already-exists)
	    ((error quit)
847
	     (delete-file tmpfile)
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
	     (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-send-command
		   v (format "put %s \"%s\""
			     filename (tramp-smb-get-localname v)))
	    (tramp-error v 'file-error "Cannot rename `%s'" filename)))))
867

868
    (delete-file filename)))
869

870 871 872
(defun tramp-smb-handle-set-file-modes (filename mode)
  "Like `set-file-modes' for Tramp files."
  (with-parsed-tramp-file-name filename nil
873 874 875 876
    (when (tramp-smb-get-cifs-capabilities v)
      (tramp-flush-file-property v localname)
      (unless (tramp-smb-send-command
	       v (format "chmod \"%s\" %s"
877
			 (tramp-smb-get-localname v)
878
			 (tramp-compat-decimal-to-octal mode)))
879 880
	(tramp-error
	 v 'file-error "Error while changing file's mode %s" filename)))))
881

Michael Albinus's avatar
Michael Albinus committed
882
(defun tramp-smb-handle-substitute-in-file-name (filename)
883
  "Like `handle-substitute-in-file-name' for Tramp files.
884 885 886 887 888 889 890 891
\"//\" substitutes only in the local filename part.  Catches
errors for shares like \"C$/\", which are common in Microsoft Windows."
  (with-parsed-tramp-file-name filename nil
    ;; Ignore in LOCALNAME everything before "//".
    (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
      (setq filename
	    (concat (file-remote-p filename)
		    (replace-match "\\1" nil nil localname)))))
Michael Albinus's avatar
Michael Albinus committed
892 893 894 895
  (condition-case nil
      (tramp-run-real-handler 'substitute-in-file-name (list filename))
    (error filename)))

896 897
(defun tramp-smb-handle-write-region
  (start end filename &optional append visit lockname confirm)
898
  "Like `write-region' for Tramp files."
899
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
900
  (with-parsed-tramp-file-name filename nil
901 902
    (unless (eq append nil)
      (tramp-error
903
	 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
904
    ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
905 906 907 908 909 910
    (when (and (not (featurep 'xemacs))
	       confirm (file-exists-p filename))
      (unless (y-or-n-p (format "File %s exists; overwrite anyway? "
				filename))
	(tramp-error v 'file-error "File not overwritten")))
    ;; We must also flush the cache of the directory, because
911
    ;; `file-attributes' reads the values from there.
912 913
    (tramp-flush-file-property v (file-name-directory localname))
    (tramp-flush-file-property v localname)
914
    (let ((curbuf (current-buffer))
915
	  (tmpfile (tramp-compat-make-temp-file filename)))
916 917 918 919 920 921
      ;; We say `no-message' here because we don't want the visited file
      ;; modtime data to be clobbered from the temp file.  We call
      ;; `set-visited-file-modtime' ourselves later on.
      (tramp-run-real-handler
       'write-region
       (if confirm ; don't pass this arg unless defined for backward compat.
922 923
	   (list start end tmpfile append 'no-message lockname confirm)
	 (list start end tmpfile append 'no-message lockname)))
924

925 926 927 928 929 930 931
      (with-progress-reporter
	  v 3 (format "Moving tmp file %s to %s" tmpfile filename)
	(unwind-protect
	    (unless (tramp-smb-send-command
		     v (format "put %s \"%s\""
			       tmpfile (tramp-smb-get-localname v)))
	      (tramp-error v 'file-error "Cannot write `%s'" filename))
932
	  (delete-file tmpfile)))
933 934 935 936 937 938 939

      (unless (equal curbuf (current-buffer))
	(tramp-error
	 v 'file-error
	 "Buffer has changed from `%s' to `%s'" curbuf (current-buffer)))
      (when (eq visit t)
	(set-visited-file-modtime)))))
940 941


942
;; Internal file name functions.
943

944
(defun tramp-smb-get-share (vec)
Kai Großjohann's avatar
Kai Großjohann committed
945
  "Returns the share name of LOCALNAME."
946
  (save-match-data
947 948 949
    (let ((localname (tramp-file-name-localname vec)))
      (when (string-match "^/?\\([^/]+\\)/" localname)
	(match-string 1 localname)))))
950

951
(defun tramp-smb-get-localname (vec)
Kai Großjohann's avatar
Kai Großjohann committed
952
  "Returns the file name of LOCALNAME.
953
If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"."
954
  (save-match-data
955
    (let ((localname (tramp-file-name-localname vec)))
956
      (setq
957 958 959 960 961 962 963 964 965 966 967 968
       localname
       (if (string-match "^/?[^/]+\\(/.*\\)" localname)
	   ;; There is a share, sparated by "/".
	   (if (not (tramp-smb-get-cifs-capabilities vec))
	       (mapconcat
		(lambda (x) (if (equal x ?/) "\\" (char-to-string x)))
		(match-string 1 localname) "")
	     (match-string 1 localname))
	 ;; There is just a share.
	 (if (string-match "^/?\\([^/]+\\)$" localname)
	     (match-string 1 localname)
	   "")))
969