server.el 35.3 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,87,92,94,95,96,97,98,99,2000,01,02,03,2004
4
;;	 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
Eric S. Raymond's avatar
Eric S. Raymond committed
17
;; the Free Software Foundation; either version 2, 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 27 28
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, 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 86
(defgroup server nil
  "Emacs running as a server process."
  :group 'external)

(defcustom server-visit-hook nil
87
  "*Hook run when visiting a file for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
88
  :group 'server
89
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91

(defcustom server-switch-hook nil
92
  "*Hook run when switching to a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
93
  :group 'server
94
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
95 96

(defcustom server-done-hook nil
97
  "*Hook run when done editing a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
98
  :group 'server
99
  :type 'hook)
100

101 102
(defvar server-process nil
  "The current server process.")
root's avatar
root committed
103 104 105

(defvar server-clients nil
  "List of current server clients.
Karoly Lorentey's avatar
Karoly Lorentey committed
106 107
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
108

root's avatar
root committed
109
(defvar server-buffer-clients nil
110
  "List of client ids for clients requesting editing of current buffer.")
111
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
112 113 114
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

Dave Love's avatar
Dave Love committed
115 116
(defcustom server-window nil
  "*Specification of the window to use for selecting Emacs server buffers.
117
If nil, use the selected window.
118
If it is a function, it should take one argument (a buffer) and
Dave Love's avatar
Dave Love committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132
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
  :version "21.4"
  :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")))
133

Richard M. Stallman's avatar
Richard M. Stallman committed
134
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
Dave Love's avatar
Dave Love committed
135 136 137
  "*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
138 139
  :group 'server
  :type 'regexp)
root's avatar
root committed
140

141 142 143
(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
144
it with Emacs server.  If nil, kill only buffers as specified by
145 146 147 148 149 150 151 152
`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
153 154 155
(or (assq 'server-buffer-clients minor-mode-alist)
    (setq minor-mode-alist (cons '(server-buffer-clients " Server") minor-mode-alist)))

156
(defvar server-existing-buffer nil
157
  "Non-nil means the buffer existed before the server was asked to visit it.
158
This means that the server should not kill the buffer when you say you
159
are done with it in the server.")
160 161
(make-variable-buffer-local 'server-existing-buffer)

Stefan Monnier's avatar
Stefan Monnier committed
162 163
(defvar server-name "server")

164 165 166
(defvar server-socket-dir nil
  "The directory in which to place the server socket.
Initialized by `server-start'.")
167

Karoly Lorentey's avatar
Karoly Lorentey committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
(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))))

212 213 214 215
(defun server-delete-client (client &optional noframe)
  "Delete CLIENT, including its buffers, displays and frames.
If NOFRAME is non-nil, let the frames live.  (To be used from
`delete-frame-functions'."
Karoly Lorentey's avatar
Karoly Lorentey committed
216 217 218 219 220 221 222 223 224
  ;; 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
      (setq server-clients (delq client server-clients))

      (dolist (buf buffers)
225 226 227 228 229 230 231 232 233 234
	(when (buffer-live-p buf)
	  (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))))))
Karoly Lorentey's avatar
Karoly Lorentey committed
235 236

      ;; Delete the client's tty.
237 238 239
      (let ((display-id (server-client-get client 'display)))
	(when (eq (display-live-p display-id) t)
	  (delete-display display-id)))
Karoly Lorentey's avatar
Karoly Lorentey committed
240 241

      ;; Delete the client's frames.
242 243 244 245 246
      (unless noframe
	(dolist (frame (frame-list))
	  (if (and (frame-live-p frame)
		   (equal (car client) (frame-parameter frame 'client)))
	      (delete-frame frame))))
Karoly Lorentey's avatar
Karoly Lorentey committed
247 248 249 250 251 252 253

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

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

254
(defun server-log (string &optional client)
Karoly Lorentey's avatar
Karoly Lorentey committed
255 256 257
  "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."
root's avatar
root committed
258
  (if (get-buffer "*server*")
259
      (with-current-buffer "*server*"
root's avatar
root committed
260
	(goto-char (point-max))
261
	(insert (current-time-string)
Karoly Lorentey's avatar
Karoly Lorentey committed
262 263 264 265
		(cond
		 ((null client) " ")
		 ((listp client) (format " %s: " (car client)))
		 (t (format " %s: " client)))
266
		string)
267
	(or (bolp) (newline)))))
root's avatar
root committed
268 269

(defun server-sentinel (proc msg)
Karoly Lorentey's avatar
Karoly Lorentey committed
270 271 272
  "The process sentinel for Emacs server connections."
  (server-log (format "Status changed to %s: %s" (process-status proc) msg) proc)
  (server-delete-client proc))
273

274 275
(defun server-handle-delete-frame (frame)
  "Delete the client connection when the emacsclient frame is deleted."
Karoly Lorentey's avatar
Karoly Lorentey committed
276
  (let ((proc (frame-parameter frame 'client)))
277 278 279 280 281 282 283 284 285 286 287
    (when (and proc
	       (or (window-system frame)
		   ;; A terminal display must not yet be deleted if
		   ;; there are other frames on it.
		   (< 0 (let ((frame-num 0))
			  (mapc (lambda (f)
				  (when (eq (frame-display f)
					    (frame-display frame))
				    (setq frame-num (1+ frame-num))))
				(frame-list))
			  frame-num))))
Karoly Lorentey's avatar
Karoly Lorentey committed
288
      (server-log (format "server-handle-delete-frame, frame %s" frame) proc)
289
      (server-delete-client proc 'noframe)))) ; Let delete-frame delete the frame later.
Karoly Lorentey's avatar
Karoly Lorentey committed
290

291
(defun server-handle-suspend-tty (display)
Karoly Lorentey's avatar
Karoly Lorentey committed
292
  "Notify the emacsclient process to suspend itself when its tty device is suspended."
293 294
  (dolist (proc (server-clients-with 'display display))
    (server-log (format "server-handle-suspend-tty, display %s" display) proc)
Karoly Lorentey's avatar
Karoly Lorentey committed
295 296 297
    (condition-case err
	(process-send-string proc "-suspend \n")
      (file-error (condition-case nil (server-delete-client proc) (error nil))))))
298

299
(defun server-unquote-arg (arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
300
  "Remove &-quotation from ARG."
301 302 303 304 305 306 307 308
  (replace-regexp-in-string
   "&." (lambda (s)
	  (case (aref s 1)
	    (?& "&")
	    (?- "-")
	    (?n "\n")
	    (t " ")))
   arg t t))
root's avatar
root committed
309

310
(defun server-quote-arg (arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
311
  "In ARG, insert a & before each &, each space, each newline, and -.
312 313 314 315 316 317 318 319 320 321 322
Change spaces to underscores, too, so that the return value never
contains a space."
  (replace-regexp-in-string
   "[-&\n ]" (lambda (s)
	       (case (aref s 0)
		 (?& "&&")
		 (?- "&-")
		 (?\n "&n")
		 (?\s "&_")))
   arg t t))

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
(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
      (letf (((default-file-modes) ?\700)) (make-directory dir))
      (setq attrs (file-attributes dir)))
    ;; Check that it's safe for use.
    (unless (and (eq t (car attrs)) (eq (nth 2 attrs) (user-uid))
		 (zerop (logand ?\077 (file-modes dir))))
      (error "The directory %s is unsafe" dir))))

Roland McGrath's avatar
Roland McGrath committed
339
;;;###autoload
root's avatar
root committed
340 341 342
(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
343 344
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
345 346
Emacs distribution as your standard \"editor\".

Karoly Lorentey's avatar
Karoly Lorentey committed
347 348
Prefix arg LEAVE-DEAD means just kill any existing server
communications subprocess."
root's avatar
root committed
349
  (interactive "P")
350 351 352 353 354 355 356 357 358 359
  (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))))
    ;; Make sure there is a safe directory in which to place the socket.
    (server-ensure-safe-dir server-socket-dir)
    ;; kill it dead!
root's avatar
root committed
360
    (if server-process
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
	(condition-case () (delete-process server-process) (error nil)))
    ;; 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)))
    (if leave-dead
	(progn
	  (server-log (message "Server stopped"))
	  (setq server-process nil))
      (if server-process
	  (server-log (message "Restarting server"))
	(server-log (message "Starting server")))
      (letf (((default-file-modes) ?\700))
	(add-hook 'suspend-tty-functions 'server-handle-suspend-tty)
	(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
	      (make-network-process
	       :name "server" :family 'local :server t :noquery t
	       :service (expand-file-name server-name server-socket-dir)
	       :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))))))
Dave Love's avatar
Dave Love committed
390 391 392 393 394 395 396 397 398 399 400 401 402

;;;###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
  :version "21.4"
  ;; 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
403 404

(defun server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
405 406
  "Process a request from the server to edit some files.
PROC is the server process.  Format of STRING is \"PATH PATH PATH... \\n\"."
407
  (server-log string proc)
408 409 410 411
  (let ((prev (process-get proc 'previous-string)))
    (when prev
      (setq string (concat prev string))
      (process-put proc 'previous-string nil)))
412
  (condition-case err
413
      (progn
Karoly Lorentey's avatar
Karoly Lorentey committed
414
	(server-add-client proc)
415 416 417 418 419 420 421
	;; If the input is multiple lines,
	;; process each line individually.
	(while (string-match "\n" string)
	  (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
422 423 424 425
		(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).
		display ; Open the frame on this display.
426 427 428 429 430 431
		dontkill       ; t if the client should not be killed.
		(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
432
	    (while (string-match " *[^ ]* " request)
433 434 435
	      (let ((arg (substring request (match-beginning 0) (1- (match-end 0)))))
		(setq request (substring request (match-end 0)))
		(cond
Karoly Lorentey's avatar
Karoly Lorentey committed
436 437 438 439
		 ;; -version CLIENT-VERSION:
		 ;; Check version numbers, signal an error if there is a mismatch.
		 ((and (equal "-version" arg)
		       (string-match "\\([0-9.]+\\) " request))
440
		  (let* ((client-version (match-string 1 request))
Karoly Lorentey's avatar
Karoly Lorentey committed
441 442
			 (truncated-emacs-version
			  (substring emacs-version 0 (length client-version))))
443 444 445 446
		    (setq request (substring request (match-end 0)))
		    (if (equal client-version truncated-emacs-version)
			(progn
			  (process-send-string proc "-good-version \n")
Karoly Lorentey's avatar
Karoly Lorentey committed
447 448 449 450
			  (server-client-set client 'version client-version))
		      (error (concat "Version mismatch: Emacs is "
				     truncated-emacs-version
				     ", emacsclient is " client-version)))))
451

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

Karoly Lorentey's avatar
Karoly Lorentey committed
455 456
		 ;; -display DISPLAY:
		 ;; Open X frames on the given instead of the default.
457 458 459 460
		 ((and (equal "-display" arg) (string-match "\\([^ ]*\\) " request))
		  (setq display (match-string 1 request)
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
461
		 ;; -window-system:  Open a new X frame.
462
		 ((equal "-window-system" arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
463
		  (unless (server-client-get client 'version)
464
		    (error "Protocol error; make sure to use the correct version of emacsclient"))
Karoly Lorentey's avatar
Karoly Lorentey committed
465 466 467 468
		  (setq frame (make-frame-on-display
			       (or display
				   (frame-parameter nil 'display)
				   (getenv "DISPLAY")
469 470 471 472 473
				   (error "Please specify display"))
			       (list (cons 'client proc))))
		  ;; XXX We need to ensure the client parameter is
		  ;; really set because Emacs forgets initialization
		  ;; parameters for X frames at the moment.
474
		  (modify-frame-parameters frame (list (cons 'client proc)))
Karoly Lorentey's avatar
Karoly Lorentey committed
475 476
		  (select-frame frame)
		  (server-client-set client 'frame frame)
477
		  (server-client-set client 'display (frame-display frame))
Karoly Lorentey's avatar
Karoly Lorentey committed
478 479 480
		  (setq dontkill t))

		 ;; -resume:  Resume a suspended tty frame.
481
		 ((equal "-resume" arg)
482
		  (let ((display-id (server-client-get client 'display)))
483
		    (setq dontkill t)
484 485
		    (when (eq (display-live-p display-id) t)
		      (resume-tty display-id))))
486

Karoly Lorentey's avatar
Karoly Lorentey committed
487 488 489
		 ;; -suspend:  Suspend the client's frame.  (In case we
		 ;; get out of sync, and a C-z sends a SIGTSTP to
		 ;; emacsclient.)
490
		 ((equal "-suspend" arg)
491
		  (let ((display-id (server-client-get client 'display)))
492
		    (setq dontkill t)
493 494
		    (when (eq (display-live-p display-id) t)
		      (suspend-tty display-id))))
495

Karoly Lorentey's avatar
Karoly Lorentey committed
496 497
		 ;; -ignore COMMENT:  Noop; useful for debugging emacsclient.
		 ;; (The given comment appears in the server log.)
498 499 500 501
		 ((and (equal "-ignore" arg) (string-match "\\([^ ]*\\) " request))
		  (setq dontkill t
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
502
		 ;; -tty DEVICE-NAME TYPE:  Open a new tty frame at the client.
503 504 505 506
		 ((and (equal "-tty" arg) (string-match "\\([^ ]*\\) \\([^ ]*\\) " request))
		  (let ((tty (server-unquote-arg (match-string 1 request)))
			(type (server-unquote-arg (match-string 2 request))))
		    (setq request (substring request (match-end 0)))
Karoly Lorentey's avatar
Karoly Lorentey committed
507 508
		    (unless (server-client-get client 'version)
		      (error "Protocol error; make sure you use the correct version of emacsclient"))
509
		    (setq frame (make-frame-on-tty tty type (list (cons 'client proc))))
Karoly Lorentey's avatar
Karoly Lorentey committed
510 511
		    (select-frame frame)
		    (server-client-set client 'frame frame)
512 513
		    (server-client-set client 'tty (display-name frame))
		    (server-client-set client 'display (frame-display frame))
514 515
		    ;; Set up display for the remote locale.
		    (configure-display-for-locale)
Karoly Lorentey's avatar
Karoly Lorentey committed
516 517 518 519 520
		    ;; Reply with our pid.
		    (process-send-string proc (concat "-emacs-pid " (number-to-string (emacs-pid)) "\n"))
		    (setq dontkill t)))

		 ;; -position LINE:  Go to the given line in the next file.
521 522 523 524
		 ((and (equal "-position" arg) (string-match "\\(\\+[0-9]+\\) " request))
		  (setq request (substring request (match-end 0))
			lineno (string-to-int (substring (match-string 1 request) 1))))

Karoly Lorentey's avatar
Karoly Lorentey committed
525
		 ;; -position LINE:COLUMN:  Set point to the given position in the next file.
526 527 528 529 530
		 ((and (equal "-position" arg) (string-match "\\+\\([0-9]+\\):\\([0-9]+\\) " request))
		  (setq request (substring request (match-end 0))
			lineno (string-to-int (match-string 1 request))
			columnno (string-to-int (match-string 2 request))))

Karoly Lorentey's avatar
Karoly Lorentey committed
531
		 ;; -file FILENAME:  Load the given file.
532 533 534 535 536 537 538 539 540 541
		 ((and (equal "-file" arg) (string-match "\\([^ ]+\\) " request))
		  (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))
		    (push (list file lineno columnno) files))
		  (setq lineno 1
			columnno 0))

Karoly Lorentey's avatar
Karoly Lorentey committed
542
		 ;; -eval EXPR:  Evaluate a Lisp expression.
543 544 545 546 547 548
		 ((and (equal "-eval" arg) (string-match "\\([^ ]+\\) " request))
		  (let ((expr (server-unquote-arg (match-string 1 request))))
		    (setq request (substring request (match-end 0)))
		    (if coding-system
			(setq expr (decode-coding-string expr coding-system)))
		    (let ((v (eval (car (read-from-string expr)))))
Karoly Lorentey's avatar
Karoly Lorentey committed
549
		      (when (and (not frame) v)
550 551 552 553
			(with-temp-buffer
			  (let ((standard-output (current-buffer)))
			    (pp v)
			    (process-send-string proc "-print ")
554 555 556 557 558 559 560 561
			    (process-send-string
			     proc (server-quote-arg
				   (buffer-substring-no-properties (point-min)
								   (point-max))))
			    (process-send-string proc "\n")))))
		    (setq lineno 1
			  columnno 0)))

Karoly Lorentey's avatar
Karoly Lorentey committed
562 563 564 565 566 567 568 569 570 571 572 573 574
		 ;; -env NAME VALUE:  An environment variable.
		 ((and (equal "-env" arg) (string-match "\\([^ ]+\\) \\([^ ]+\\) " request))
		  (let ((name (server-unquote-arg (match-string 1 request)))
			(value (server-unquote-arg (match-string 2 request))))
		    (when coding-system
			(setq name (decode-coding-string name coding-system))
			(setq value (decode-coding-string value coding-system)))
		    (setq request (substring request (match-end 0)))
		    (server-client-set
		     client 'environment
		     (cons (cons name value)
			   (server-client-get client 'environment)))))

575 576 577
		 ;; Unknown command.
		 (t (error "Unknown command: %s" arg)))))

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
	    (let (buffers)
	      (when files
		(run-hooks 'pre-command-hook)
		(setq buffers (server-visit-files files client nowait))
		(run-hooks 'post-command-hook))

	      ;; 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 (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 (substitute-command-keys
			    "When done with a buffer, type \\[server-edit]"))))))))
606

607 608 609 610 611 612
	;; Save for later any partial line that remains.
	(when (> (length string) 0)
	  (process-put proc 'previous-string string)))
    ;; condition-case
    (error (ignore-errors
	     (process-send-string
613
	      proc (concat "-error " (server-quote-arg (error-message-string err))))
614 615 616
	     (setq string "")
	     (server-log (error-message-string err) proc)
	     (delete-process proc)))))
root's avatar
root committed
617

618
(defun server-goto-line-column (file-line-col)
Karoly Lorentey's avatar
Karoly Lorentey committed
619 620 621
  "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'."
622 623 624 625 626
  (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)))))

627
(defun server-visit-files (files client &optional nowait)
628
  "Find FILES and return a list of buffers created.
629
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
Karoly Lorentey's avatar
Karoly Lorentey committed
630
CLIENT is the client that requested this operation.
631 632
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
633
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
634
  (let ((last-nonmenu-event t) client-record)
635 636 637
    ;; 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.
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
    (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)))
	  (push filen file-name-history)
	  (if (and obuf (set-buffer obuf))
	      (progn
		(cond ((file-exists-p filen)
		       (if (not (verify-visited-file-modtime obuf))
			   (revert-buffer t nil)))
		      (t
		       (if (y-or-n-p
Karoly Lorentey's avatar
Karoly Lorentey committed
653
			    (concat "File no longer exists: " filen
654 655 656 657 658 659 660 661 662 663
				    ", write buffer to file? "))
			   (write-file filen))))
		(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)
664 665 666 667 668 669 670
	  (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
671

672
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
673
  "Mark BUFFER as \"done\" for its client(s).
674 675
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,
676 677 678
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'."
679
  (let ((next-buffer nil)
Karoly Lorentey's avatar
Karoly Lorentey committed
680 681 682
	(killed nil))
    (dolist (client server-clients)
      (let ((buffers (server-client-get client 'buffers)))
683
	(or next-buffer
Karoly Lorentey's avatar
Karoly Lorentey committed
684 685 686 687 688 689 690 691 692 693 694 695 696 697
	    (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)))))
698
    (if (and (bufferp buffer) (buffer-name buffer))
699 700 701 702
	;; 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))
703
	  (with-current-buffer buffer
704 705
	    (setq server-buffer-clients nil)
	    (run-hooks 'server-done-hook))
706 707 708 709 710 711
	  ;; 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
712 713
	      (when (and (not killed)
			 server-kill-new-buffers
714 715
			 (with-current-buffer buffer
			   (not server-existing-buffer)))
716
		(setq killed t)
717
		(bury-buffer buffer)
718 719 720 721 722 723 724
		(kill-buffer buffer))
	      (unless killed
		(if (server-temp-file-p buffer)
		    (progn
		      (kill-buffer buffer)
		      (setq killed t))
		  (bury-buffer buffer)))))))
725
    (list next-buffer killed)))
root's avatar
root committed
726

727
(defun server-temp-file-p (&optional buffer)
root's avatar
root committed
728 729 730 731 732 733 734 735 736 737
  "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
738
  "Offer to save current buffer, mark it as \"done\" for clients.
739 740 741 742 743
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."
744 745 746 747 748 749 750 751 752 753 754 755
  (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))
      (if (and (buffer-modified-p)
	       buffer-file-name
	       (y-or-n-p (concat "Save file " buffer-file-name "? ")))
	  (save-buffer)))
    (server-buffer-done (current-buffer))))
756

Richard M. Stallman's avatar
Richard M. Stallman committed
757 758 759 760
;; 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.
761
(defun server-kill-buffer-query-function ()
Karoly Lorentey's avatar
Karoly Lorentey committed
762
  "Ask before killing a server buffer."
763
  (or (not server-buffer-clients)
764 765
      (let ((res t))
	(dolist (proc server-buffer-clients res)
Karoly Lorentey's avatar
Karoly Lorentey committed
766 767 768
	  (let ((client (server-client proc)))
	    (when (and client (eq (process-status proc) 'open))
	      (setq res nil)))))
769 770 771 772
      (yes-or-no-p (format "Buffer `%s' still has clients; kill it? "
			   (buffer-name (current-buffer))))))

(defun server-kill-emacs-query-function ()
Karoly Lorentey's avatar
Karoly Lorentey committed
773 774 775 776 777 778 779 780
  "Ask before exiting Emacs it has are live clients."
  (or (not server-clients)
      (let (live-client)
	(dolist (client server-clients live-client)
	  (if (memq t (mapcar 'buffer-live-p (server-client-get
					      client 'buffers)))
	      (setq live-client t))))
      (yes-or-no-p "This Emacs session has clients; exit anyway? ")))
781

782
(defvar server-kill-buffer-running nil
783
  "Non-nil while `server-kill-buffer' or `server-buffer-done' is running.")
784

785
(defun server-kill-buffer ()
Karoly Lorentey's avatar
Karoly Lorentey committed
786 787
  "Remove the current buffer from its clients' buffer list.
Designed to be added to `kill-buffer-hook'."
788 789 790
  ;; Prevent infinite recursion if user has made server-done-hook
  ;; call kill-buffer.
  (or server-kill-buffer-running
791 792 793 794
      (and server-buffer-clients
	   (let ((server-kill-buffer-running t))
	     (when server-process
	       (server-buffer-done (current-buffer) t))))))
root's avatar
root committed
795 796 797 798

(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.
799
The buffer is also killed if it did not exist before the clients asked for it.
root's avatar
root committed
800 801 802
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,
803 804 805
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
806 807
which filenames are considered temporary.

808
If invoked with a prefix argument, or if there is no server process running,
root's avatar
root committed
809 810 811 812 813 814
starts server process and that is all.  Invoked by \\[server-edit]."
  (interactive "P")
  (if (or arg
	  (not server-process)
	  (memq (process-status server-process) '(signal exit)))
      (server-start nil)
815
    (apply 'server-switch-buffer (server-done))))
root's avatar
root committed
816

817
(defun server-switch-buffer (&optional next-buffer killed-one)
root's avatar
root committed
818
  "Switch to another buffer, preferably one that has a client.
Karoly Lorentey's avatar
Karoly Lorentey committed
819 820 821 822 823 824
Arg NEXT-BUFFER is a suggestion; if it is a live buffer, use it.

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."
825
  (if (null next-buffer)
Karoly Lorentey's avatar
Karoly Lorentey committed
826 827 828 829 830 831 832 833 834 835 836
      (progn
	(let ((rest server-clients))
	  (while (and rest (not next-buffer))
	    (let ((client (car rest)))
	      ;; Only look at frameless clients.
	      (when (not (server-client-get client 'frame))
		(setq next-buffer (car (server-client-get client 'buffers))))
	      (setq rest (cdr rest)))))
	(and next-buffer (server-switch-buffer next-buffer killed-one))
	(unless (or next-buffer killed-one (window-dedicated-p (selected-window)))
	  ;; (switch-to-buffer (other-buffer))
837
	  (message "No server buffers remain to edit")))
Karoly Lorentey's avatar
Karoly Lorentey committed
838
    (if (not (buffer-live-p next-buffer))
839
	;; If NEXT-BUFFER is a dead buffer, remove the server records for it
root's avatar
root committed
840
	;; and try the next surviving server buffer.
841 842
	(apply 'server-switch-buffer (server-buffer-done next-buffer))
      ;; OK, we know next-buffer is live, let's display and select it.
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
      (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)))
		(if (eq (frame-visible-p frame) 'icon)
		    (raise-frame frame))
		(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)
		   (if (not (frame-live-p server-window))
		       (setq server-window (make-frame)))
		   (select-window (frame-selected-window server-window))))
	    (if (window-minibuffer-p (selected-window))
		(select-window (next-window nil 'nomini 0)))
	    ;; 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
877

878 879 880 881 882 883 884 885 886 887 888 889 890
(defun server-save-buffers-kill-display (&optional arg)
  "Offer to save each buffer, then kill the current connection.
If the current frame has no client, kill Emacs itself.

With prefix arg, silently save all file-visiting buffers, then kill."
  (interactive "P")
  (let ((proc (frame-parameter (selected-frame) 'client)))
    (if (and proc)
	(progn
	  (save-some-buffers arg t)
	  (server-delete-client proc))
      (save-buffers-kill-emacs))))

891
(global-set-key "\C-x#" 'server-edit)
892

893 894
;;;###autoload
(defun server-getenv (variable &optional frame)
895 896 897 898 899 900 901 902 903 904
  "Get the value of VARIABLE in the client environment of frame FRAME.
VARIABLE should be a string.  Value is nil if VARIABLE is undefined in
the environment.  Otherwise, value is a string.

If FRAME is an emacsclient frame, then the variable is looked up
in the environment of the emacsclient process; otherwise the
function consults the environment of the Emacs process.

If FRAME is nil or missing, then the selected frame is used."
  (when (not frame) (setq frame (selected-frame)))
905 906
  (let ((client (frame-parameter frame 'client)) env)
    (if (null client)
907
	(getenv variable)
908
      (setq env (server-client-get client 'environment))
909 910
      (if (null env)
	  (getenv variable)
911
	(cdr (assoc variable env))))))
912

913
(defun server-unload-hook ()
Karoly Lorentey's avatar
Karoly Lorentey committed
914
  "Unload the server library."
Dave Love's avatar
Dave Love committed
915
  (server-start t)
Karoly Lorentey's avatar
Karoly Lorentey committed
916 917
  (remove-hook 'suspend-tty-functions 'server-handle-suspend-tty)
  (remove-hook 'delete-frame-functions 'server-handle-delete-frame)
918 919 920
  (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))
Roland McGrath's avatar
Roland McGrath committed
921 922

(provide 'server)
Eric S. Raymond's avatar
Eric S. Raymond committed
923

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