server.el 50.7 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, 2007 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
;; Changes by peck@sun.com and by rms.
11
;; Overhaul by Karoly Lorentey <lorentey@elte.hu> for multi-tty support.
root's avatar
root committed
12 13 14 15 16

;; 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
17
;; the Free Software Foundation; either version 3, or (at your option)
root's avatar
root committed
18 19 20 21 22 23 24 25
;; 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
26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
27 28
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
root's avatar
root committed
29

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

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

Erik Naggum's avatar
Erik Naggum committed
35
;; Load this library and do M-x server-edit to enable Emacs as a server.
36 37 38
;; 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
39

Erik Naggum's avatar
Erik Naggum committed
40 41 42 43
;; 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
44

Karoly Lorentey's avatar
Karoly Lorentey committed
45
;; Note that any number of clients may dispatch files to Emacs to be edited.
root's avatar
root committed
46

Erik Naggum's avatar
Erik Naggum committed
47
;; When you finish editing a Server buffer, again call server-edit
48 49
;; 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
50
;; and exited with server-edit, the client "editor" will return
51
;; to the program that invoked it.
root's avatar
root committed
52

Erik Naggum's avatar
Erik Naggum committed
53 54 55 56
;; 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
57

Erik Naggum's avatar
Erik Naggum committed
58 59
;; 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
60

Erik Naggum's avatar
Erik Naggum committed
61 62
;; 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
63

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

Erik Naggum's avatar
Erik Naggum committed
67 68 69 70 71
;; 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
72

73 74
;; 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
75 76
;; 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
77 78

;;; Code:
79 80 81

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

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

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
(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)

109
(defcustom server-auth-dir (concat user-emacs-directory "server/")
110 111 112 113 114 115
  "Directory for server authentication files."
  :group 'server
  :type 'directory
  :version "22.1")
(put 'server-auth-dir 'risky-local-variable t)

116
(defcustom server-raise-frame t
117
  "If non-nil, raise frame when switching to a buffer."
118 119 120 121
  :group 'server
  :type 'boolean
  :version "22.1")

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

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

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

137 138
(defvar server-process nil
  "The current server process.")
root's avatar
root committed
139 140 141

(defvar server-clients nil
  "List of current server clients.
Karoly Lorentey's avatar
Karoly Lorentey committed
142 143
Each element is (PROC PROPERTIES...) where PROC is a process object,
and PROPERTIES is an association list of client properties.")
Karoly Lorentey's avatar
Karoly Lorentey committed
144

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

Dave Love's avatar
Dave Love committed
151
(defcustom server-window nil
152
  "Specification of the window to use for selecting Emacs server buffers.
153
If nil, use the selected window.
154
If it is a function, it should take one argument (a buffer) and
Dave Love's avatar
Dave Love committed
155 156 157 158 159 160 161
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
162
  :version "22.1"
Dave Love's avatar
Dave Love committed
163 164 165 166
  :type '(choice (const :tag "Use selected window"
			:match (lambda (widget value)
				 (not (functionp value)))
			nil)
167
		 (function-item :tag "Display in new frame" switch-to-buffer-other-frame)
Dave Love's avatar
Dave Love committed
168 169
		 (function-item :tag "Use pop-to-buffer" pop-to-buffer)
		 (function :tag "Other function")))
170

Richard M. Stallman's avatar
Richard M. Stallman committed
171
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
172
  "Regexp matching names of temporary files.
Dave Love's avatar
Dave Love committed
173 174
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
175 176
  :group 'server
  :type 'regexp)
root's avatar
root committed
177

