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

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

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

109 110 111 112 113 114 115 116 117 118
(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.")
119

120 121 122 123 124 125 126
(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.
127

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

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

(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
204
	(save-match-data (apply (cdr fn) args))
205 206 207 208 209 210
      (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))


211 212 213 214 215 216 217 218 219 220
;; File name primitives.

(defun tramp-smb-handle-copy-directory
  (dirname newname &optional keep-date parents)
  "Like `copy-directory' for Tramp files."
  (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
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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
      (cond
       ((and t1 t2)
	;; We must copy, using a local temporary directory.
	(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))))
       ((or t1 t2)
	;; We can copy recursively.
	(let ((prompt (tramp-smb-send-command v "prompt"))
	      (recurse (tramp-smb-send-command v "recurse")))
	  (unless (file-directory-p newname)
	    (make-directory newname parents))
	  (unwind-protect
	      (unless
		  (and
		   prompt recurse
		   (tramp-smb-send-command
		    v (format "cd \"%s\""
			      (tramp-smb-get-localname localname t)))
		   (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))))
	    ;; Always go home.
	    (tramp-smb-send-command v (format "cd \\"))
	    ;; Toggle prompt and recurse OFF.
	    (if prompt (tramp-smb-send-command v "prompt"))
	    (if recurse (tramp-smb-send-command v "recurse")))))
       (t
265 266
	;; We must do it file-wise.
	(tramp-run-real-handler
267
	 'copy-directory (list dirname newname keep-date parents)))))))
268 269

(defun tramp-smb-handle-copy-file
270
  (filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
271
  "Like `copy-file' for Tramp files.
272 273
KEEP-DATE is not handled in case NEWNAME resides on an SMB server.
PRESERVE-UID-GID is completely ignored."
274 275 276 277 278 279
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))

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

    (if tmpfile
280
	;; Remote filename.
281 282
	(condition-case err
	    (rename-file tmpfile newname ok-if-already-exists)
283 284 285
	  ((error quit)
	   (delete-file tmpfile)
	   (signal (car err) (cdr err))))
286

287
      ;; Remote newname.
288 289 290 291
      (when (file-directory-p newname)
	(setq newname (expand-file-name
		       (file-name-nondirectory filename) newname)))

Michael Albinus's avatar
Michael Albinus committed
292
      (with-parsed-tramp-file-name newname nil
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
	(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)
	(let ((share (tramp-smb-get-share localname))
	      (file (tramp-smb-get-localname localname t)))
	  (unless share
	    (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 file))
	      (tramp-message
	       v 0 "Copying file %s to file %s...done" filename newname)
311 312 313 314
	    (tramp-error v 'file-error "Cannot copy `%s'" filename))))))

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

316
(defun tramp-smb-handle-delete-directory (directory &optional recursive)
317
  "Like `delete-directory' for Tramp files."
318
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
319
  (when (file-exists-p directory)
320 321 322 323 324 325 326 327 328
    (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 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")))
Michael Albinus's avatar
Michael Albinus committed
329
    (with-parsed-tramp-file-name directory nil
330 331 332 333 334 335 336 337 338 339
      ;; 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-directory-property v localname)
      (let ((dir (tramp-smb-get-localname (file-name-directory localname) t))
	    (file (file-name-nondirectory localname)))
	(unwind-protect
	    (unless (and
		     (tramp-smb-send-command v (format "cd \"%s\"" dir))
		     (tramp-smb-send-command v (format "rmdir \"%s\"" file)))
340
	      ;; Error.
341 342 343 344 345
	      (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)))
346
	  ;; Always go home.
347
	  (tramp-smb-send-command v (format "cd \\")))))))
348 349

(defun tramp-smb-handle-delete-file (filename)
350
  "Like `delete-file' for Tramp files."
351
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
352 353
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
354 355 356 357 358 359 360 361 362 363
      ;; 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)
      (let ((dir (tramp-smb-get-localname (file-name-directory localname) t))
	    (file (file-name-nondirectory localname)))
	(unwind-protect
	    (unless (and
		     (tramp-smb-send-command v (format "cd \"%s\"" dir))
		     (tramp-smb-send-command v (format "rm \"%s\"" file)))
364
	      ;; Error.
365 366 367 368 369
	      (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)))
370
	  ;; Always go home.
371
	  (tramp-smb-send-command v (format "cd \\")))))))
372 373 374

(defun tramp-smb-handle-directory-files
  (directory &optional full match nosort)
375 376 377
  "Like `directory-files' for Tramp files."
  (let ((result (mapcar 'directory-file-name
			(file-name-all-completions "" directory))))
378
    ;; Discriminate with regexp.
379 380 381 382 383
    (when match
      (setq result
	    (delete nil
		    (mapcar (lambda (x) (when (string-match match x) x))
			    result))))
384
    ;; Append directory.
385 386 387 388 389
    (when full
      (setq result
	    (mapcar
	     (lambda (x) (expand-file-name x directory))
	     result)))
390
    ;; Sort them if necessary.
391
    (unless nosort (setq result (sort result 'string-lessp)))
392
    ;; That's it.
393
    result))
394 395

(defun tramp-smb-handle-directory-files-and-attributes
396
  (directory &optional full match nosort id-format)
397
  "Like `directory-files-and-attributes' for Tramp files."
398 399
  (mapcar
   (lambda (x)
400
     (cons x (tramp-compat-file-attributes
401
	      (if full x (expand-file-name x directory)) id-format)))
402
   (directory-files directory full match nosort)))
403

404 405 406 407 408 409 410 411 412 413 414 415 416
(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,
417 418
      ;; which is offen the case in domains.
      (when (string-match "\\`/?~\\([^/]*\\)" localname)
419 420
	(setq localname
	      (replace-match
421
	       (if (zerop (length (match-string 1 localname)))
422
		   (tramp-file-name-real-user v)
423
		 (match-string 1 localname))
424
	       nil nil localname)))
425 426 427
      ;; Make the file name absolute.
      (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
	(setq localname (concat "/" localname)))
428 429 430 431 432 433
      ;; 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))))))

434
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
435 436 437 438 439 440
  "Like `file-attributes' for Tramp files."
  ;; 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.
Michael Albinus's avatar
Michael Albinus committed
441
  (with-parsed-tramp-file-name filename nil
442 443 444
    (with-file-property v localname (format "file-attributes-%s" id-format)
      (let* ((entries (tramp-smb-get-file-entries
		       (file-name-directory filename)))
445
	     (entry (assoc (file-name-nondirectory filename) entries))
446 447
	     (uid (if (and id-format (equal id-format 'string)) "nobody" -1))
	     (gid (if (and id-format (equal id-format 'string)) "nogroup" -1))
448
	     (inode (tramp-get-inode v))
449
	     (device (tramp-get-device v)))
450

451
        ;; Check result.
452 453
	(when entry
	  (list (and (string-match "d" (nth 1 entry))
454 455 456 457 458 459 460 461 462 463 464 465
		     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
466 467

(defun tramp-smb-handle-file-directory-p (filename)
468 469 470
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
       (eq ?d (aref (nth 8 (file-attributes filename)) 0))))
471 472

(defun tramp-smb-handle-file-exists-p (filename)
473 474
  "Like `file-exists-p' for Tramp files."
  (not (null (file-attributes filename))))
475 476

(defun tramp-smb-handle-file-local-copy (filename)
477
  "Like `file-local-copy' for Tramp files."
478
  (with-parsed-tramp-file-name filename nil
479 480 481 482
    (unless (file-exists-p filename)
      (tramp-error
       v 'file-error
       "Cannot make local copy of non-existing file `%s'" filename))
483
    (let ((file (tramp-smb-get-localname localname t))
484
	  (tmpfile (tramp-compat-make-temp-file filename)))
485 486
      (tramp-message v 4 "Fetching %s to tmp file %s..." filename tmpfile)
      (if (tramp-smb-send-command v (format "get \"%s\" %s" file tmpfile))
487
	  (tramp-message
488
	   v 4 "Fetching %s to tmp file %s...done" filename tmpfile)
489 490
	;; Oops, an error.  We shall cleanup.
	(delete-file tmpfile)
491 492 493
	(tramp-error
	 v 'file-error
	 "Cannot make local copy of file `%s'" filename))
494
      tmpfile)))
495 496 497 498

;; This function should return "foo/" for directories and "bar" for
;; files.
(defun tramp-smb-handle-file-name-all-completions (filename directory)
499 500 501 502 503 504 505
  "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)))
506 507 508 509 510 511 512 513 514
	   (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)
515
  "Like `file-newer-than-file-p' for Tramp files."
516 517 518
  (cond
   ((not (file-exists-p file1)) nil)
   ((not (file-exists-p file2)) t)
519 520
   (t (tramp-time-less-p (nth 5 (file-attributes file2))
			 (nth 5 (file-attributes file1))))))
521 522

(defun tramp-smb-handle-file-writable-p (filename)
523 524 525 526 527 528
  "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)))))
529 530 531

(defun tramp-smb-handle-insert-directory
  (filename switches &optional wildcard full-directory-p)
532
  "Like `insert-directory' for Tramp files."
533
  (setq filename (expand-file-name filename))
534 535
  (when full-directory-p
    ;; Called from `dired-add-entry'.
536
    (setq filename (file-name-as-directory filename)))
Michael Albinus's avatar
Michael Albinus committed
537
  (with-parsed-tramp-file-name filename nil
538
    (save-match-data
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
      (let ((base (file-name-nondirectory filename))
	    ;; 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.
554
	(setq entries
555 556 557 558 559 560 561 562 563 564 565 566
	      (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)))))
567

Michael Albinus's avatar
Michael Albinus committed
568
	;; Sort entries.
569 570 571 572 573
	(setq entries
	      (sort
	       entries
	       (lambda (x y)
		 (if (string-match "t" switches)
574 575 576
		     ;; Sort by date.
		     (tramp-time-less-p (nth 3 y) (nth 3 x))
		   ;; Sort by name.
577 578
		   (string-lessp (nth 0 x) (nth 0 y))))))

Michael Albinus's avatar
Michael Albinus committed
579 580
	;; Handle "-F" switch.
	(when (string-match "F" switches)
581
	  (mapc
Michael Albinus's avatar
Michael Albinus committed
582 583 584 585 586 587 588 589 590
	   (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))

591
	;; Print entries.
592 593
	(mapcar
	 (lambda (x)
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
	   (when (not (zerop (length (nth 0 x))))
	     (insert
	      (format
	       "%10s %3d %-8s %-8s %8s %s %s\n"
	       (nth 1 x) ; mode
	       1 "nobody" "nogroup"
	       (nth 2 x) ; size
	       (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")
		(nth 3 x)) ; date
	       (nth 0 x))) ; file name
	     (forward-line)
	     (beginning-of-line)))
	   entries)))))
612 613

(defun tramp-smb-handle-make-directory (dir &optional parents)
614
  "Like `make-directory' for Tramp files."
615 616
  (setq dir (directory-file-name (expand-file-name dir)))
  (unless (file-name-absolute-p dir)
617
    (setq dir (expand-file-name dir default-directory)))
Michael Albinus's avatar
Michael Albinus committed
618
  (with-parsed-tramp-file-name dir nil
619
    (save-match-data
Kai Großjohann's avatar
Kai Großjohann committed
620
      (let* ((share (tramp-smb-get-share localname))
621
	     (ldir (file-name-directory dir)))
622
	;; Make missing directory parts.
623 624
	(when (and parents share (not (file-directory-p ldir)))
	  (make-directory ldir parents))
625
	;; Just do it.
626
	(when (file-directory-p ldir)
627
	  (make-directory-internal dir))
628
	(unless (file-directory-p dir)
629
	  (tramp-error v 'file-error "Couldn't make directory %s" dir))))))
630 631

(defun tramp-smb-handle-make-directory-internal (directory)
632
  "Like `make-directory-internal' for Tramp files."
633 634
  (setq directory (directory-file-name (expand-file-name directory)))
  (unless (file-name-absolute-p directory)
635
    (setq directory (expand-file-name directory default-directory)))
Michael Albinus's avatar
Michael Albinus committed
636
  (with-parsed-tramp-file-name directory nil
637
    (save-match-data
638
      (let* ((file (tramp-smb-get-localname localname t)))
639
	(when (file-directory-p (file-name-directory directory))
640 641 642
	  (tramp-smb-send-command v (format "mkdir \"%s\"" file))
	  ;; We must also flush the cache of the directory, because
	  ;; file-attributes reads the values from there.
Michael Albinus's avatar
Michael Albinus committed
643
	  (tramp-flush-file-property v localname)
644
	  (tramp-flush-file-property v (file-name-directory localname)))
645
	(unless (file-directory-p directory)
646 647
	  (tramp-error
	   v 'file-error "Couldn't make directory %s" directory))))))
648 649 650

(defun tramp-smb-handle-rename-file
  (filename newname &optional ok-if-already-exists)
651
  "Like `rename-file' for Tramp files."
652 653 654 655 656 657
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))

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

    (if tmpfile
658 659 660
	;; Remote filename.
	(condition-case err
	    (rename-file tmpfile newname ok-if-already-exists)
661 662 663
	  ((error quit)
	   (delete-file tmpfile)
	   (signal (car err) (cdr err))))
664

665
      ;; Remote newname.
666 667 668 669
      (when (file-directory-p newname)
	(setq newname (expand-file-name
		      (file-name-nondirectory filename) newname)))

Michael Albinus's avatar
Michael Albinus committed
670
      (with-parsed-tramp-file-name newname nil
671 672 673 674 675 676 677 678 679 680 681 682 683
	(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)
	(let ((file (tramp-smb-get-localname localname t)))
	  (tramp-message v 0 "Copying file %s to file %s..." filename newname)
	  (if (tramp-smb-send-command v (format "put %s \"%s\"" filename file))
	      (tramp-message
	       v 0 "Copying file %s to file %s...done" filename newname)
	    (tramp-error v 'file-error "Cannot rename `%s'" filename))))))
684 685 686

  (delete-file filename))

687 688 689 690 691 692 693 694 695 696 697
(defun tramp-smb-handle-set-file-modes (filename mode)
  "Like `set-file-modes' for Tramp files."
  (with-parsed-tramp-file-name filename nil
    (tramp-flush-file-property v localname)
    (unless (tramp-smb-send-command
	     v (format "chmod \"%s\" %s"
		       (tramp-smb-get-localname localname t)
		       (tramp-decimal-to-octal mode)))
      (tramp-error
       v 'file-error "Error while changing file's mode %s" filename))))

Michael Albinus's avatar
Michael Albinus committed
698
(defun tramp-smb-handle-substitute-in-file-name (filename)
699
  "Like `handle-substitute-in-file-name' for Tramp files.
700 701 702 703 704 705 706 707
\"//\" 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
708 709 710 711
  (condition-case nil
      (tramp-run-real-handler 'substitute-in-file-name (list filename))
    (error filename)))

712 713
(defun tramp-smb-handle-write-region
  (start end filename &optional append visit lockname confirm)
714
  "Like `write-region' for Tramp files."
715
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
716
  (with-parsed-tramp-file-name filename nil
717 718
    (unless (eq append nil)
      (tramp-error
719
	 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
720
    ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
721 722 723 724 725 726
    (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
727
    ;; `file-attributes' reads the values from there.
728 729 730 731
    (tramp-flush-file-property v (file-name-directory localname))
    (tramp-flush-file-property v localname)
    (let ((file (tramp-smb-get-localname localname t))
	  (curbuf (current-buffer))
732
	  (tmpfile (tramp-compat-make-temp-file filename)))
733 734 735 736 737 738
      ;; 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.
739 740
	   (list start end tmpfile append 'no-message lockname confirm)
	 (list start end tmpfile append 'no-message lockname)))
741

742
      (tramp-message v 5 "Writing tmp file %s to file %s..." tmpfile filename)
743 744 745 746 747 748
      (unwind-protect
	  (if (tramp-smb-send-command v (format "put %s \"%s\"" tmpfile file))
	      (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))
749 750 751 752 753 754 755

      (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)))))
756 757


758
;; Internal file name functions.
759

Kai Großjohann's avatar
Kai Großjohann committed
760 761
(defun tramp-smb-get-share (localname)
  "Returns the share name of LOCALNAME."
762
  (save-match-data
Kai Großjohann's avatar
Kai Großjohann committed
763 764
    (when (string-match "^/?\\([^/]+\\)/" localname)
      (match-string 1 localname))))
765

Kai Großjohann's avatar
Kai Großjohann committed
766 767
(defun tramp-smb-get-localname (localname convert)
  "Returns the file name of LOCALNAME.
768 769
If CONVERT is non-nil exchange \"/\" by \"\\\\\"."
  (save-match-data
Kai Großjohann's avatar
Kai Großjohann committed
770
    (let ((res localname))
771 772 773 774 775 776 777 778 779 780 781 782

      (setq
       res (if (string-match "^/?[^/]+/\\(.*\\)" res)
	       (if convert
		   (mapconcat
		    (lambda (x) (if (equal x ?/) "\\" (char-to-string x)))
		    (match-string 1 res) "")
		 (match-string 1 res))
	     (if (string-match "^/?\\([^/]+\\)$" res)
		 (match-string 1 res)
	       "")))

783
      ;; Sometimes we have discarded `substitute-in-file-name'.
784 785 786 787 788 789 790
      (when (string-match "\\(\\$\\$\\)\\(/\\|$\\)" res)
	(setq res (replace-match "$" nil nil res 1)))

      res)))

;; Share names of a host are cached. It is very unlikely that the
;; shares do change during connection.
791 792
(defun tramp-smb-get-file-entries (directory)
  "Read entries which match DIRECTORY.
793
Either the shares are listed, or the `dir' command is executed.
Kai Großjohann's avatar
Kai Großjohann committed
794
Result is a list of (LOCALNAME MODE SIZE MONTH DAY TIME YEAR)."
795 796 797 798 799 800 801 802 803 804
  (with-parsed-tramp-file-name directory nil
    (setq localname (or localname "/"))
    (with-file-property v localname "file-entries"
      (with-current-buffer (tramp-get-buffer v)
	(let* ((share (tramp-smb-get-share localname))
	       (file (tramp-smb-get-localname localname nil))
	       (cache (tramp-get-connection-property v "share-cache" nil))
	       res entry)

	  (if (and (not share) cache)
805
	      ;; Return cached shares.
806 807
	      (setq res cache)

808
	    ;; Read entries.
809 810 811 812 813
	    (setq file (file-name-as-directory file))
	    (when (string-match "^\\./" file)
	      (setq file (substring file 1)))
	    (if share
		(tramp-smb-send-command v (format "dir \"%s*\"" file))
814
	      ;; `tramp-smb-maybe-open-connection' lists also the share names.
815 816
	      (tramp-smb-maybe-open-connection v))

817
	    ;; Loop the listing.
818 819 820 821 822 823 824
	    (goto-char (point-min))
	    (unless (re-search-forward tramp-smb-errors nil t)
	      (while (not (eobp))
		(setq entry (tramp-smb-read-file-entry share))
		(forward-line)
		(when entry (add-to-list 'res entry))))

825
	    ;; Cache share entries.
826 827
	    (unless share
	      (tramp-set-connection-property v "share-cache" res)))
828

829
	  ;; Add directory itself.
830
	  (add-to-list 'res '("" "drwxrwxrwx" 0 (0 0)))
831

832 833 834
	  ;; There's a very strange error (debugged with XEmacs 21.4.14)
	  ;; If there's no short delay, it returns nil.  No idea about.
	  (when (featurep 'xemacs) (sleep-for 0.01))
835

836
	  ;; Return entries.
837
	  (delq nil res))))))
838

839
;; Return either a share name (if SHARE is nil), or a file name.
840
;;
841
;; If shares are listed, the following format is expected:
842 843 844 845 846 847 848 849 850 851 852
;;
;; \s-\{8,8}                              - leading spaces
;; \S-\(.*\S-\)\s-*                       - share name, 14 char
;; \s-                                    - space delimeter
;; \S-+\s-*                               - type, 8 char, "Disk    " expected
;; \(\s-\{2,2\}.*\)?                      - space delimeter, comment
;;
;; Entries provided by smbclient DIR aren't fully regular.
;; They should have the format
;;
;; \s-\{2,2}                              - leading spaces
853 854
;; \S-\(.*\S-\)\s-*                       - file name, 30 chars, left bound
;; \s-+[ADHRSV]*                          - permissions, 7 chars, right bound
855
;; \s-                                    - space delimeter
856
;; \s-+[0-9]+                             - size, 8 chars, right bound
857 858 859
;; \s-\{2,2\}                             - space delimeter
;; \w\{3,3\}                              - weekday
;; \s-                                    - space delimeter
860 861
;; \w\{3,3\}                              - month
;; \s-                                    - space delimeter
862
;; [ 12][0-9]                             - day
863 864 865 866 867
;; \s-                                    - space delimeter
;; [0-9]\{2,2\}:[0-9]\{2,2\}:[0-9]\{2,2\} - time
;; \s-                                    - space delimeter
;; [0-9]\{4,4\}                           - year
;;
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
;; samba/src/client.c (http://samba.org/doxygen/samba/client_8c-source.html)
;; has function display_finfo:
;;
;;   d_printf("  %-30s%7.7s %8.0f  %s",
;;            finfo->name,
;;            attrib_string(finfo->mode),
;;            (double)finfo->size,
;;            asctime(LocalTime(&t)));
;;
;; in Samba 1.9, there's the following code:
;;
;;   DEBUG(0,("  %-30s%7.7s%10d  %s",
;;  	   CNV_LANG(finfo->name),
;;	   attrib_string(finfo->mode),
;;	   finfo->size,
;;	   asctime(LocalTime(&t))));
;;
885 886 887 888 889 890 891 892 893 894 895
;; Problems:
;; * Modern regexp constructs, like spy groups and counted repetitions, aren't
;;   available in older Emacsen.
;; * The length of constructs (file name, size) might exceed the default.
;; * File names might contain spaces.
;; * Permissions might be empty.
;;
;; So we try to analyze backwards.
(defun tramp-smb-read-file-entry (share)
  "Parse entry in SMB output buffer.
If SHARE is result, entries are of type dir. Otherwise, shares are listed.
Kai Großjohann's avatar
Kai Großjohann committed
896
Result is the list (LOCALNAME MODE SIZE MTIME)."
897 898
;; We are called from `tramp-smb-get-file-entries', which sets the
;; current buffer.
899
  (let ((line (buffer-substring (point) (tramp-compat-line-end-position)))
Kai Großjohann's avatar
Kai Großjohann committed
900
	localname mode size month day hour min sec year mtime)
901 902 903

    (if (not share)

904 905
	;; Read share entries.
	(when (string-match "^\\s-+\\(\\S-\\(.*\\S-\\)?\\)\\s-+Disk" line)
Kai Großjohann's avatar
Kai Großjohann committed
906
	  (setq localname (match-string 1 line)
907 908 909
		mode "dr-xr-xr-x"
		size 0))

910
      ;; Real listing.
911 912
      (block nil

913
	;; year.
914 915 916 917 918
	(if (string-match "\\([0-9]+\\)$" line)
	    (setq year (string-to-number (match-string 1 line))
		  line (substring line 0 -5))
	  (return))

919
	;; time.
920 921 922 923 924 925 926
	(if (string-match "\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)$" line)
	    (setq hour (string-to-number (match-string 1 line))
		  min  (string-to-number (match-string 2 line))
		  sec  (string-to-number (match-string 3 line))
		  line (substring line 0 -9))
	  (return))

927
	;; day.
928 929 930 931 932
	(if (string-match "\\([0-9]+\\)$" line)
	    (setq day  (string-to-number (match-string 1 line))
		  line (substring line 0 -3))
	  (return))

933
	;; month.
934 935 936 937 938
	(if (string-match "\\(\\w+\\)$" line)
	    (setq month (match-string 1 line)
		  line  (substring line 0 -4))
	  (return))

939
	;; weekday.
940 941 942 943
	(if (string-match "\\(\\w+\\)$" line)
	    (setq line (substring line 0 -5))
	  (return))

944
	;; size.
945
	(if (string-match "\\([0-9]+\\)$" line)
946 947 948 949 950
	    (let ((length (- (max 10 (1+ (length (match-string 1 line)))))))
	      (setq size (string-to-number (match-string 1 line)))
	      (when (string-match "\\([ADHRSV]+\\)" (substring line length))
		(setq length (+ length (match-end 0))))
	      (setq line (substring line 0 length)))
951 952
	  (return))

953
	;; mode: ARCH, DIR, HIDDEN, RONLY, SYSTEM, VOLID.
954
	(if (string-match "\\([ADHRSV]+\\)?$" line)
955
	    (setq