tramp-smb.el 41.9 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 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
;; 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
      (if (or (null t1) (null 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"))))

	;; We must do it file-wise.
	(tramp-run-real-handler
	 'copy-directory (list dirname newname keep-date parents))))))
255 256

(defun tramp-smb-handle-copy-file
257
  (filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
258
  "Like `copy-file' for Tramp files.
259 260
KEEP-DATE is not handled in case NEWNAME resides on an SMB server.
PRESERVE-UID-GID is completely ignored."
261 262 263 264 265 266
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))

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

    (if tmpfile
267
	;; Remote filename.
268 269
	(condition-case err
	    (rename-file tmpfile newname ok-if-already-exists)
270 271 272
	  ((error quit)
	   (delete-file tmpfile)
	   (signal (car err) (cdr err))))
273

274
      ;; Remote newname.
275 276 277 278
      (when (file-directory-p newname)
	(setq newname (expand-file-name
		       (file-name-nondirectory filename) newname)))

Michael Albinus's avatar
Michael Albinus committed
279
      (with-parsed-tramp-file-name newname nil
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
	(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)
298 299 300 301
	    (tramp-error v 'file-error "Cannot copy `%s'" filename))))))

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

303
(defun tramp-smb-handle-delete-directory (directory &optional recursive)
304
  "Like `delete-directory' for Tramp files."
305
  (setq directory (directory-file-name (expand-file-name directory)))
Michael Albinus's avatar
Michael Albinus committed
306
  (when (file-exists-p directory)
307 308 309 310 311 312 313 314 315
    (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
316
    (with-parsed-tramp-file-name directory nil
317 318 319 320 321 322 323 324 325 326
      ;; 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)))
327
	      ;; Error.
328 329 330 331 332
	      (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)))
333
	  ;; Always go home.
334
	  (tramp-smb-send-command v (format "cd \\")))))))
335 336

(defun tramp-smb-handle-delete-file (filename)
337
  "Like `delete-file' for Tramp files."
338
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
339 340
  (when (file-exists-p filename)
    (with-parsed-tramp-file-name filename nil
341 342 343 344 345 346 347 348 349 350
      ;; 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)))
351
	      ;; Error.
352 353 354 355 356
	      (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)))
357
	  ;; Always go home.
358
	  (tramp-smb-send-command v (format "cd \\")))))))
359 360 361

(defun tramp-smb-handle-directory-files
  (directory &optional full match nosort)
362 363 364
  "Like `directory-files' for Tramp files."
  (let ((result (mapcar 'directory-file-name
			(file-name-all-completions "" directory))))
365
    ;; Discriminate with regexp.
366 367 368 369 370
    (when match
      (setq result
	    (delete nil
		    (mapcar (lambda (x) (when (string-match match x) x))
			    result))))
371
    ;; Append directory.
372 373 374 375 376
    (when full
      (setq result
	    (mapcar
	     (lambda (x) (expand-file-name x directory))
	     result)))
377
    ;; Sort them if necessary.
378
    (unless nosort (setq result (sort result 'string-lessp)))
379
    ;; That's it.
380
    result))
381 382

(defun tramp-smb-handle-directory-files-and-attributes
383
  (directory &optional full match nosort id-format)
384
  "Like `directory-files-and-attributes' for Tramp files."
385 386
  (mapcar
   (lambda (x)
387
     (cons x (tramp-compat-file-attributes
388
	      (if full x (expand-file-name x directory)) id-format)))
389
   (directory-files directory full match nosort)))
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
(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
      (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
	(setq localname (concat "/" localname)))
      ;; Tilde expansion if necessary.  We use the user name as share,
      ;; which is offen the case in work groups.
      (when (string-match "\\`~[^/]*" localname)
	(setq localname
	      (replace-match
	       (if (zerop (length (match-string 0 localname)))
		   (tramp-file-name-real-user v)
		 (match-string 0 localname))
	       nil nil localname)))
      ;; 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))))))

