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 4
;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008,
;;   2009 Free Software Foundation, Inc.
5

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

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

;;; Commentary:

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

;;; Code:

Glenn Morris's avatar
Glenn Morris committed
30
(eval-when-compile (require 'cl))	; block, return
31
(require 'tramp)
32
(require 'tramp-cache)
33
(require 'tramp-compat)
34 35 36 37 38 39 40 41 42 43 44 45 46

;; Define SMB method ...
(defcustom tramp-smb-method "smb"
  "*Method to connect SAMBA and M$ SMB servers."
  :group 'tramp
  :type 'string)

;; ... and add it to the method list.
(add-to-list 'tramp-methods (cons tramp-smb-method nil))

;; 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
(defvar tramp-smb-version nil
  "*Version string of the SMB client.")

Michael Albinus's avatar
Michael Albinus committed
67
(defconst tramp-smb-prompt "^smb: .+> \\|^\\s-+Server\\s-+Comment$"
68 69 70
  "Regexp used as prompt in smbclient.")

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

114 115 116 117 118 119 120 121 122 123
(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.")
124

125 126 127 128 129 130 131
(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.
132

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

135 136 137
;; New handlers should be added here.
(defconst tramp-smb-file-name-handler-alist
  '(
138
    ;; `access-file' performed by default handler.
139
    (add-name-to-file . tramp-smb-handle-add-name-to-file)
140 141
    ;; `byte-compiler-base-file-name' performed by default handler.
    (copy-directory . tramp-smb-handle-copy-directory)
142 143 144
    (copy-file . tramp-smb-handle-copy-file)
    (delete-directory . tramp-smb-handle-delete-directory)
    (delete-file . tramp-smb-handle-delete-file)
145
    ;; `diff-latest-backup-file' performed by default handler.
146
    (directory-file-name . tramp-handle-directory-file-name)
147
    (directory-files . tramp-smb-handle-directory-files)
148 149
    (directory-files-and-attributes
     . tramp-smb-handle-directory-files-and-attributes)
150 151
    (dired-call-process . ignore)
    (dired-compress-file . ignore)
152
    (dired-uncache . tramp-handle-dired-uncache)
153
    (expand-file-name . tramp-smb-handle-expand-file-name)
154 155 156 157 158 159
    (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)
    (file-executable-p . tramp-smb-handle-file-exists-p)
    (file-exists-p . tramp-smb-handle-file-exists-p)
    (file-local-copy . tramp-smb-handle-file-local-copy)
160
    (file-remote-p . tramp-handle-file-remote-p)
161 162
    (file-modes . tramp-handle-file-modes)
    (file-name-all-completions . tramp-smb-handle-file-name-all-completions)
163
    (file-name-as-directory . tramp-handle-file-name-as-directory)
164 165 166
    (file-name-completion . tramp-handle-file-name-completion)
    (file-name-directory . tramp-handle-file-name-directory)
    (file-name-nondirectory . tramp-handle-file-name-nondirectory)
167
    ;; `file-name-sans-versions' performed by default handler.
168
    (file-newer-than-file-p . tramp-smb-handle-file-newer-than-file-p)
169
    (file-ownership-preserved-p . ignore)
170 171
    (file-readable-p . tramp-smb-handle-file-exists-p)
    (file-regular-p . tramp-handle-file-regular-p)
172
    (file-symlink-p . tramp-handle-file-symlink-p)
173
    ;; `file-truename' performed by default handler.
174
    (file-writable-p . tramp-smb-handle-file-writable-p)
175
    (find-backup-file-name . tramp-handle-find-backup-file-name)
176 177
    ;; `find-file-noselect' performed by default handler.
    ;; `get-file-buffer' performed by default handler.
178 179 180 181 182
    (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)
183
    (make-symbolic-link . tramp-smb-handle-make-symbolic-link)
184
    (rename-file . tramp-smb-handle-rename-file)
185 186
    (set-file-modes . tramp-smb-handle-set-file-modes)
    (set-file-times . ignore)
187 188
    (set-visited-file-modtime . ignore)
    (shell-command . ignore)
Michael Albinus's avatar
Michael Albinus committed
189
    (substitute-in-file-name . tramp-smb-handle-substitute-in-file-name)
190
    (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
191 192
    (vc-registered . ignore)
    (verify-visited-file-modtime . ignore)
193 194 195 196 197 198 199 200
    (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.")

(defun tramp-smb-file-name-p (filename)
  "Check if it's a filename for SMB servers."
  (let ((v (tramp-dissect-file-name filename)))
201
    (string= (tramp-file-name-method v) tramp-smb-method)))
202 203 204 205 206 207 208

(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
209
	(save-match-data (apply (cdr fn) args))
210 211 212 213 214 215
      (tramp-run-real-handler operation args))))

(add-to-list 'tramp-foreign-file-name-handler-alist
	     (cons 'tramp-smb-file-name-p 'tramp-smb-file-name-handler))


216 217
;; File name primitives.

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
(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)
248 249 250 251 252 253 254 255 256 257 258 259
      (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))))))
260

261 262
(defun tramp-smb-handle-copy-directory
  (dirname newname &optional keep-date parents)
263
  "Like `copy-directory' for Tramp files.  KEEP-DATE is not handled."
264 265 266 267 268
  (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
269
      (cond
270
       ;; We must use a local temporary directory.
271 272 273 274 275 276 277 278 279 280 281
       ((and t1 t2)
	(let ((tmpdir
	       (make-temp-name
		(expand-file-name
		 tramp-temp-name-prefix
		 (tramp-compat-temporary-file-directory)))))
	  (unwind-protect
	      (progn
		(copy-directory dirname tmpdir keep-date parents)
		(copy-directory tmpdir newname keep-date parents))
	    (delete-directory tmpdir 'recursive))))
282 283

       ;; We can copy recursively.
284 285
       ((or t1 t2)
	(let ((prompt (tramp-smb-send-command v "prompt"))
286
	      (recurse (tramp-smb-send-command v "recurse")))
287 288 289 290 291 292 293
	  (unless (file-directory-p newname)
	    (make-directory newname parents))
	  (unwind-protect
	      (unless
		  (and
		   prompt recurse
		   (tramp-smb-send-command
294
		    v (format "cd \"%s\"" (tramp-smb-get-localname v)))
295 296 297 298 299 300 301 302 303 304 305 306
		   (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))))
307
	    ;; Go home.
308 309 310
	    (tramp-smb-send-command
	     v (format
		"cd %s" (if (tramp-smb-get-cifs-capabilities v) "/" "\\")))
311 312 313
	    ;; Toggle prompt and recurse OFF.
	    (if prompt (tramp-smb-send-command v "prompt"))
	    (if recurse (tramp-smb-send-command v "recurse")))))
314 315

       ;; We must do it file-wise.
316
       (t
317
	(tramp-run-real-handler
318
	 'copy-directory (list dirname newname keep-date parents)))))))
319 320

(defun tramp-smb-handle-copy-file
321
  (filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
322
  "Like `copy-file' for Tramp files.
323 324
KEEP-DATE is not handled in case NEWNAME resides on an SMB server.
PRESERVE-UID-GID is completely ignored."
325 326 327 328 329 330
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))

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

    (if tmpfile
331
	;; Remote filename.
332 333
	(condition-case err
	    (rename-file tmpfile newname ok-if-already-exists)
334 335 336
	  ((error quit)
	   (delete-file tmpfile)
	   (signal (car err) (cdr err))))
337

338
      ;; Remote newname.
339 340 341 342
      (when (file-directory-p newname)
	(setq newname (expand-file-name
		       (file-name-nondirectory filename) newname)))

Michael Albinus's avatar
Michael Albinus committed
343
      (with-parsed-tramp-file-name newname nil
344 345 346 347 348
	(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
349
	;; `file-attributes' reads the values from there.
350 351
	(tramp-flush-file-property v (file-name-directory localname))
	(tramp-flush-file-property v localname)
352 353 354 355 356 357 358 359 360 361
	(unless (tramp-smb-get-share v)
	  (tramp-error
	   v 'file-error "Target `%s' must contain a share name" newname))
	(tramp-message v 0 "Copying file %s to file %s..." filename newname)
	(if (tramp-smb-send-command
	     v (format "put \"%s\" \"%s\""
		       filename (tramp-smb-get-localname v)))
	    (tramp-message
	     v 0 "Copying file %s to file %s...done" filename newname)
	  (tramp-error v 'file-error "Cannot copy `%s'" filename)))))
362 363 364

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

366
(defun tramp-smb-handle-delete-directory (directory &optional recursive)
367
  "Like `delete-directory' for Tramp files."
368
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
369
  (when (file-exists-p directory)
370 371 372 373 374 375 376 377 378
    (if 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 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")))
379

Michael Albinus's avatar
Michael Albinus committed
380
    (with-parsed-tramp-file-name directory nil
381
      ;; We must also flush the cache of the directory, because
382
      ;; `file-attributes' reads the values from there.
383 384
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-directory-property v localname)
385 386 387 388 389 390 391 392 393 394 395
      (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))))))
396 397

(defun tramp-smb-handle-delete-file (filename)
398
  "Like `delete-file' for Tramp files."
399
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
400 401
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
402
      ;; We must also flush the cache of the directory, because
403
      ;; `file-attributes' reads the values from there.
404 405
      (tramp-flush-file-property v (file-name-directory localname))
      (tramp-flush-file-property v localname)
406 407 408 409 410 411 412 413 414 415 416
      (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))))))
417 418 419

(defun tramp-smb-handle-directory-files
  (directory &optional full match nosort)
420 421 422
  "Like `directory-files' for Tramp files."
  (let ((result (mapcar 'directory-file-name
			(file-name-all-completions "" directory))))
423
    ;; Discriminate with regexp.
424 425 426 427 428
    (when match
      (setq result
	    (delete nil
		    (mapcar (lambda (x) (when (string-match match x) x))
			    result))))
429
    ;; Append directory.
430 431 432 433 434
    (when full
      (setq result
	    (mapcar
	     (lambda (x) (expand-file-name x directory))
	     result)))
435
    ;; Sort them if necessary.
436
    (unless nosort (setq result (sort result 'string-lessp)))
437
    ;; That's it.
438
    result))
439 440

(defun tramp-smb-handle-directory-files-and-attributes
441
  (directory &optional full match nosort id-format)
442
  "Like `directory-files-and-attributes' for Tramp files."
443 444
  (mapcar
   (lambda (x)
445
     (cons x (tramp-compat-file-attributes
446
	      (if full x (expand-file-name x directory)) id-format)))
447
   (directory-files directory full match nosort)))
448

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

479
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
480
  "Like `file-attributes' for Tramp files."
481
  (unless id-format (setq id-format 'integer))
Michael Albinus's avatar
Michael Albinus committed
482
  (with-parsed-tramp-file-name filename nil
483
    (with-file-property v localname (format "file-attributes-%s" id-format)
484
      (if (and (tramp-smb-get-share v) (tramp-smb-get-stat-capability v))
485
	  (tramp-smb-do-file-attributes-with-stat v id-format)
486 487 488 489 490 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
	;; 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

516
(defun tramp-smb-do-file-attributes-with-stat (vec &optional id-format)
517
  "Implement `file-attributes' for Tramp files using stat command."
518 519
  (tramp-message
   vec 5 "file attributes with stat: %s" (tramp-file-name-localname vec))
520
  (with-current-buffer (tramp-get-buffer vec)
521
    (let* (size id link uid gid atime mtime ctime mode inode)
522 523 524 525 526 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
      (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)))))))
580 581

(defun tramp-smb-handle-file-directory-p (filename)
582 583 584
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
       (eq ?d (aref (nth 8 (file-attributes filename)) 0))))
585 586

(defun tramp-smb-handle-file-exists-p (filename)
587 588
  "Like `file-exists-p' for Tramp files."
  (not (null (file-attributes filename))))
589 590

(defun tramp-smb-handle-file-local-copy (filename)
591
  "Like `file-local-copy' for Tramp files."
592
  (with-parsed-tramp-file-name filename nil
593 594 595 596
    (unless (file-exists-p filename)
      (tramp-error
       v 'file-error
       "Cannot make local copy of non-existing file `%s'" filename))
597
    (let ((tmpfile (tramp-compat-make-temp-file filename)))
598
      (tramp-message v 4 "Fetching %s to tmp file %s..." filename tmpfile)
599 600
      (if (tramp-smb-send-command
	   v (format "get \"%s\" \"%s\"" (tramp-smb-get-localname v) tmpfile))
601
	  (tramp-message
602
	   v 4 "Fetching %s to tmp file %s...done" filename tmpfile)
603 604
	;; Oops, an error.  We shall cleanup.
	(delete-file tmpfile)
605
	(tramp-error
606
	 v 'file-error "Cannot make local copy of file `%s'" filename))
607
      tmpfile)))
608 609 610 611

;; This function should return "foo/" for directories and "bar" for
;; files.
(defun tramp-smb-handle-file-name-all-completions (filename directory)
612 613 614 615 616 617 618
  "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)))
619 620 621 622 623 624 625 626 627
	   (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-newer-than-file-p (file1 file2)
628
  "Like `file-newer-than-file-p' for Tramp files."
629 630 631
  (cond
   ((not (file-exists-p file1)) nil)
   ((not (file-exists-p file2)) t)
632 633
   (t (tramp-time-less-p (nth 5 (file-attributes file2))
			 (nth 5 (file-attributes file1))))))
634 635

(defun tramp-smb-handle-file-writable-p (filename)
636 637 638 639 640 641
  "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)))))
642 643 644

(defun tramp-smb-handle-insert-directory
  (filename switches &optional wildcard full-directory-p)
645
  "Like `insert-directory' for Tramp files."
646
  (setq filename (expand-file-name filename))
647 648
  (when full-directory-p
    ;; Called from `dired-add-entry'.
649
    (setq filename (file-name-as-directory filename)))
Michael Albinus's avatar
Michael Albinus committed
650
  (with-parsed-tramp-file-name filename nil
651
    (save-match-data
652
      (let ((base (file-name-nondirectory filename))
653 654 655 656 657 658 659 660 661 662 663 664 665 666
	    ;; 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.
667
	(setq entries
668 669 670 671 672 673 674 675 676 677 678 679
	      (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)))))
680

Michael Albinus's avatar
Michael Albinus committed
681
	;; Sort entries.
682 683 684 685 686
	(setq entries
	      (sort
	       entries
	       (lambda (x y)
		 (if (string-match "t" switches)
687 688 689
		     ;; Sort by date.
		     (tramp-time-less-p (nth 3 y) (nth 3 x))
		   ;; Sort by name.
690 691
		   (string-lessp (nth 0 x) (nth 0 y))))))

Michael Albinus's avatar
Michael Albinus committed
692 693
	;; Handle "-F" switch.
	(when (string-match "F" switches)
694
	  (mapc
Michael Albinus's avatar
Michael Albinus committed
695 696 697 698 699 700 701 702 703
	   (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))

704
	;; Print entries.
705
	(mapc
706
	 (lambda (x)
707
	   (when (not (zerop (length (nth 0 x))))
708
	     (let ((attr
709
		    (when (tramp-smb-get-stat-capability v)
710 711 712
		      (ignore-errors
			(file-attributes
			 (expand-file-name (nth 0 x)) 'string)))))
713 714
	       (insert
		(format
715
		 "%10s %3d %-8s %-8s %8s %s "
716
		 (or (nth 8 attr) (nth 1 x)) ; mode
717
		 (or (nth 1 attr) 1) ; inode
718 719
		 (or (nth 2 attr) "nobody") ; uid
		 (or (nth 3 attr) "nogroup") ; gid
720
		 (or (nth 7 attr) (nth 2 x)) ; size
721 722 723 724 725 726
		 (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")
727 728 729 730 731
		  (nth 3 x)))) ; date
	       ;; We mark the filename.
	       (let ((start (point)))
		 (insert (format "%s\n" (nth 0 x))) ; file name
		 (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 769 770
	       (format
		"posix_mkdir \"%s\" %s"
		file (tramp-decimal-to-octal (default-file-modes)))
	     (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 836 837 838 839
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))

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

    (if tmpfile
840 841 842
	;; Remote filename.
	(condition-case err
	    (rename-file tmpfile newname ok-if-already-exists)
843 844 845
	  ((error quit)
	   (delete-file tmpfile)
	   (signal (car err) (cdr err))))
846

847
      ;; Remote newname.
848 849 850 851
      (when (file-directory-p newname)
	(setq newname (expand-file-name
		      (file-name-nondirectory filename) newname)))

Michael Albinus's avatar
Michael Albinus committed
852
      (with-parsed-tramp-file-name newname nil
853 854 855 856
	(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
857
	;; `file-attributes' reads the values from there.
858 859
	(tramp-flush-file-property v (file-name-directory localname))
	(tramp-flush-file-property v localname)
860 861 862 863 864 865
	(tramp-message v 0 "Copying file %s to file %s..." filename newname)
	(if (tramp-smb-send-command
	     v (format "put %s \"%s\"" filename (tramp-smb-get-localname v)))
	    (tramp-message
	     v 0 "Copying file %s to file %s...done" filename newname)
	  (tramp-error v 'file-error "Cannot rename `%s'" filename)))))
866 867 868

  (delete-file filename))

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

Michael Albinus's avatar
Michael Albinus committed
881
(defun tramp-smb-handle-substitute-in-file-name (filename)
882
  "Like `handle-substitute-in-file-name' for Tramp files.
883 884 885 886 887 888 889 890
\"//\" 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
891 892 893 894
  (condition-case nil
      (tramp-run-real-handler 'substitute-in-file-name (list filename))
    (error filename)))

895 896
(defun tramp-smb-handle-write-region
  (start end filename &optional append visit lockname confirm)
897
  "Like `write-region' for Tramp files."
898
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
899
  (with-parsed-tramp-file-name filename nil
900 901
    (unless (eq append nil)
      (tramp-error
902
	 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
903
    ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
904 905 906 907 908 909
    (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
910
    ;; `file-attributes' reads the values from there.
911 912
    (tramp-flush-file-property v (file-name-directory localname))
    (tramp-flush-file-property v localname)
913
    (let ((curbuf (current-buffer))
914
	  (tmpfile (tramp-compat-make-temp-file filename)))
915 916 917 918 919 920
      ;; 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.
921 922
	   (list start end tmpfile append 'no-message lockname confirm)
	 (list start end tmpfile append 'no-message lockname)))
923

924
      (tramp-message v 5 "Writing tmp file %s to file %s..." tmpfile filename)
925
      (unwind-protect
926 927
	  (if (tramp-smb-send-command
	       v (format "put %s \"%s\"" tmpfile (tramp-smb-get-localname v)))
928 929 930 931
	      (tramp-message
	       v 5 "Writing tmp file %s to file %s...done" tmpfile filename)
	    (tramp-error v 'file-error "Cannot write `%s'" filename))
	(delete-file tmpfile))
932 933 934 935 936 937 938

      (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)))))
939 940


941
;; Internal file name functions.
942

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

950
(defun tramp-smb-get-localname (vec)
Kai Großjohann's avatar
Kai Großjohann committed
951
  "Returns the file name of LOCALNAME.
952
If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"."
953
  (save-match-data
954
    (let ((localname (tramp-file-name-localname vec)))
955
      (setq
956 957 958 959 960 961 962 963 964 965 966 967
       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)
	   "")))
Kai Großjohann's avatar