178
(defcustom server-kill-new-buffers t
179
  "Whether to kill buffers when done with them.
180
If non-nil, kill a buffer unless it already existed before editing
181
it with Emacs server.  If nil, kill only buffers as specified by
182 183 184 185 186 187 188 189
`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
190
(or (assq 'server-buffer-clients minor-mode-alist)
191
    (push '(server-buffer-clients " Server") minor-mode-alist))
root's avatar
root committed
192

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

Stefan Monnier's avatar
Stefan Monnier committed
199 200
(defvar server-name "server")

201 202 203
(defvar server-socket-dir nil
  "The directory in which to place the server socket.
Initialized by `server-start'.")
204

Karoly Lorentey's avatar
Karoly Lorentey committed
205 206 207 208 209 210 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
(defun server-client (proc)
  "Return the Emacs client corresponding to PROC.
PROC must be a process object.
The car of the result is PROC; the cdr is an association list.
See `server-client-get' and `server-client-set'."
  (assq proc server-clients))

(defun server-client-get (client property)
  "Get the value of PROPERTY in CLIENT.
CLIENT may be a process object, or a client returned by `server-client'.
Return nil if CLIENT has no such property."
  (or (listp client) (setq client (server-client client)))
  (cdr (assq property (cdr client))))

(defun server-client-set (client property value)
  "Set the PROPERTY to VALUE in CLIENT, and return VALUE.
CLIENT may be a process object, or a client returned by `server-client'."
  (let (p proc)
    (if (listp client)
	(setq proc (car client))
      (setq proc client
	    client (server-client client)))
    (setq p (assq property client))
    (cond
     (p (setcdr p value))
     (client (setcdr client (cons (cons property value) (cdr client))))
     (t (setq server-clients
	      `((,proc (,property . ,value)) . ,server-clients))))
    value))

(defun server-clients-with (property value)
  "Return a list of clients with PROPERTY set to VALUE."
  (let (result)
    (dolist (client server-clients result)
      (when (equal value (server-client-get client property))
	(setq result (cons (car client) result))))))

(defun server-add-client (proc)
  "Create a client for process PROC, if it doesn't already have one.
New clients have no properties."
  (unless (server-client proc)
    (setq server-clients (cons (cons proc nil)
			       server-clients))))

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
(defun server-getenv-from (env variable)
  "Get the value of VARIABLE in ENV.
VARIABLE should be a string.  Value is nil if VARIABLE is
undefined in ENV.  Otherwise, value is a string.

ENV should be in the same format as `process-environment'."
  (let (entry result)
    (while (and env (null result))
      (setq entry (car env)
	    env (cdr env))
      (if (and (> (length entry) (length variable))
	       (eq ?= (aref entry (length variable)))
	       (equal variable (substring entry 0 (length variable))))
	  (setq result (substring entry (+ (length variable) 1)))))
    result))

(defmacro server-with-environment (env vars &rest body)
  "Evaluate BODY with environment variables VARS set to those in ENV.
267 268
The environment variables are then restored to their previous values.

269 270
VARS should be a list of strings.
ENV should be in the same format as `process-environment'."
271
  (declare (indent 2))
272 273 274
  (let ((var (make-symbol "var"))
	(value (make-symbol "value")))
    `(let ((process-environment process-environment))
275 276
       (dolist (,var ,vars)
	 (let ((,value (server-getenv-from ,env ,var)))
277 278 279 280 281
           (push (if (null ,value)
                     ,var
                   (concat ,var "=" ,value))
                 process-environment)))
       (progn ,@body))))
282

283
(defun server-delete-client (client &optional noframe)
284
  "Delete CLIENT, including its buffers, terminals and frames.
285
If NOFRAME is non-nil, let the frames live.  (To be used from
286 287 288
`delete-frame-functions'.)"
  (server-log (concat "server-delete-client" (if noframe " noframe"))
	      client)
Karoly Lorentey's avatar
Karoly Lorentey committed
289 290 291 292 293 294 295
  ;; Force a new lookup of client (prevents infinite recursion).
  (setq client (server-client
		(if (listp client) (car client) client)))
  (let ((proc (car client))
	(buffers (server-client-get client 'buffers)))
    (when client

296
      ;; Kill the client's buffers.
Karoly Lorentey's avatar
Karoly Lorentey committed
297
      (dolist (buf buffers)
298 299 300
	(when (buffer-live-p buf)
	  (with-current-buffer buf
	    ;; Kill the buffer if necessary.
301 302
	    (when (and (equal server-buffer-clients
			      (list proc))
303 304
		       (or (and server-kill-new-buffers
				(not server-existing-buffer))
305 306 307 308 309 310 311 312 313 314
			   (server-temp-file-p))
		       (not (buffer-modified-p)))
	      (let (flag)
		(unwind-protect
		    (progn (setq server-buffer-clients nil)
			   (kill-buffer (current-buffer))
			   (setq flag t))
		  (unless flag
		    ;; Restore clients if user pressed C-g in `kill-buffer'.
		    (setq server-buffer-clients (list proc)))))))))
Karoly Lorentey's avatar
Karoly Lorentey committed
315