420
(defun tramp-smb-handle-file-attributes (filename &optional id-format)
421 422 423 424 425 426
  "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
427
  (with-parsed-tramp-file-name filename nil
428 429 430
    (with-file-property v localname (format "file-attributes-%s" id-format)
      (let* ((entries (tramp-smb-get-file-entries
		       (file-name-directory filename)))
431
	     (entry (assoc (file-name-nondirectory filename) entries))
432 433
	     (uid (if (and id-format (equal id-format 'string)) "nobody" -1))
	     (gid (if (and id-format (equal id-format 'string)) "nogroup" -1))
434
	     (inode (tramp-get-inode v))
435
	     (device (tramp-get-device v)))
436

437
        ;; Check result.
438 439
	(when entry
	  (list (and (string-match "d" (nth 1 entry))
440 441 442 443 444 445 446 447 448 449 450 451
		     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
452 453

(defun tramp-smb-handle-file-directory-p (filename)
454 455 456
  "Like `file-directory-p' for Tramp files."
  (and (file-exists-p filename)
       (eq ?d (aref (nth 8 (file-attributes filename)) 0))))
457 458

(defun tramp-smb-handle-file-exists-p (filename)
459 460
  "Like `file-exists-p' for Tramp files."
  (not (null (file-attributes filename))))
461 462

(defun tramp-smb-handle-file-local-copy (filename)
463
  "Like `file-local-copy' for Tramp files."
464
  (with-parsed-tramp-file-name filename nil
465 466 467 468
    (unless (file-exists-p filename)
      (tramp-error
       v 'file-error
       "Cannot make local copy of non-existing file `%s'" filename))
469
    (let ((file (tramp-smb-get-localname localname t))
470
	  (tmpfile (tramp-compat-make-temp-file filename)))
471 472
      (tramp-message v 4 "Fetching %s to tmp file %s..." filename tmpfile)
      (if (tramp-smb-send-command v (format "get \"%s\" %s" file tmpfile))
473
	  (tramp-message
474
	   v 4 "Fetching %s to tmp file %s...done" filename tmpfile)
475 476
	;; Oops, an error.  We shall cleanup.
	(delete-file tmpfile)
477 478 479
	(tramp-error
	 v 'file-error
	 "Cannot make local copy of file `%s'" filename))
480
      tmpfile)))
481 482 483 484

;; This function should return "foo/" for directories and "bar" for
;; files.
(defun tramp-smb-handle-file-name-all-completions (filename directory)
485 486 487 488 489 490 491
  "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)))
492 493 494 495 496 497 498 499 500
	   (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)
501
  "Like `file-newer-than-file-p' for Tramp files."
502 503 504
  (cond
   ((not (file-exists-p file1)) nil)
   ((not (file-exists-p file2)) t)
505 506
   (t (tramp-time-less-p (nth 5 (file-attributes file2))
			 (nth 5 (file-attributes file1))))))
507 508

(defun tramp-smb-handle-file-writable-p (filename)
509 510 511 512 513 514
  "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)))))
515 516 517

(defun tramp-smb-handle-insert-directory
  (filename switches &optional wildcard full-directory-p)
518
  "Like `insert-directory' for Tramp files."
519
  (setq filename (expand-file-name filename))
520 521
  (when full-directory-p
    ;; Called from `dired-add-entry'.
522
    (setq filename (file-name-as-directory filename)))
Michael Albinus's avatar
Michael Albinus committed
523
  (with-parsed-tramp-file-name filename nil
524
    (save-match-data
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
      (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.
540
	(setq entries
541 542 543 544 545 546 547 548 549 550 551 552
	      (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)))))
553

Michael Albinus's avatar
Michael Albinus committed
554
	;; Sort entries.
555 556 557 558 559
	(setq entries
	      (sort
	       entries
	       (lambda (x y)
		 (if (string-match "t" switches)
560 561 562
		     ;; Sort by date.
		     (tramp-time-less-p (nth 3 y) (nth 3 x))
		   ;; Sort by name.
563 564
		   (string-lessp (nth 0 x) (nth 0 y))))))

Michael Albinus's avatar
Michael Albinus committed
565 566
	;; Handle "-F" switch.
	(when (string-match "F" switches)
567
	  (mapc
Michael Albinus's avatar
Michael Albinus committed
568 569 570 571 572 573 574 575 576
	   (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))

577
	;; Print entries.
578 579
	(mapcar
	 (lambda (x)
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
	   (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)))))
598 599

(defun tramp-smb-handle-make-directory (dir &optional parents)
600
  "Like `make-directory' for Tramp files."
601 602
  (setq dir (directory-file-name (expand-file-name dir)))
  (unless (file-name-absolute-p dir)
603
    (setq dir (expand-file-name dir default-directory)))
Michael Albinus's avatar
Michael Albinus committed
604
  (with-parsed-tramp-file-name dir nil
605
    (save-match-data
Kai Großjohann's avatar
Kai Großjohann committed
606
      (let* ((share (tramp-smb-get-share localname))
607
	     (ldir (file-name-directory dir)))
608
	;; Make missing directory parts.
609 610
	(when (and parents share (not (file-directory-p ldir)))
	  (make-directory ldir parents))
611
	;; Just do it.
612
	(when (file-directory-p ldir)
613
	  (make-directory-internal dir))
614
	(unless (file-directory-p dir)
615
	  (tramp-error v 'file-error "Couldn't make directory %s" dir))))))
616 617

(defun tramp-smb-handle-make-directory-internal (directory)
618
  "Like `make-directory-internal' for Tramp files."
619 620
  (setq directory (directory-file-name (expand-file-name directory)))
  (unless (file-name-absolute-p directory)
621
    (setq directory (expand-file-name directory default-directory)))
Michael Albinus's avatar
Michael Albinus committed
622
  (with-parsed-tramp-file-name directory nil
623
    (save-match-data
624
      (let* ((file (tramp-smb-get-localname localname t)))
625
	(when (file-directory-p (file-name-directory directory))
626 627 628
	  (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
629
	  (tramp-flush-file-property v localname)
630
	  (tramp-flush-file-property v (file-name-directory localname)))
631
	(unless (file-directory-p directory)
632 633
	  (tramp-error
	   v 'file-error "Couldn't make directory %s" directory))))))
634 635 636

(defun tramp-smb-handle-rename-file
  (filename newname &optional ok-if-already-exists)
637
  "Like `rename-file' for Tramp files."
638 639 640 641 642 643
  (setq filename (expand-file-name filename)
	newname (expand-file-name newname))

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

    (if tmpfile
644 645 646
	;; Remote filename.
	(condition-case err
	    (rename-file tmpfile newname ok-if-already-exists)
647 648 649
	  ((error quit)
	   (delete-file tmpfile)
	   (signal (car err) (cdr err))))
650

651
      ;; Remote newname.
652 653 654 655
      (when (file-directory-p newname)
	(setq newname (expand-file-name
		      (file-name-nondirectory filename) newname)))

Michael Albinus's avatar
Michael Albinus committed
656
      (with-parsed-tramp-file-name newname nil
657 658 659 660 661 662 663 664 665 666 667 668 669
	(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))))))
670 671 672

  (delete-file filename))

673 674 675 676 677 678 679 680 681 682 683
(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
684
(defun tramp-smb-handle-substitute-in-file-name (filename)
685
  "Like `handle-substitute-in-file-name' for Tramp files.
686 687 688 689 690 691 692 693
\"//\" 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
694 695 696 697
  (condition-case nil
      (tramp-run-real-handler 'substitute-in-file-name (list filename))
    (error filename)))

698 699
(defun tramp-smb-handle-write-region
  (start end filename &optional append visit lockname confirm)
700
  "Like `write-region' for Tramp files."
701
  (setq filename (expand-file-name filename))
Michael Albinus's avatar
Michael Albinus committed
702
  (with-parsed-tramp-file-name filename nil
703 704
    (unless (eq append nil)
      (tramp-error
705
	 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
706
    ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
707 708 709 710 711 712
    (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
713
    ;; `file-attributes' reads the values from there.
714 715 716 717
    (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))
718
	  (tmpfile (tramp-compat-make-temp-file filename)))
719 720 721 722 723 724
      ;; 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.
725 726
	   (list start end tmpfile append 'no-message lockname confirm)
	 (list start end tmpfile append 'no-message lockname)))
727

728
      (tramp-message v 5 "Writing tmp file %s to file %s..." tmpfile filename)
729 730 731 732 733 734
      (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))
735 736 737 738 739 740 741

      (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)))))
742 743


744
;; Internal file name functions.
745

Kai Großjohann's avatar
Kai Großjohann committed
746 747
(defun tramp-smb-get-share (localname)
  "Returns the share name of LOCALNAME."
748
  (save-match-data
Kai Großjohann's avatar
Kai Großjohann committed
749 750
    (when (string-match "^/?\\([^/]+\\)/" localname)
      (match-string 1 localname))))
751

Kai Großjohann's avatar
Kai Großjohann committed
752 753
(defun tramp-smb-get-localname (localname convert)
  "Returns the file name of LOCALNAME.
754 755
If CONVERT is non-nil exchange \"/\" by \"\\\\\"."
  (save-match-data
Kai Großjohann's avatar
Kai Großjohann committed
756
    (let ((res localname))
757 758 759 760 761 762 763 764 765 766 767 768

      (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)
	       "")))

769
      ;; Sometimes we have discarded `substitute-in-file-name'.
770 771 772 773 774 775 776
      (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.
777 778
(defun tramp-smb-get-file-entries (directory)
  "Read entries which match DIRECTORY.
779
Either the shares are listed, or the `dir' command is executed.
Kai Großjohann's avatar
Kai Großjohann committed
780
Result is a list of (LOCALNAME MODE SIZE MONTH DAY TIME YEAR)."
781 782 783 784 785 786 787 788 789 790
  (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)
791
	      ;; Return cached shares.
792 793
	      (setq res cache)

794
	    ;; Read entries.
795 796 797 798 799
	    (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))
800
	      ;; `tramp-smb-maybe-open-connection' lists also the share names.
801 802
	      (tramp-smb-maybe-open-connection v))

803
	    ;; Loop the listing.
804 805 806 807 808 809 810
	    (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))))

811
	    ;; Cache share entries.
812 813
	    (unless share
	      (tramp-set-connection-property v "share-cache" res)))
814

815
	  ;; Add directory itself.
816
	  (add-to-list 'res '("" "drwxrwxrwx" 0 (0 0)))
817

818 819 820
	  ;; 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))
821

822
	  ;; Return entries.
823
	  (delq nil res))))))
824

825
;; Return either a share name (if SHARE is nil), or a file name.
826
;;
827
;; If shares are listed, the following format is expected:
828 829 830 831 832 833 834 835 836 837 838
;;
;; \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
839 840
;; \S-\(.*\S-\)\s-*                       - file name, 30 chars, left bound
;; \s-+[ADHRSV]*                          - permissions, 7 chars, right bound
841
;; \s-                                    - space delimeter
842
;; \s-+[0-9]+                             - size, 8 chars, right bound
843 844 845
;; \s-\{2,2\}                             - space delimeter
;; \w\{3,3\}                              - weekday
;; \s-                                    - space delimeter
846 847
;; \w\{3,3\}                              - month
;; \s-                                    - space delimeter
848
;; [ 12][0-9]                             - day
849 850 851 852 853
;; \s-                                    - space delimeter
;; [0-9]\{2,2\}:[0-9]\{2,2\}:[0-9]\{2,2\} - time
;; \s-                                    - space delimeter
;; [0-9]\{4,4\}                           - year
;;
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
;; 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))));
;;
871 872 873 874 875 876 877 878 879 880 881
;; 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
882
Result is the list (LOCALNAME MODE SIZE MTIME)."
883 884
;; We are called from `tramp-smb-get-file-entries', which sets the
;; current buffer.
885
  (let ((line (buffer-substring (point) (tramp-compat-line-end-position)))
Kai Großjohann's avatar
Kai Großjohann committed
886
	localname mode size month day hour min sec year mtime)
887 888 889

    (if (not share)

890 891
	;; Read share entries.
	(when (string-match "^\\s-+\\(\\S-\\(.*\\S-\\)?\\)\\s-+Disk" line)
Kai Großjohann's avatar
Kai Großjohann committed
892
	  (setq localname (match-string 1 line)
893 894 895
		mode "dr-xr-xr-x"
		size 0))

896
      ;; Real listing.
897 898
      (block nil

899
	;; year.
900 901 902 903 904
	(if (string-match "\\([0-9]+\\)$" line)
	    (setq year (string-to-number (match-string 1 line))
		  line (substring line 0 -5))
	  (return))

905
	;; time.
906 907 908 909 910 911 912
	(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))

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

919
	;; month.
920 921 922 923 924
	(if (string-match "\\(\\w+\\)$" line)
	    (setq month (match-string 1 line)
		  line  (substring line 0 -4))
	  (return))

925
	;; weekday.
926 927 928 929
	(if (string-match "\\(\\w+\\)$" line)
	    (setq line (substring line 0 -5))
	  (return))

930
	;; size.
931
	(if (string-match "\\([0-9]+\\)$" line)
932 933 934 935 936
	    (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)))
937 938
	  (return))

939
	;; mode: ARCH, DIR, HIDDEN, RONLY, SYSTEM, VOLID.
940
	(if (string-match "\\([ADHRSV]+\\)?$" line)
941
	    (setq
942
	     mode (or (match-string 1 line) "")
943 944 945 946 947 948
	     mode (save-match-data (format
		    "%s%s"
		    (if (string-match "D" mode) "d" "-")
		    (mapconcat
		     (lambda (x) "") "    "
		     (concat "r" (if (string-match "R" mode) "-" "w") "x"))))
949
	     line (substring line 0 -7))
950 951
	  (return))

952
	;; localname.
953
	(if (string-match "^\\s-+\\(\\S-\\(.*\\S-\\)?\\)\\s-*$" line)
Kai Großjohann's avatar
Kai Großjohann committed
954
	    (setq localname (match-string 1 line))
955 956
	  (return))))

Kai Großjohann's avatar
Kai Großjohann committed
957
    (when (and localname mode size)
958 959 960 961
      (setq mtime
	    (if (and sec min hour day month year)
		(encode-time
		 sec min hour day