server.el 30.1 KB
Newer Older
1
;;; server.el --- Lisp code for GNU Emacs running as server process
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1986, 1987, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4
;;   2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: William Sommerfeld <wesommer@athena.mit.edu>
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
9

root's avatar
root committed
10 11 12 13 14 15
;; Changes by peck@sun.com and by rms.

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
16
;; the Free Software Foundation; either version 2, or (at your option)
root's avatar
root committed
17 18 19 20 21 22 23 24
;; any later version.

;; 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
Erik Naggum's avatar
Erik Naggum committed
25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
26 27
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
root's avatar
root committed
28

Eric S. Raymond's avatar
Eric S. Raymond committed
29
;;; Commentary:
root's avatar
root committed
30

Erik Naggum's avatar
Erik Naggum committed
31 32
;; This Lisp code is run in Emacs when it is to operate as
;; a server for other processes.
root's avatar
root committed
33

Erik Naggum's avatar
Erik Naggum committed
34
;; Load this library and do M-x server-edit to enable Emacs as a server.
35 36 37
;; Emacs opens up a socket for communication with clients.  If there are no
;; client buffers to edit, server-edit acts like (switch-to-buffer
;; (other-buffer))
root's avatar
root committed
38

Erik Naggum's avatar
Erik Naggum committed
39 40 41 42
;; When some other program runs "the editor" to edit a file,
;; "the editor" can be the Emacs client program ../lib-src/emacsclient.
;; This program transmits the file names to Emacs through
;; the server subprocess, and Emacs visits them and lets you edit them.
root's avatar
root committed
43

Erik Naggum's avatar
Erik Naggum committed
44
;; Note that any number of clients may dispatch files to emacs to be edited.
root's avatar
root committed
45

Erik Naggum's avatar
Erik Naggum committed
46
;; When you finish editing a Server buffer, again call server-edit
47 48
;; to mark that buffer as done for the client and switch to the next
;; Server buffer.  When all the buffers for a client have been edited
Erik Naggum's avatar
Erik Naggum committed
49
;; and exited with server-edit, the client "editor" will return
50
;; to the program that invoked it.
root's avatar
root committed
51

Erik Naggum's avatar
Erik Naggum committed
52 53 54 55
;; Your editing commands and Emacs's display output go to and from
;; the terminal in the usual way.  Thus, server operation is possible
;; only when Emacs can talk to the terminal at the time you invoke
;; the client.  This is possible in four cases:
root's avatar
root committed
56

Erik Naggum's avatar
Erik Naggum committed
57 58
;; 1. On a window system, where Emacs runs in one window and the
;; program that wants to use "the editor" runs in another.
root's avatar
root committed
59

Erik Naggum's avatar
Erik Naggum committed
60 61
;; 2. On a multi-terminal system, where Emacs runs on one terminal and the
;; program that wants to use "the editor" runs on another.
root's avatar
root committed
62

Erik Naggum's avatar
Erik Naggum committed
63 64
;; 3. When the program that wants to use "the editor" is running
;; as a subprocess of Emacs.
root's avatar
root committed
65

Erik Naggum's avatar
Erik Naggum committed
66 67 68 69 70
;; 4. On a system with job control, when Emacs is suspended, the program
;; that wants to use "the editor" will stop and display
;; "Waiting for Emacs...".  It can then be suspended, and Emacs can be
;; brought into the foreground for editing.  When done editing, Emacs is
;; suspended again, and the client program is brought into the foreground.
root's avatar
root committed
71

72 73
;; The buffer local variable "server-buffer-clients" lists
;; the clients who are waiting for this buffer to be edited.
Erik Naggum's avatar
Erik Naggum committed
74 75
;; The global variable "server-clients" lists all the waiting clients,
;; and which files are yet to be edited for each.
Eric S. Raymond's avatar
Eric S. Raymond committed
76 77

;;; Code:
78 79 80