316 317 318 319 320 321 322 323 324 325
      ;; Delete the client's frames.
      (unless noframe
	(dolist (frame (frame-list))
	  (when (and (frame-live-p frame)
		     (equal proc (frame-parameter frame 'client)))
	    ;; Prevent `server-handle-delete-frame' from calling us
	    ;; recursively.
	    (set-frame-parameter frame 'client nil)
	    (delete-frame frame))))

326 327
      (setq server-clients (delq client server-clients))

Karoly Lorentey's avatar
Karoly Lorentey committed
328
      ;; Delete the client's tty.
329 330 331
      (let ((terminal (server-client-get client 'terminal)))
	(when (eq (terminal-live-p terminal) t)
	  (delete-terminal terminal)))
Karoly Lorentey's avatar
Karoly Lorentey committed
332 333 334 335 336 337 338

      ;; Delete the client's process.
      (if (eq (process-status (car client)) 'open)
	  (delete-process (car client)))

      (server-log "Deleted" proc))))

339
(defun server-log (string &optional client)
Karoly Lorentey's avatar
Karoly Lorentey committed
340 341 342
  "If a *server* buffer exists, write STRING to it for logging purposes.
If CLIENT is non-nil, add a description of it to the logged
message."
343 344 345 346
  (when (get-buffer "*server*")
    (with-current-buffer "*server*"
      (goto-char (point-max))
      (insert (current-time-string)
347 348 349 350
	      (cond
	       ((null client) " ")
	       ((listp client) (format " %s: " (car client)))
	       (t (format " %s: " client)))
351 352
	      string)
      (or (bolp) (newline)))))
root's avatar
root committed
353 354

(defun server-sentinel (proc msg)
Karoly Lorentey's avatar
Karoly Lorentey committed
355
  "The process sentinel for Emacs server connections."
356 357 358 359 360
  ;; 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))
361 362 363 364 365 366
  ;; Delete the associated connection file, if applicable.
  ;; This is actually problematic: the file may have been overwritten by
  ;; another Emacs server in the mean time, so it's not ours any more.
  ;; (and (process-contact proc :server)
  ;;      (eq (process-status proc) 'closed)
  ;;      (ignore-errors (delete-file (process-get proc :server-file))))
Karoly Lorentey's avatar
Karoly Lorentey committed
367 368
  (server-log (format "Status changed to %s: %s" (process-status proc) msg) proc)
  (server-delete-client proc))
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
(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)))
    ;; If there's no frame on that display yet, create and select one.
    (unless (equal (frame-parameter (selected-frame) 'display) display)
      (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)
        frame))))

(defun server-unselect-display (frame)
  (when (frame-live-p 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)))

410 411
(defun server-handle-delete-frame (frame)
  "Delete the client connection when the emacsclient frame is deleted."
Karoly Lorentey's avatar
Karoly Lorentey committed
412
  (let ((proc (frame-parameter frame 'client)))
413 414
    (when (and (frame-live-p frame)
	       proc
415
	       ;; See if this is the last frame for this client.
416
	       (>= 1 (let ((frame-num 0))
417
		      (dolist (f (frame-list))
418 419 420
			(when (eq proc (frame-parameter f 'client))
			  (setq frame-num (1+ frame-num))))
		      frame-num)))
Karoly Lorentey's avatar
Karoly Lorentey committed
421
      (server-log (format "server-handle-delete-frame, frame %s" frame) proc)
422
      (server-delete-client proc 'noframe)))) ; Let delete-frame delete the frame later.
Karoly Lorentey's avatar
Karoly Lorentey committed
423

424
(defun server-handle-suspend-tty (terminal)
Karoly Lorentey's avatar
Karoly Lorentey committed
425
  "Notify the emacsclient process to suspend itself when its tty device is suspended."
426 427
  (dolist (proc (server-clients-with 'terminal terminal))
    (server-log (format "server-handle-suspend-tty, terminal %s" terminal) proc)
Karoly Lorentey's avatar
Karoly Lorentey committed
428
    (condition-case err
429
	(server-send-string proc "-suspend \n")
Karoly Lorentey's avatar
Karoly Lorentey committed
430
      (file-error (condition-case nil (server-delete-client proc) (error nil))))))
431

432
(defun server-unquote-arg (arg)
433 434
  "Remove &-quotation from ARG.
See `server-quote-arg' and `server-process-filter'."
435 436 437 438 439 440 441 442
  (replace-regexp-in-string
   "&." (lambda (s)
	  (case (aref s 1)
	    (?& "&")
	    (?- "-")
	    (?n "\n")
	    (t " ")))
   arg t t))
root's avatar
root committed
443

444
(defun server-quote-arg (arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
445
  "In ARG, insert a & before each &, each space, each newline, and -.
446
Change spaces to underscores, too, so that the return value never
447 448 449
contains a space.

See `server-unquote-arg' and `server-process-filter'."
450 451 452 453 454 455 456 457 458
  (replace-regexp-in-string
   "[-&\n ]" (lambda (s)
	       (case (aref s 0)
		 (?& "&&")
		 (?- "&-")
		 (?\n "&n")
		 (?\s "&_")))
   arg t t))

459 460 461 462 463
(defun server-send-string (proc string)
  "A wrapper around `proc-send-string' for logging."
  (server-log (concat "Sent " string) proc)
  (process-send-string proc string))

464 465 466 467 468 469 470 471 472
(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
473
      (letf (((default-file-modes) ?\700)) (make-directory dir t))
474 475
      (setq attrs (file-attributes dir)))
    ;; Check that it's safe for use.
476
    (unless (and (eq t (car attrs)) (eql (nth 2 attrs) (user-uid))
477 478
                 (or (eq system-type 'windows-nt)
                     (zerop (logand ?\077 (file-modes dir)))))
479 480
      (error "The directory %s is unsafe" dir))))

Roland McGrath's avatar
Roland McGrath committed
481
;;;###autoload
root's avatar
root committed
482 483 484
(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
Karoly Lorentey's avatar
Karoly Lorentey committed
485 486
client \"editors\" can send your editing commands to this Emacs
job.  To use the server, set up the program `emacsclient' in the
root's avatar
root committed
487 488
Emacs distribution as your standard \"editor\".

489 490
Optional argument LEAVE-DEAD (interactively, a prefix arg) means just
kill any existing server communications subprocess."
root's avatar
root committed
491
  (interactive "P")
492 493 494 495 496 497 498
  (when (or
	 (not server-clients)
	 (yes-or-no-p
	  "The current server still has clients; delete them? "))
    ;; It is safe to get the user id now.
    (setq server-socket-dir (or server-socket-dir
				(format "/tmp/emacs%d" (user-uid))))
499 500 501
    (when server-process
      ;; kill it dead!
      (ignore-errors (delete-process server-process)))
502 503 504 505 506 507 508
    ;; Delete the socket files made by previous server invocations.
    (condition-case ()
	(delete-file (expand-file-name server-name server-socket-dir))
      (error nil))
    ;; If this Emacs already had a server, clear out associated status.
    (while server-clients
      (server-delete-client (car server-clients)))
Karoly Lorentey's avatar
Karoly Lorentey committed
509
    ;; Now any previous server is properly stopped.
510 511 512 513
    (if leave-dead
	(progn
	  (server-log (message "Server stopped"))
	  (setq server-process nil))
514 515 516 517 518 519 520 521 522
      (let* ((server-dir (if server-use-tcp server-auth-dir server-socket-dir))
	     (server-file (expand-file-name server-name server-dir)))
	;; Make sure there is a safe directory in which to place the socket.
	(server-ensure-safe-dir server-dir)
	;; Remove any leftover socket or authentication file.
	(ignore-errors (delete-file server-file))
	(when server-process
	  (server-log (message "Restarting server")))
	(letf (((default-file-modes) ?\700))
523
	  (add-hook 'suspend-tty-functions 'server-handle-suspend-tty)
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
	  (add-hook 'delete-frame-functions 'server-handle-delete-frame)
	  (add-hook 'kill-buffer-query-functions 'server-kill-buffer-query-function)
	  (add-hook 'kill-emacs-query-functions 'server-kill-emacs-query-function)
	  (setq server-process
		(apply #'make-network-process
		       :name server-name
		       :server t
		       :noquery t
		       :sentinel 'server-sentinel
		       :filter 'server-process-filter
		       ;; We must receive file names without being decoded.
		       ;; Those are decoded by server-process-filter according
		       ;; to file-name-coding-system.
		       :coding 'raw-text
		       ;; The rest of the args depends on the kind of socket used.
		       (if server-use-tcp
			   (list :family nil
				 :service t
				 :host (or server-host 'local)
				 :plist '(:authenticated nil))
			 (list :family 'local
			       :service server-file
			       :plist '(:authenticated t)))))
	  (unless server-process (error "Could not start server process"))
	  (when server-use-tcp
	    (let ((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))))
	      (process-put server-process :auth-key auth-key)
	      (with-temp-file server-file
		(set-buffer-multibyte nil)
		(setq buffer-file-coding-system 'no-conversion)
		(insert (format-network-address
			 (process-contact server-process :local))
			" " (int-to-string (emacs-pid))
			"\n" auth-key)))))))))
Dave Love's avatar
Dave Love committed
564 565 566 567 568 569 570 571 572

;;;###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
573
  :version "22.1"
Dave Love's avatar
Dave Love committed
574 575 576
  ;; 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
577

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
(defun server-eval-and-print (expr proc)
  "Eval EXPR and send the result back to client PROC."
  (let ((v (eval (car (read-from-string expr)))))
    (when (and v proc)
      (with-temp-buffer
        (let ((standard-output (current-buffer)))
          (pp v)
          (let ((text (buffer-substring-no-properties
                       (point-min) (point-max))))
            (server-send-string
             proc (format "-print %s\n"
                          (server-quote-arg text)))))))))

(defun server-create-tty-frame (tty type proc)
  (let ((frame
         (server-with-environment (process-get proc 'env)
             '("LANG" "LC_CTYPE" "LC_ALL"
               ;; For tgetent(3); list according to ncurses(3).
               "BAUDRATE" "COLUMNS" "ESCDELAY" "HOME" "LINES"
               "NCURSES_ASSUMED_COLORS" "NCURSES_NO_PADDING"
               "NCURSES_NO_SETBUF" "TERM" "TERMCAP" "TERMINFO"
               "TERMINFO_DIRS" "TERMPATH" 
               ;; rxvt wants these
               "COLORFGBG" "COLORTERM")
           (make-frame-on-tty tty type
                              ;; Ignore nowait here; we always need to
                              ;; clean up opened ttys when the client dies.
                              `((client . ,proc)
                                (environment . ,(process-get proc 'env))))))
        (client (server-client proc)))
  
    (set-frame-parameter frame 'display-environment-variable
                         (server-getenv-from (process-get proc 'env) "DISPLAY"))
    (select-frame frame)
    (server-client-set client 'frame frame)
    (server-client-set client 'tty (terminal-name frame))
    (server-client-set client 'terminal (frame-terminal frame))

    ;; Display *scratch* by default.
    (switch-to-buffer (get-buffer-create "*scratch*") 'norecord)

    ;; Reply with our pid.
    (server-send-string proc (concat "-emacs-pid "
                                     (number-to-string (emacs-pid)) "\n"))
    frame))

(defun server-create-window-system-frame (display nowait proc)
  (if (not (fboundp 'x-create-frame))
      (progn
        ;; This emacs does not support X.
        (server-log "Window system unsupported" proc)
        (server-send-string proc "-window-system-unsupported \n")
        nil)
    ;; Flag frame as client-created, but use a dummy client.
    ;; This will prevent the frame from being deleted when
    ;; emacsclient quits while also preventing
    ;; `server-save-buffers-kill-terminal' from unexpectedly
    ;; killing emacs on that frame.
    (let* ((params `((client . ,(if nowait 'nowait proc))
                     (environment . ,(process-get proc 'env))))
           (frame (make-frame-on-display
                   (or display
                       (frame-parameter nil 'display)
                       (getenv "DISPLAY")
                       (error "Please specify display"))
                   params))
           (client (server-client proc)))
      (server-log (format "%s created" frame) proc)
      ;; XXX We need to ensure the parameters are
      ;; really set because Emacs forgets unhandled
      ;; initialization parameters for X frames at
      ;; the moment.
      (modify-frame-parameters frame params)
      (set-frame-parameter frame 'display-environment-variable 
                           (server-getenv-from (process-get proc 'env) "DISPLAY"))
      (select-frame frame)
      (server-client-set client 'frame frame)
      (server-client-set client 'terminal (frame-terminal frame))

      ;; Display *scratch* by default.
      (switch-to-buffer (get-buffer-create "*scratch*") 'norecord)
      frame)))


(defun server-goto-toplevel (proc)
  (condition-case nil
      ;; If we're running isearch, we must abort it to allow Emacs to
      ;; display the buffer and switch to it.
      (dolist (buffer (buffer-list))
        (with-current-buffer buffer
          (when (bound-and-true-p isearch-mode)
            (isearch-cancel))))
    ;; Signaled by isearch-cancel.
    (quit (message nil)))
  (when (> (recursion-depth) 0)
    ;; We're inside a minibuffer already, so if the emacs-client is trying
    ;; to open a frame on a new display, we might end up with an unusable
    ;; frame because input from that display will be blocked (until exiting
    ;; the minibuffer).  Better exit this minibuffer right away.
    ;; Similarly with recursive-edits such as the splash screen.
    (run-with-timer 0 nil (lexical-let ((proc proc))
			    (lambda () (server-execute-continuation proc))))
    (top-level)))

;; We use various special properties on process objects:
;; - `env' stores the info about the environment of the emacsclient process.
;; - `continuation' is a no-arg function that we need to execute.  It contains
;;   commands we wanted to execute in some earlier invocation of the process
;;   filter but that we somehow were unable to process at that time
;;   (e.g. because we first need to throw to the toplevel).

(defun server-execute-continuation (proc)
  (let ((continuation (process-get proc 'continuation)))
    (process-put proc 'continuation nil)
    (if continuation (ignore-errors (funcall continuation)))))

694
(defun* server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
695
  "Process a request from the server to edit some files.
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
PROC is the server process.  STRING consists of a sequence of
commands prefixed by a dash.  Some commands have arguments; these
are &-quoted and need to be decoded by `server-unquote-arg'.  The
filter parses and executes these commands.

To illustrate the protocol, here is an example command that
emacsclient sends to create a new X frame (note that the whole
sequence is sent on a single line):

	-env HOME /home/lorentey
	-env DISPLAY :0.0
	... lots of other -env commands
	-display :0.0
	-window-system

The following commands are accepted by the server:

713 714
`-auth AUTH-STRING'
  Authenticate the client using the secret authentication string
715
  AUTH-STRING.
716

717
`-env NAME=VALUE'
718 719
  An environment variable on the client side.

720 721 722
`-dir DIRNAME'
  The current working directory of the client process.

723 724 725
`-current-frame'
  Forbid the creation of new frames.

726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
`-nowait'
  Request that the next frame created should not be
  associated with this client.

`-display DISPLAY'
  Set the display name to open X frames on.

`-position LINE[:COLUMN]'
  Go to the given line and column number
  in the next file opened.

`-file FILENAME'
  Load the given file in the current frame.

`-eval EXPR'
  Evaluate EXPR as a Lisp expression and return the
  result in -print commands.

`-window-system'
  Open a new X frame.

`-tty DEVICENAME TYPE'
  Open a new tty frame at the client.

`-suspend'
  Suspend this tty frame.  The client sends this string in
  response to SIGTSTP and SIGTTOU.  The server must cease all I/O
  on this tty until it gets a -resume command.

755 756 757 758 759
`-resume'
  Resume this tty frame. The client sends this string when it
  gets the SIGCONT signal and it is the foreground process on its
  controlling tty.

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
`-ignore COMMENT'
  Do nothing, but put the comment in the server
  log.  Useful for debugging.


The following commands are accepted by the client:

`-emacs-pid PID'
  Describes the process id of the Emacs process;
  used to forward window change signals to it.

`-window-system-unsupported'
  Signals that the server does not
  support creating X frames; the client must try again with a tty
  frame.

`-print STRING'
  Print STRING on stdout.  Used to send values
  returned by -eval.

`-error DESCRIPTION'
  Signal an error (but continue processing).

`-suspend'
  Suspend this terminal, i.e., stop the client process.  Sent
  when the user presses C-z."
  (server-log (concat "Received " string) proc)
787 788 789
  ;; First things first: let's check the authentication
  (unless (process-get proc :authenticated)
    (if (and (string-match "-auth \\(.*?\\)\n" string)
790 791 792 793 794
	     (equal (match-string 1 string) (process-get proc :auth-key)))
	(progn
	  (setq string (substring string (match-end 0)))
	  (process-put proc :authenticated t)
	  (server-log "Authentication successful" proc))
795
      (server-log "Authentication failed" proc)
796 797
      (server-send-string
       proc (concat "-error " (server-quote-arg "Authentication failed")))
798 799 800
      (delete-process proc)
      ;; We return immediately
      (return-from server-process-filter)))
801 802 803 804
  (let ((prev (process-get proc 'previous-string)))
    (when prev
      (setq string (concat prev string))
      (process-put proc 'previous-string nil)))
805
  (condition-case err
806
      (progn
Karoly Lorentey's avatar
Karoly Lorentey committed
807
	(server-add-client proc)
808 809 810 811 812 813 814 815 816
	(if (not (string-match "\n" string))
            ;; Save for later any partial line that remains.
            (when (> (length string) 0)
              (process-put proc 'previous-string string))
            
          ;; In earlier versions of server.el (where we used an `emacsserver'
          ;; process), there could be multiple lines.  Nowadays this is not
          ;; supported any more.
          (assert (eq (match-end 0) (length string)))
817 818 819 820
	  (let ((request (substring string 0 (match-beginning 0)))
		(coding-system (and default-enable-multibyte-characters
				    (or file-name-coding-system
					default-file-name-coding-system)))
Karoly Lorentey's avatar
Karoly Lorentey committed
821 822 823
		(client (server-client proc))
		nowait ; t if emacsclient does not want to wait for us.
		frame ; The frame that was opened for the client (if any).
824
		display		     ; Open the frame on this display.
825
		dontkill       ; t if the client should not be killed.
826
                (commands ())
827
		dir
828 829
                (tty-name nil)       ;nil, `window-system', or the tty name.
                tty-type             ;string.
830 831 832 833 834
		(files nil)
		(lineno 1)
		(columnno 0))
	    ;; Remove this line from STRING.
	    (setq string (substring string (match-end 0)))
Karoly Lorentey's avatar
Karoly Lorentey committed
835
	    (while (string-match " *[^ ]* " request)
836 837
	      (let ((arg (substring request (match-beginning 0)
                                    (1- (match-end 0)))))
838 839
		(setq request (substring request (match-end 0)))
		(cond
840 841 842
		 ;; -version CLIENT-VERSION: obsolete at birth.
		 ((and (equal "-version" arg) (string-match "[^ ]+ " request))
                  (setq request (substring request (match-end 0))))
843

Karoly Lorentey's avatar
Karoly Lorentey committed
844
		 ;; -nowait:  Emacsclient won't wait for a result.
845 846
		 ((equal "-nowait" arg) (setq nowait t))

847
		 ;; -current-frame:  Don't create frames.
848
		 ((equal "-current-frame" arg) (setq tty-name nil))
849

Karoly Lorentey's avatar
Karoly Lorentey committed
850
		 ;; -display DISPLAY:
851
		 ;; Open X frames on the given display instead of the default.
852 853
		 ((and (equal "-display" arg)
                       (string-match "\\([^ ]*\\) " request))
854 855 856
		  (setq display (match-string 1 request)
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
857
		 ;; -window-system:  Open a new X frame.
858
		 ((equal "-window-system" arg)
859 860
                  (setq dontkill t)
                  (setq tty-name 'window-system))
Karoly Lorentey's avatar
Karoly Lorentey committed
861 862

		 ;; -resume:  Resume a suspended tty frame.
863
		 ((equal "-resume" arg)
864
		  (lexical-let ((terminal (server-client-get client 'terminal)))
865
		    (setq dontkill t)
866 867 868 869
                    (push (lambda ()
                            (when (eq (terminal-live-p terminal) t)
                              (resume-tty terminal)))
                          commands)))
870

Karoly Lorentey's avatar
Karoly Lorentey committed
871 872 873
		 ;; -suspend:  Suspend the client's frame.  (In case we
		 ;; get out of sync, and a C-z sends a SIGTSTP to
		 ;; emacsclient.)
874
		 ((equal "-suspend" arg)
875
		  (lexical-let ((terminal (server-client-get client 'terminal)))
876
		    (setq dontkill t)
877 878 879 880
                    (push (lambda ()
                            (when (eq (terminal-live-p terminal) t)
                              (suspend-tty terminal)))
                          commands)))
881

Karoly Lorentey's avatar
Karoly Lorentey committed
882 883
		 ;; -ignore COMMENT:  Noop; useful for debugging emacsclient.
		 ;; (The given comment appears in the server log.)
884
		 ((and (equal "-ignore" arg) (string-match "[^ ]* " request))
885 886 887
		  (setq dontkill t
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
888
		 ;; -tty DEVICE-NAME TYPE:  Open a new tty frame at the client.
889 890 891 892 893 894 895 896 897 898 899 900
		 ((and (equal "-tty" arg)
                       (string-match "\\([^ ]*\\) \\([^ ]*\\) " request))
                  (setq tty-name (match-string 1 request))
                  (setq tty-type (match-string 2 request))
                  (setq dontkill t)
                  (setq request (substring request (match-end 0))))

		 ;; -position LINE[:COLUMN]:  Set point to the given
		 ;;  position in the next file.
		 ((and (equal "-position" arg)
                       (string-match "\\+\\([0-9]+\\)\\(?::\\([0-9]+\\)\\)? "
                                     request))
901
		  (setq lineno (string-to-number (match-string 1 request))
902 903
			columnno (if (null (match-end 2)) 0
                                   (string-to-number (match-string 2 request)))
904
			request (substring request (match-end 0))))
905

Karoly Lorentey's avatar
Karoly Lorentey committed
906
		 ;; -file FILENAME:  Load the given file.
907 908
		 ((and (equal "-file" arg)
                       (string-match "\\([^ ]+\\) " request))
909 910 911 912 913
		  (let ((file (server-unquote-arg (match-string 1 request))))
		    (setq request (substring request (match-end 0)))
		    (if coding-system
			(setq file (decode-coding-string file coding-system)))
		    (setq file (command-line-normalize-file-name file))
914
		    (push (list file lineno columnno) files)
915 916
		    (server-log (format "New file: %s (%d:%d)"
                                        file lineno columnno) proc))
917 918 919
		  (setq lineno 1
			columnno 0))

Karoly Lorentey's avatar
Karoly Lorentey committed
920
		 ;; -eval EXPR:  Evaluate a Lisp expression.
921 922 923 924
		 ((and (equal "-eval" arg)
                       (string-match "\\([^ ]+\\) " request))
		  (lexical-let ((expr (server-unquote-arg
                                       (match-string 1 request))))
925 926 927
		    (setq request (substring request (match-end 0)))
		    (if coding-system
			(setq expr (decode-coding-string expr coding-system)))
928 929
                    (push (lambda () (server-eval-and-print expr proc))
                          commands)
930 931 932
		    (setq lineno 1
			  columnno 0)))

933 934 935
		 ;; -env NAME=VALUE:  An environment variable.
		 ((and (equal "-env" arg) (string-match "\\([^ ]+\\) " request))
		  (let ((var (server-unquote-arg (match-string 1 request))))
936
		    ;; XXX Variables should be encoded as in getenv/setenv.
Karoly Lorentey's avatar
Karoly Lorentey committed
937
		    (setq request (substring request (match-end 0)))
938 939
                    (process-put proc 'env
                                 (cons var (process-get proc 'env)))))
Karoly Lorentey's avatar
Karoly Lorentey committed
940

941 942 943 944 945 946 947 948
		 ;; -dir DIRNAME:  The cwd of the emacsclient process.
		 ((and (equal "-dir" arg) (string-match "\\([^ ]+\\) " request))
		  (setq dir (server-unquote-arg (match-string 1 request)))
		  (setq request (substring request (match-end 0)))
		  (if coding-system
		      (setq dir (decode-coding-string dir coding-system)))
		  (setq dir (command-line-normalize-file-name dir)))

949 950
		 ;; Unknown command.
		 (t (error "Unknown command: %s" arg)))))
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
            
            (setq frame
                  (case tty-name
                    ((nil) (if display (server-select-display display)))
                    ((window-system)
                     (server-create-window-system-frame display nowait proc))
                    (t (server-create-tty-frame tty-name tty-type proc))))

            (process-put proc 'continuation
                         (lexical-let ((proc proc)
                                       (files files)
                                       (nowait nowait)
                                       (commands commands)
                                       (dontkill dontkill)
                                       (frame frame)
                                       (tty-name tty-name))
                           (lambda ()
                             (server-execute proc files nowait commands
                                             dontkill frame tty-name))))

            (when (or frame files)
              (server-goto-toplevel proc))

            (server-execute-continuation proc))))
975
    ;; condition-case
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
    (error (server-return-error proc err))))

(defun server-execute (proc files nowait commands dontkill frame tty-name)
  (condition-case err
      (let* ((client (server-client proc))
             (buffers
              (when files
                (run-hooks 'pre-command-hook)
                (prog1 (server-visit-files files client nowait)
                  (run-hooks 'post-command-hook)))))

        (mapc 'funcall (nreverse commands))
              
        ;; Delete the client if necessary.
        (cond
         (nowait
          ;; Client requested nowait; return immediately.
          (server-log "Close nowait client" proc)
          (server-delete-client proc))
         ((and (not dontkill) (null buffers))
          ;; This client is empty; get rid of it immediately.
          (server-log "Close empty client" proc)
          (server-delete-client proc)))
        (cond
         ((or isearch-mode (minibufferp))
          nil)
         ((and frame (null buffers))
          (message "%s" (substitute-command-keys
                         "When done with this frame, type \\[delete-frame]")))
         ((not (null buffers))
          (server-switch-buffer (car buffers))
          (run-hooks 'server-switch-hook)
          (unless nowait
            (message "%s" (substitute-command-keys
                           "When done with a buffer, type \\[server-edit]")))))
        (when (and frame (null tty-name))
          (server-unselect-display frame)))
    (error (server-return-error proc err))))

(defun server-return-error (proc err)
  (ignore-errors
    (server-send-string
     proc (concat "-error " (server-quote-arg
                             (error-message-string err))))
    (server-log (error-message-string err) proc)
    (delete-process proc)))
root's avatar
root committed
1022

1023
(defun server-goto-line-column (file-line-col)
Karoly Lorentey's avatar
Karoly Lorentey committed
1024 1025 1026
  "Move point to the position indicated in FILE-LINE-COL.
FILE-LINE-COL should be a three-element list as described in
`server-visit-files'."
1027 1028 1029 1030 1031
  (goto-line (nth 1 file-line-col))
  (let ((column-number (nth 2 file-line-col)))
    (if (> column-number 0)
	(move-to-column (1- column-number)))))

1032
(defun server-visit-files (files client &optional nowait)
1033
  "Find FILES and return a list of buffers created.
1034
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
Karoly Lorentey's avatar
Karoly Lorentey committed
1035
CLIENT is the client that requested this operation.
1036 1037
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
1038
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
1039
  (let ((last-nonmenu-event t) client-record)
1040 1041 1042
    ;; 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.
1043 1044 1045 1046 1047
    (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.
1048
	(let* ((minibuffer-auto-raise (or server-raise-frame
1049
					  minibuffer-auto-raise))
1050
	       (filen (car file))
1051
	       (obuf (get-file-buffer filen)))
1052
	  (add-to-history 'file-name-history filen)
1053 1054 1055
	  (if (and obuf (set-buffer obuf))
	      (progn
		(cond ((file-exists-p filen)
1056
		       (when (not (verify-visited-file-modtime obuf))
1057
			 (revert-buffer t nil)))
1058
		      (t
1059
		       (when (y-or-n-p
1060 1061 1062
			      (concat "File no longer exists: " filen
				      ", write buffer to file? "))
			 (write-file filen))))
1063 1064
		(unless server-buffer-clients
		  (setq server-existing-buffer t))
1065 1066 1067 1068 1069 1070 1071
		(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)
1072 1073 1074 1075 1076 1077 1078
	  (push (car client) server-buffer-clients))
	(push (current-buffer) client-record)))
    (unless nowait
      (server-client-set
       client 'buffers
       (nconc (server-client-get client 'buffers) client-record)))
    client-record))
root's avatar
root committed
1079

1080
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
1081
  "Mark BUFFER as \"done\" for its client(s).
1082 1083
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,
1084 1085 1086
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'."
1087
  (let ((next-buffer nil)
Karoly Lorentey's avatar
Karoly Lorentey committed
1088 1089 1090
	(killed nil))
    (dolist (client server-clients)
      (let ((buffers (server-client-get client 'buffers)))
1091
	(or next-buffer
Karoly Lorentey's avatar
Karoly Lorentey committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	    (setq next-buffer (nth 1 (memq buffer buffers))))
	(when buffers			; Ignore bufferless clients.
	  (setq buffers (delq buffer buffers))
	  ;; Delete all dead buffers from CLIENT.
	  (dolist (b buffers)
	    (and (bufferp b)
		 (not (buffer-live-p b))
		 (setq buffers (delq b buffers))))
	  (server-client-set client 'buffers buffers)
	  ;; If client now has no pending buffers,
	  ;; tell it that it is done, and forget it entirely.
	  (unless buffers
	    (server-log "Close" client)
	    (server-delete-client client)))))
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
    (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)))
1124
	      (setq killed t)
1125 1126 1127 1128 1129 1130 1131 1132
	      (bury-buffer buffer)
	      (kill-buffer buffer))
	    (unless killed
	      (if (server-temp-file-p buffer)
		  (progn
		    (kill-buffer buffer)
		    (setq killed t))
		(bury-buffer buffer)))))))
1133
    (list next-buffer killed)))
root's avatar
root committed
1134

1135
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
  "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
1146
  "Offer to save current buffer, mark it as \"done\" for clients.
1147 1148 1149 1150 1151
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."
1152 1153 1154 1155 1156 1157 1158
  (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))
1159 1160 1161 1162
      (when (and (buffer-modified-p)
		 buffer-file-name
		 (y-or-n-p (concat "Save file " buffer-file-name "? ")))
	(save-buffer)))
1163
    (server-buffer-done (current-buffer))))