(eval-when-compile (require 'cl))

Richard M. Stallman's avatar
Richard M. Stallman committed
81 82 83 84
(defgroup server nil
  "Emacs running as a server process."
  :group 'external)

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
(defcustom server-use-tcp nil
  "If non-nil, use TCP sockets instead of local sockets."
  :set #'(lambda (sym val)
           (unless (featurep 'make-network-process '(:family local))
             (setq val t)
             (unless load-in-progress
               (message "Local sockets unsupported, using TCP sockets")))
           (when val (random t))
           (set-default sym val))
  :group 'server
  :type 'boolean
  :version "22.1")

(defcustom server-host nil
  "The name or IP address to use as host address of the server process.
If set, the server accepts remote connections; otherwise it is local."
  :group 'server
  :type '(choice
          (string :tag "Name or IP address")
          (const :tag "Local" nil))
  :version "22.1")
(put 'server-host 'risky-local-variable t)

(defcustom server-auth-dir "~/.emacs.d/server/"
  "Directory for server authentication files."
  :group 'server
  :type 'directory
  :version "22.1")
(put 'server-auth-dir 'risky-local-variable t)

(defvar server-auth-key nil
  "The current server authentication key.")
(put 'server-auth-key 'risky-local-variable t)

Richard M. Stallman's avatar
Richard M. Stallman committed
119
(defcustom server-visit-hook nil
120
  "*Hook run when visiting a file for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
121
  :group 'server
122
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124

(defcustom server-switch-hook nil
125
  "*Hook run when switching to a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
126
  :group 'server
127
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
128 129

(defcustom server-done-hook nil
130
  "*Hook run when done editing a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
131
  :group 'server
132
  :type 'hook)
133

134 135
(defvar server-process nil
  "The current server process.")
root's avatar
root committed
136 137 138

(defvar server-clients nil
  "List of current server clients.
139
Each element is (CLIENTID BUFFERS...) where CLIENTID is a string
root's avatar
root committed
140 141 142 143
that can be given to the server process to identify a client.
When a buffer is marked as \"done\", it is removed from this list.")

(defvar server-buffer-clients nil
144
  "List of client ids for clients requesting editing of current buffer.")
145
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
146 147 148
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

Dave Love's avatar
Dave Love committed
149 150
(defcustom server-window nil
  "*Specification of the window to use for selecting Emacs server buffers.
151
If nil, use the selected window.
152
If it is a function, it should take one argument (a buffer) and
Dave Love's avatar
Dave Love committed
153 154 155 156 157 158 159
display and select it.  A common value is `pop-to-buffer'.
If it is a window, use that.
If it is a frame, use the frame's selected window.

It is not meaningful to set this to a specific frame or window with Custom.
Only programs can do so."
  :group 'server
160
  :version "22.1"
Dave Love's avatar
Dave Love committed
161 162 163 164 165 166
  :type '(choice (const :tag "Use selected window"
			:match (lambda (widget value)
				 (not (functionp value)))
			nil)
		 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
		 (function :tag "Other function")))
167

Richard M. Stallman's avatar
Richard M. Stallman committed
168
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
Dave Love's avatar
Dave Love committed
169 170 171
  "*Regexp matching names of temporary files.
These are deleted and reused after each edit by the programs that
invoke the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173
  :group 'server
  :type 'regexp)
root's avatar
root committed
174

175 176 177
(defcustom server-kill-new-buffers t
  "*Whether to kill buffers when done with them.
If non-nil, kill a buffer unless it already existed before editing
178
it with Emacs server.  If nil, kill only buffers as specified by
179 180 181 182 183 184 185 186
`server-temp-file-regexp'.
Please note that only buffers are killed that still have a client,
i.e. buffers visited which \"emacsclient --no-wait\" are never killed in
this way."
  :group 'server
  :type 'boolean
  :version "21.1")

root's avatar
root committed
187
(or (assq 'server-buffer-clients minor-mode-alist)
188
    (push '(server-buffer-clients " Server") minor-mode-alist))
root's avatar
root committed
189

190
(defvar server-existing-buffer nil
191
  "Non-nil means the buffer existed before the server was asked to visit it.
192
This means that the server should not kill the buffer when you say you
193
are done with it in the server.")
194 195
(make-variable-buffer-local 'server-existing-buffer)

Stefan Monnier's avatar
Stefan Monnier committed
196 197 198 199
(defvar server-name "server")

(defvar server-socket-dir
  (format "/tmp/emacs%d" (user-uid)))
200

201
(defun server-log (string &optional client)
Dave Love's avatar
Dave Love committed
202
  "If a *server* buffer exists, write STRING to it for logging purposes."
203 204 205 206 207 208 209
  (when (get-buffer "*server*")
    (with-current-buffer "*server*"
      (goto-char (point-max))
      (insert (current-time-string)
	      (if client (format " %s:" client) " ")
	      string)
      (or (bolp) (newline)))))
root's avatar
root committed
210 211

(defun server-sentinel (proc msg)
212
  (let ((client (assq proc server-clients)))
213
    ;; Remove PROC from the list of clients.
214 215 216 217 218 219 220 221 222 223 224 225
    (when client
      (setq server-clients (delq client server-clients))
      (dolist (buf (cdr client))
	(with-current-buffer buf
	  ;; Remove PROC from the clients of each buffer.
	  (setq server-buffer-clients (delq proc server-buffer-clients))
	  ;; Kill the buffer if necessary.
	  (when (and (null server-buffer-clients)
		     (or (and server-kill-new-buffers
			      (not server-existing-buffer))
			 (server-temp-file-p)))
	    (kill-buffer (current-buffer)))))))
226 227 228 229 230
  ;; If this is a new client process, set the query-on-exit flag to nil
  ;; for this process (it isn't inherited from the server process).
  (when (and (eq (process-status proc) 'open)
	     (process-query-on-exit-flag proc))
    (set-process-query-on-exit-flag proc nil))
231 232
  (server-log (format "Status changed to %s" (process-status proc)) proc))

233 234 235 236 237 238 239
(defun server-select-display (display)
  ;; If the current frame is on `display' we're all set.
  (unless (equal (frame-parameter (selected-frame) 'display) display)
    ;; Otherwise, look for an existing frame there and select it.
    (dolist (frame (frame-list))
      (when (equal (frame-parameter frame 'display) display)
	(select-frame frame)))
240
    ;; If there's no frame on that display yet, create and select one.
241
    (unless (equal (frame-parameter (selected-frame) 'display) display)
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
      (let* ((buffer (generate-new-buffer " *server-dummy*"))
             (frame (make-frame-on-display
                     display
                     ;; Make it display (and remember) some dummy buffer, so
                     ;; we can detect later if the frame is in use or not.
                     `((server-dummmy-buffer . ,buffer)
                       ;; This frame may be deleted later (see
                       ;; server-unselect-display) so we want it to be as
                       ;; unobtrusive as possible.
                       (visibility . nil)))))
        (select-frame frame)
        (set-window-buffer (selected-window) buffer)))))

(defun server-unselect-display (frame)
  ;; If the temporary frame is in use (displays something real), make it
  ;; visible.  If not (which can happen if the user's customizations call
  ;; pop-to-buffer etc.), delete it to avoid preserving the connection after
  ;; the last real frame is deleted.
  (if (and (eq (frame-first-window frame)
               (next-window (frame-first-window frame) 'nomini))
           (eq (window-buffer (frame-first-window frame))
               (frame-parameter frame 'server-dummy-buffer)))
      ;; The temp frame still only shows one buffer, and that is the
      ;; internal temp buffer.
      (delete-frame frame)
    (set-frame-parameter frame 'visibility t))
  (kill-buffer (frame-parameter frame 'server-dummy-buffer))
  (set-frame-parameter frame 'server-dummy-buffer nil))
270

271 272 273 274 275 276 277 278 279
(defun server-unquote-arg (arg)
  (replace-regexp-in-string
   "&." (lambda (s)
	  (case (aref s 1)
	    (?& "&")
	    (?- "-")
	    (?n "\n")
	    (t " ")))
   arg t t))
root's avatar
root committed
280

281 282 283 284 285 286 287 288 289
(defun server-ensure-safe-dir (dir)
  "Make sure DIR is a directory with no race-condition issues.
Creates the directory if necessary and makes sure:
- there's no symlink involved
- it's owned by us
- it's not readable/writable by anybody else."
  (setq dir (directory-file-name dir))
  (let ((attrs (file-attributes dir)))
    (unless attrs
290
      (letf (((default-file-modes) ?\700)) (make-directory dir t))
291 292 293
      (setq attrs (file-attributes dir)))
    ;; Check that it's safe for use.
    (unless (and (eq t (car attrs)) (eq (nth 2 attrs) (user-uid))
294 295
                 (or (eq system-type 'windows-nt)
                     (zerop (logand ?\077 (file-modes dir)))))
296 297
      (error "The directory %s is unsafe" dir))))

Roland McGrath's avatar
Roland McGrath committed
298
;;;###autoload
root's avatar
root committed
299 300 301 302
(defun server-start (&optional leave-dead)
  "Allow this Emacs process to be a server for client processes.
This starts a server communications subprocess through which
client \"editors\" can send your editing commands to this Emacs job.
Richard M. Stallman's avatar
Richard M. Stallman committed
303
To use the server, set up the program `emacsclient' in the
root's avatar
root committed
304 305 306 307
Emacs distribution as your standard \"editor\".

Prefix arg means just kill any existing server communications subprocess."
  (interactive "P")
308
  (when server-process
309
    ;; kill it dead!
310 311
    (ignore-errors (delete-process server-process))
    (ignore-errors
312 313
      ;; Delete the socket or authentication files made by previous
      ;; server invocations.
314
      (if (eq (process-contact server-process :family) 'local)
315
          (delete-file (expand-file-name server-name server-socket-dir))
316 317
        (setq server-auth-key nil)
        (delete-file (expand-file-name server-name server-auth-dir)))))
318
  ;; If this Emacs already had a server, clear out associated status.
root's avatar
root committed
319 320 321
  (while server-clients
    (let ((buffer (nth 1 (car server-clients))))
      (server-buffer-done buffer)))
322
  ;; Now any previous server is properly stopped.
323
  (unless leave-dead
324
    ;; Make sure there is a safe directory in which to place the socket.
325 326
    (server-ensure-safe-dir
     (if server-use-tcp server-auth-dir server-socket-dir))
327
    (when server-process
328
      (server-log (message "Restarting server")))
Stefan Monnier's avatar
Stefan Monnier committed
329 330
    (letf (((default-file-modes) ?\700))
      (setq server-process
331 332 333 334 335 336
            (apply #'make-network-process
                   :name server-name
                   :server t
                   :noquery t
                   :sentinel 'server-sentinel
                   :filter 'server-process-filter
337 338 339
                   ;; We must receive file names without being decoded.
                   ;; Those are decoded by server-process-filter according
                   ;; to file-name-coding-system.
340
                   :coding 'raw-text
341
                   ;; The rest of the args depends on the kind of socket used.
342 343 344 345 346 347 348
                   (if server-use-tcp
                       (list :family nil
                             :service t
                             :host (or server-host 'local)
                             :plist '(:authenticated nil))
                     (list :family 'local
                           :service (expand-file-name server-name server-socket-dir)
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
                           :plist '(:authenticated t)))))
      (unless server-process (error "Could not start server process"))
      (when server-use-tcp
        (setq server-auth-key
              (loop
                 ;; The auth key is a 64-byte string of random chars in the
                 ;; range `!'..`~'.
	         for i below 64
                 collect (+ 33 (random 94)) into auth
                 finally return (concat auth)))
        (with-temp-file (expand-file-name server-name server-auth-dir)
          (set-buffer-multibyte nil)
          (setq buffer-file-coding-system 'no-conversion)
          (insert (format-network-address
                   (process-contact server-process :local))
                  "\n" server-auth-key))))))
Dave Love's avatar
Dave Love committed
365 366 367 368 369 370 371 372 373

;;;###autoload
(define-minor-mode server-mode
  "Toggle Server mode.
With ARG, turn Server mode on if ARG is positive, off otherwise.
Server mode runs a process that accepts commands from the
`emacsclient' program.  See `server-start' and Info node `Emacs server'."
  :global t
  :group 'server
374
  :version "22.1"
Dave Love's avatar
Dave Love committed
375 376 377
  ;; Fixme: Should this check for an existing server socket and do
  ;; nothing if there is one (for multiple Emacs sessions)?
  (server-start (not server-mode)))
root's avatar
root committed
378

379
(defun* server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
380 381
  "Process a request from the server to edit some files.
PROC is the server process.  Format of STRING is \"PATH PATH PATH... \\n\"."
382 383 384 385 386 387 388 389 390
  ;; First things first: let's check the authentication
  (unless (process-get proc :authenticated)
    (if (and (string-match "-auth \\(.*?\\)\n" string)
             (string= (match-string 1 string) server-auth-key))
        (progn
          (setq string (substring string (match-end 0)))
          (process-put proc :authenticated t)
          (server-log "Authentication successful" proc))
      (server-log "Authentication failed" proc)
391
      (process-send-string proc "Authentication failed")
392 393 394
      (delete-process proc)
      ;; We return immediately
      (return-from server-process-filter)))
395
  (server-log string proc)
396
  (let ((prev (process-get proc :previous-string)))
397 398
    (when prev
      (setq string (concat prev string))
399
      (process-put proc :previous-string nil)))
400 401 402 403
  ;; If the input is multiple lines,
  ;; process each line individually.
  (while (string-match "\n" string)
    (let ((request (substring string 0 (match-beginning 0)))
404 405 406
	  (coding-system (and default-enable-multibyte-characters
			      (or file-name-coding-system
				  default-file-name-coding-system)))
407
	  client nowait eval
root's avatar
root committed
408
	  (files nil)
409
	  (lineno 1)
410
	  (tmp-frame nil) ;; Sometimes used to embody the selected display.
411
	  (columnno 0))
412
      ;; Remove this line from STRING.
413 414 415
      (setq string (substring string (match-end 0)))
      (setq client (cons proc nil))
      (while (string-match "[^ ]* " request)
416
	(let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
417 418
	  (setq request (substring request (match-end 0)))
	  (cond
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
            ((equal "-nowait" arg) (setq nowait t))
            ((equal "-eval" arg) (setq eval t))
            ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
             (let ((display (server-unquote-arg (match-string 1 request))))
               (setq request (substring request (match-end 0)))
               (condition-case err
                   (setq tmp-frame (server-select-display display))
                 (error (process-send-string proc (nth 1 err))
                        (setq request "")))))
            ;; ARG is a line number option.
            ((string-match "\\`\\+[0-9]+\\'" arg)
             (setq lineno (string-to-number (substring arg 1))))
            ;; ARG is line number:column option.
            ((string-match "\\`+\\([0-9]+\\):\\([0-9]+\\)\\'" arg)
             (setq lineno (string-to-number (match-string 1 arg))
                   columnno (string-to-number (match-string 2 arg))))
            (t
             ;; Undo the quoting that emacsclient does
             ;; for certain special characters.
             (setq arg (server-unquote-arg arg))
             ;; Now decode the file name if necessary.
             (when coding-system
               (setq arg (decode-coding-string arg coding-system)))
             (if eval
                 (let* (errorp
                        (v (condition-case errobj
                               (eval (car (read-from-string arg)))
                             (error (setq errorp t) errobj))))
                   (when v
                     (with-temp-buffer
                       (let ((standard-output (current-buffer)))
                         (when errorp (princ "error: "))
                         (pp v)
                         (ignore-errors
                           (process-send-region proc (point-min) (point-max)))
                         ))))
               ;; ARG is a file name.
               ;; Collapse multiple slashes to single slashes.
               (setq arg (command-line-normalize-file-name arg))
               (push (list arg lineno columnno) files))
             (setq lineno 1)
             (setq columnno 0)))))
461 462 463 464 465 466 467 468 469 470 471 472
      (when files
	(run-hooks 'pre-command-hook)
	(server-visit-files files client nowait)
	(run-hooks 'post-command-hook))
      ;; CLIENT is now a list (CLIENTNUM BUFFERS...)
      (if (null (cdr client))
	  ;; This client is empty; get rid of it immediately.
	  (progn
	    (delete-process proc)
	    (server-log "Close empty client" proc))
	;; We visited some buffer for this client.
	(or nowait (push client server-clients))
473
	(unless (or isearch-mode (minibufferp))
474 475 476
	  (server-switch-buffer (nth 1 client))
	  (run-hooks 'server-switch-hook)
	  (unless nowait
Deepak Goel's avatar
Deepak Goel committed
477
	    (message "%s" (substitute-command-keys
478
                           "When done with a buffer, type \\[server-edit]")))))
479 480 481 482
      (when (frame-live-p tmp-frame)
        ;; Delete tmp-frame or make it visible depending on whether it's
        ;; been used or not.
        (server-unselect-display tmp-frame))))
483
  ;; Save for later any partial line that remains.
484
  (when (> (length string) 0)
485
    (process-put proc :previous-string string)))
root's avatar
root committed
486

487 488 489
(defun server-goto-line-column (file-line-col)
  (goto-line (nth 1 file-line-col))
  (let ((column-number (nth 2 file-line-col)))
490 491
    (when (> column-number 0)
      (move-to-column (1- column-number)))))
492

493
(defun server-visit-files (files client &optional nowait)
494
  "Find FILES and return the list CLIENT with the buffers nconc'd.
495
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
496 497
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
498
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
499
  (let ((last-nonmenu-event t) client-record)
500 501 502
    ;; Restore the current buffer afterward, but not using save-excursion,
    ;; because we don't want to save point in this buffer
    ;; if it happens to be one of those specified by the server.
503 504 505 506 507 508 509
    (save-current-buffer
      (dolist (file files)
	;; If there is an existing buffer modified or the file is
	;; modified, revert it.  If there is an existing buffer with
	;; deleted file, offer to write it.
	(let* ((filen (car file))
	       (obuf (get-file-buffer filen)))
510
	  (add-to-history 'file-name-history filen)
511 512 513
	  (if (and obuf (set-buffer obuf))
	      (progn
		(cond ((file-exists-p filen)
514 515
		       (when (not (verify-visited-file-modtime obuf))
                         (revert-buffer t nil)))
516
		      (t
517 518 519 520 521
		       (when (y-or-n-p
                              (concat "File no longer exists: "
                                      filen
                                      ", write buffer to file? "))
                         (write-file filen))))
522 523 524 525 526 527 528 529 530 531
		(setq server-existing-buffer t)
		(server-goto-line-column file))
	    (set-buffer (find-file-noselect filen))
	    (server-goto-line-column file)
	    (run-hooks 'server-visit-hook)))
	(unless nowait
	  ;; When the buffer is killed, inform the clients.
	  (add-hook 'kill-buffer-hook 'server-kill-buffer nil t)
	  (push (car client) server-buffer-clients))
	(push (current-buffer) client-record)))
root's avatar
root committed
532 533
    (nconc client client-record)))

534
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
535
  "Mark BUFFER as \"done\" for its client(s).
536 537
This buries the buffer, then returns a list of the form (NEXT-BUFFER KILLED).
NEXT-BUFFER is another server buffer, as a suggestion for what to select next,
538 539 540
or nil.  KILLED is t if we killed BUFFER (typically, because it was visiting
a temp file).
FOR-KILLING if non-nil indicates that we are called from `kill-buffer'."
541
  (let ((next-buffer nil)
542
	(killed nil)
root's avatar
root committed
543 544 545
	(old-clients server-clients))
    (while old-clients
      (let ((client (car old-clients)))
546
	(or next-buffer
root's avatar
root committed
547 548
	    (setq next-buffer (nth 1 (memq buffer client))))
	(delq buffer client)
549 550 551 552 553 554 555
	;; Delete all dead buffers from CLIENT.
	(let ((tail client))
	  (while tail
	    (and (bufferp (car tail))
		 (null (buffer-name (car tail)))
		 (delq (car tail) client))
	    (setq tail (cdr tail))))
root's avatar
root committed
556 557
	;; If client now has no pending buffers,
	;; tell it that it is done, and forget it entirely.
558 559 560
	(unless (cdr client)
	  (delete-process (car client))
	  (server-log "Close" (car client))
root's avatar
root committed
561 562
	  (setq server-clients (delq client server-clients))))
      (setq old-clients (cdr old-clients)))
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
    (when (and (bufferp buffer) (buffer-name buffer))
      ;; We may or may not kill this buffer;
      ;; if we do, do not call server-buffer-done recursively
      ;; from kill-buffer-hook.
      (let ((server-kill-buffer-running t))
	(with-current-buffer buffer
	  (setq server-buffer-clients nil)
	  (run-hooks 'server-done-hook))
	;; Notice whether server-done-hook killed the buffer.
	(if (null (buffer-name buffer))
	    (setq killed t)
	  ;; Don't bother killing or burying the buffer
	  ;; when we are called from kill-buffer.
	  (unless for-killing
	    (when (and (not killed)
		       server-kill-new-buffers
		       (with-current-buffer buffer
			 (not server-existing-buffer)))
581
	      (setq killed t)
582 583 584 585 586 587 588 589
	      (bury-buffer buffer)
	      (kill-buffer buffer))
	    (unless killed
	      (if (server-temp-file-p buffer)
		  (progn
		    (kill-buffer buffer)
		    (setq killed t))
		(bury-buffer buffer)))))))
590
    (list next-buffer killed)))
root's avatar
root committed
591

592
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
593 594 595 596 597 598 599 600 601 602
  "Return non-nil if BUFFER contains a file considered temporary.
These are files whose names suggest they are repeatedly
reused to pass information to another program.

The variable `server-temp-file-regexp' controls which filenames
are considered temporary."
  (and (buffer-file-name buffer)
       (string-match server-temp-file-regexp (buffer-file-name buffer))))

(defun server-done ()
Christopher Zaborsky's avatar
Christopher Zaborsky committed
603
  "Offer to save current buffer, mark it as \"done\" for clients.
604 605 606 607 608
This kills or buries the buffer, then returns a list
of the form (NEXT-BUFFER KILLED).  NEXT-BUFFER is another server buffer,
as a suggestion for what to select next, or nil.
KILLED is t if we killed BUFFER, which happens if it was created
specifically for the clients and did not exist before their request for it."
609 610 611 612 613 614 615
  (when server-buffer-clients
    (if (server-temp-file-p)
	;; For a temp file, save, and do make a non-numeric backup
	;; (unless make-backup-files is nil).
	(let ((version-control nil)
	      (buffer-backed-up nil))
	  (save-buffer))
616 617 618 619
      (when (and (buffer-modified-p)
		 buffer-file-name
		 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
	(save-buffer)))
620
    (server-buffer-done (current-buffer))))
621

Richard M. Stallman's avatar
Richard M. Stallman committed
622 623 624 625
;; Ask before killing a server buffer.
;; It was suggested to release its client instead,
;; but I think that is dangerous--the client would proceed
;; using whatever is on disk in that file. -- rms.
626 627 628 629 630
(defun server-kill-buffer-query-function ()
  (or (not server-buffer-clients)
      (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
			   (buffer-name (current-buffer))))))

631
(add-hook 'kill-buffer-query-functions
632 633 634
 	  'server-kill-buffer-query-function)

(defun server-kill-emacs-query-function ()
635 636 637 638
  (let (live-client
	(tail server-clients))
    ;; See if any clients have any buffers that are still alive.
    (while tail
639 640
      (when (memq t (mapcar 'stringp (mapcar 'buffer-name (cdr (car tail)))))
	(setq live-client t))
641 642 643
      (setq tail (cdr tail)))
    (or (not live-client)
	(yes-or-no-p "Server buffers still have clients; exit anyway? "))))
644 645

(add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
646

647
(defvar server-kill-buffer-running nil
648
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
649

650
(defun server-kill-buffer ()
651 652 653
  ;; Prevent infinite recursion if user has made server-done-hook
  ;; call kill-buffer.
  (or server-kill-buffer-running
654 655 656 657
      (and server-buffer-clients
	   (let ((server-kill-buffer-running t))
	     (when server-process
	       (server-buffer-done (current-buffer) t))))))
root's avatar
root committed
658 659 660 661

(defun server-edit (&optional arg)
  "Switch to next server editing buffer; say \"Done\" for current buffer.
If a server buffer is current, it is marked \"done\" and optionally saved.
662
The buffer is also killed if it did not exist before the clients asked for it.
root's avatar
root committed
663 664 665
When all of a client's buffers are marked as \"done\", the client is notified.

Temporary files such as MH <draft> files are always saved and backed up,
666 667 668
no questions asked.  (The variable `make-backup-files', if nil, still
inhibits a backup; you can set it locally in a particular buffer to
prevent a backup for it.)  The variable `server-temp-file-regexp' controls
root's avatar
root committed
669 670
which filenames are considered temporary.

671
If invoked with a prefix argument, or if there is no server process running,
root's avatar
root committed
672 673
starts server process and that is all.  Invoked by \\[server-edit]."
  (interactive "P")
674
  (cond
675 676 677 678 679 680
    ((or arg
         (not server-process)
         (memq (process-status server-process) '(signal exit)))
     (server-mode 1))
    (server-clients (apply 'server-switch-buffer (server-done)))
    (t (message "No server editing buffers exist"))))
root's avatar
root committed
681

682
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
683 684
  "Switch to another buffer, preferably one that has a client.
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it."
685 686 687 688
  ;; KILLED-ONE is t in a recursive call
  ;; if we have already killed one temp-file server buffer.
  ;; This means we should avoid the final "switch to some other buffer"
  ;; since we've already effectively done that.
689 690 691
  (if (null next-buffer)
      (if server-clients
	  (server-switch-buffer (nth 1 (car server-clients)) killed-one)
692
	(unless (or killed-one (window-dedicated-p (selected-window)))
693 694
	  (switch-to-buffer (other-buffer))
	  (message "No server buffers remain to edit")))
695 696
    (if (not (buffer-name next-buffer))
	;; If NEXT-BUFFER is a dead buffer, remove the server records for it
root's avatar
root committed
697
	;; and try the next surviving server buffer.
698 699
	(apply 'server-switch-buffer (server-buffer-done next-buffer))
      ;; OK, we know next-buffer is live, let's display and select it.
700 701 702 703 704 705
      (if (functionp server-window)
	  (funcall server-window next-buffer)
	(let ((win (get-buffer-window next-buffer 0)))
	  (if (and win (not server-window))
	      ;; The buffer is already displayed: just reuse the window.
	      (let ((frame (window-frame win)))
706 707
		(when (eq (frame-visible-p frame) 'icon)
		  (raise-frame frame))
708 709 710 711 712 713 714
		(select-window win)
		(set-buffer next-buffer))
	    ;; Otherwise, let's find an appropriate window.
	    (cond ((and (windowp server-window)
			(window-live-p server-window))
		   (select-window server-window))
		  ((framep server-window)
715 716
		   (unless (frame-live-p server-window)
		     (setq server-window (make-frame)))
717
		   (select-window (frame-selected-window server-window))))
718 719
	    (when (window-minibuffer-p (selected-window))
	      (select-window (next-window nil 'nomini 0)))
720 721 722 723 724 725 726 727 728 729 730 731 732 733
	    ;; Move to a non-dedicated window, if we have one.
	    (when (window-dedicated-p (selected-window))
	      (select-window
	       (get-window-with-predicate
		(lambda (w)
		  (and (not (window-dedicated-p w))
		       (equal (frame-parameter (window-frame w) 'display)
			      (frame-parameter (selected-frame) 'display))))
		'nomini 'visible (selected-window))))
	    (condition-case nil
		(switch-to-buffer next-buffer)
	      ;; After all the above, we might still have ended up with
	      ;; a minibuffer/dedicated-window (if there's no other).
	      (error (pop-to-buffer next-buffer)))))))))
root's avatar
root committed
734

735
(define-key ctl-x-map "#" 'server-edit)
736 737

(defun server-unload-hook ()
738
  (server-mode -1)
739 740 741
  (remove-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
  (remove-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
  (remove-hook 'kill-buffer-hook 'server-kill-buffer))
742

743
(add-hook 'kill-emacs-hook (lambda () (server-mode -1))) ;Cleanup upon exit.
744
(add-hook 'server-unload-hook 'server-unload-hook)
Roland McGrath's avatar
Roland McGrath committed
745 746

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
747

748
;; arch-tag: 1f7ecb42-f00a-49f8-906d-61995d84c8d6
Eric S. Raymond's avatar
Eric S. Raymond committed
749
;;; server.el ends here