server.el 49.2 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

Stefan Monnier's avatar
Stefan Monnier committed
78 79 80 81 82 83 84
;; Todo:

;; - handle command-line-args-left.
;; - move most of the args processing and decision making from emacsclient.c
;;   to here.
;; - fix up handling of the client's environment (place it in the terminal?).

Eric S. Raymond's avatar
Eric S. Raymond committed
85
;;; Code:
86 87 88

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

Richard M. Stallman's avatar
Richard M. Stallman committed
89 90 91 92
(defgroup server nil
  "Emacs running as a server process."
  :group 'external)

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
(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)

116
(defcustom server-auth-dir (concat user-emacs-directory "server/")
117 118 119 120 121 122
  "Directory for server authentication files."
  :group 'server
  :type 'directory
  :version "22.1")
(put 'server-auth-dir 'risky-local-variable t)

123
(defcustom server-raise-frame t
124
  "If non-nil, raise frame when switching to a buffer."
125 126 127 128
  :group 'server
  :type 'boolean
  :version "22.1")

Richard M. Stallman's avatar
Richard M. Stallman committed
129
(defcustom server-visit-hook nil
130
  "Hook run when visiting a file for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
131
  :group 'server
132
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
133 134

(defcustom server-switch-hook nil
135
  "Hook run when switching to a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
136
  :group 'server
137
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
138 139

(defcustom server-done-hook nil
140
  "Hook run when done editing a buffer for the Emacs server."
Richard M. Stallman's avatar
Richard M. Stallman committed
141
  :group 'server
142
  :type 'hook)
143

144 145
(defvar server-process nil
  "The current server process.")
root's avatar
root committed
146 147 148

(defvar server-clients nil
  "List of current server clients.
149
Each element is a process.")
Karoly Lorentey's avatar
Karoly Lorentey committed
150

root's avatar
root committed
151
(defvar server-buffer-clients nil
152
  "List of client processes requesting editing of current buffer.")
153
(make-variable-buffer-local 'server-buffer-clients)
root's avatar
root committed
154 155 156
;; Changing major modes should not erase this local.
(put 'server-buffer-clients 'permanent-local t)

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

Richard M. Stallman's avatar
Richard M. Stallman committed
177
(defcustom server-temp-file-regexp "^/tmp/Re\\|/draft$"
178
  "Regexp matching names of temporary files.
Dave Love's avatar
Dave Love committed
179 180
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
181 182
  :group 'server
  :type 'regexp)
root's avatar
root committed
183

184
(defcustom server-kill-new-buffers t
185
  "Whether to kill buffers when done with them.
186
If non-nil, kill a buffer unless it already existed before editing
187
it with the Emacs server.  If nil, kill only buffers as specified by
188
`server-temp-file-regexp'.
189 190
Please note that only buffers that still have a client are killed,
i.e. buffers visited with \"emacsclient --no-wait\" are never killed in
191 192 193 194 195
this way."
  :group 'server
  :type 'boolean
  :version "21.1")

root's avatar
root committed
196
(or (assq 'server-buffer-clients minor-mode-alist)
197
    (push '(server-buffer-clients " Server") minor-mode-alist))
root's avatar
root committed
198

199
(defvar server-existing-buffer nil
200
  "Non-nil means the buffer existed before the server was asked to visit it.
201
This means that the server should not kill the buffer when you say you
202
are done with it in the server.")
203 204
(make-variable-buffer-local 'server-existing-buffer)

Stefan Monnier's avatar
Stefan Monnier committed
205 206
(defvar server-name "server")

207 208 209
(defvar server-socket-dir nil
  "The directory in which to place the server socket.
Initialized by `server-start'.")
210

Karoly Lorentey's avatar
Karoly Lorentey committed
211 212 213
(defun server-clients-with (property value)
  "Return a list of clients with PROPERTY set to VALUE."
  (let (result)
214 215 216
    (dolist (proc server-clients result)
      (when (equal value (process-get proc property))
	(push proc result)))))
Karoly Lorentey's avatar
Karoly Lorentey committed
217 218 219 220

(defun server-add-client (proc)
  "Create a client for process PROC, if it doesn't already have one.
New clients have no properties."
221
  (add-to-list 'server-clients proc))
Karoly Lorentey's avatar
Karoly Lorentey committed
222

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

227 228
VARS should be a list of strings.
ENV should be in the same format as `process-environment'."
229
  (declare (indent 2))
230 231 232
  (let ((var (make-symbol "var"))
	(value (make-symbol "value")))
    `(let ((process-environment process-environment))
233
       (dolist (,var ,vars)
234
         (let ((,value (getenv-internal ,var ,env)))
235 236 237 238 239
           (push (if (null ,value)
                     ,var
                   (concat ,var "=" ,value))
                 process-environment)))
       (progn ,@body))))
240

241
(defun server-delete-client (proc &optional noframe)
242
  "Delete CLIENT, including its buffers, terminals and frames.
243
If NOFRAME is non-nil, let the frames live.  (To be used from
244 245
`delete-frame-functions'.)"
  (server-log (concat "server-delete-client" (if noframe " noframe"))
246
	      proc)
Karoly Lorentey's avatar
Karoly Lorentey committed
247
  ;; Force a new lookup of client (prevents infinite recursion).
248 249
  (when (memq proc server-clients)
    (let ((buffers (process-get proc 'buffers)))
Karoly Lorentey's avatar
Karoly Lorentey committed
250

251
      ;; Kill the client's buffers.
Karoly Lorentey's avatar
Karoly Lorentey committed
252
      (dolist (buf buffers)
253 254 255
	(when (buffer-live-p buf)
	  (with-current-buffer buf
	    ;; Kill the buffer if necessary.
256 257
	    (when (and (equal server-buffer-clients
			      (list proc))
258 259
		       (or (and server-kill-new-buffers
				(not server-existing-buffer))
260 261 262 263 264 265 266 267 268 269
			   (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
270

271 272 273 274 275 276 277 278 279 280
      ;; 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))))

281
      (setq server-clients (delq proc server-clients))
282

Karoly Lorentey's avatar
Karoly Lorentey committed
283
      ;; Delete the client's tty.
284
      (let ((terminal (process-get proc 'terminal)))
285 286
	;; Only delete the terminal if it is non-nil.
	(when (and terminal (eq (terminal-live-p terminal) t))
287
	  (delete-terminal terminal)))
Karoly Lorentey's avatar
Karoly Lorentey committed
288 289

      ;; Delete the client's process.
290 291
      (if (eq (process-status proc) 'open)
	  (delete-process proc))
Karoly Lorentey's avatar
Karoly Lorentey committed
292 293 294

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

295
(defun server-log (string &optional client)
Karoly Lorentey's avatar
Karoly Lorentey committed
296 297 298
  "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."
299 300 301 302
  (when (get-buffer "*server*")
    (with-current-buffer "*server*"
      (goto-char (point-max))
      (insert (current-time-string)
303 304 305 306
	      (cond
	       ((null client) " ")
	       ((listp client) (format " %s: " (car client)))
	       (t (format " %s: " client)))
307 308
	      string)
      (or (bolp) (newline)))))
root's avatar
root committed
309 310

(defun server-sentinel (proc msg)
Karoly Lorentey's avatar
Karoly Lorentey committed
311
  "The process sentinel for Emacs server connections."
312 313 314 315 316
  ;; 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))
317 318 319 320 321 322
  ;; 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
323 324
  (server-log (format "Status changed to %s: %s" (process-status proc) msg) proc)
  (server-delete-client proc))
325

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
(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)))

366 367
(defun server-handle-delete-frame (frame)
  "Delete the client connection when the emacsclient frame is deleted."
Karoly Lorentey's avatar
Karoly Lorentey committed
368
  (let ((proc (frame-parameter frame 'client)))
369 370
    (when (and (frame-live-p frame)
	       proc
371
	       ;; See if this is the last frame for this client.
372
	       (>= 1 (let ((frame-num 0))
373
		      (dolist (f (frame-list))
374 375 376
			(when (eq proc (frame-parameter f 'client))
			  (setq frame-num (1+ frame-num))))
		      frame-num)))
Karoly Lorentey's avatar
Karoly Lorentey committed
377
      (server-log (format "server-handle-delete-frame, frame %s" frame) proc)
378
      (server-delete-client proc 'noframe)))) ; Let delete-frame delete the frame later.
Karoly Lorentey's avatar
Karoly Lorentey committed
379

380
(defun server-handle-suspend-tty (terminal)
Karoly Lorentey's avatar
Karoly Lorentey committed
381
  "Notify the emacsclient process to suspend itself when its tty device is suspended."
382 383
  (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
384
    (condition-case err
385
	(server-send-string proc "-suspend \n")
386 387
      (file-error                       ;The pipe/socket was closed.
       (ignore-errors (server-delete-client proc))))))
388

389
(defun server-unquote-arg (arg)
390 391
  "Remove &-quotation from ARG.
See `server-quote-arg' and `server-process-filter'."
392 393 394 395 396 397 398 399
  (replace-regexp-in-string
   "&." (lambda (s)
	  (case (aref s 1)
	    (?& "&")
	    (?- "-")
	    (?n "\n")
	    (t " ")))
   arg t t))
root's avatar
root committed
400

401
(defun server-quote-arg (arg)
Karoly Lorentey's avatar
Karoly Lorentey committed
402
  "In ARG, insert a & before each &, each space, each newline, and -.
403
Change spaces to underscores, too, so that the return value never
404 405 406
contains a space.

See `server-unquote-arg' and `server-process-filter'."
407 408 409 410 411 412 413 414 415
  (replace-regexp-in-string
   "[-&\n ]" (lambda (s)
	       (case (aref s 0)
		 (?& "&&")
		 (?- "&-")
		 (?\n "&n")
		 (?\s "&_")))
   arg t t))

416 417 418 419 420
(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))

421 422 423 424 425 426 427 428 429
(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
430
      (letf (((default-file-modes) ?\700)) (make-directory dir t))
431 432
      (setq attrs (file-attributes dir)))
    ;; Check that it's safe for use.
433
    (unless (and (eq t (car attrs)) (eql (nth 2 attrs) (user-uid))
434 435
                 (or (eq system-type 'windows-nt)
                     (zerop (logand ?\077 (file-modes dir)))))
436 437
      (error "The directory %s is unsafe" dir))))

Roland McGrath's avatar
Roland McGrath committed
438
;;;###autoload
root's avatar
root committed
439 440 441
(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
442 443
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
444 445
Emacs distribution as your standard \"editor\".

446 447
Optional argument LEAVE-DEAD (interactively, a prefix arg) means just
kill any existing server communications subprocess."
root's avatar
root committed
448
  (interactive "P")
449 450 451 452 453 454 455
  (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))))
456 457 458
    (when server-process
      ;; kill it dead!
      (ignore-errors (delete-process server-process)))
459 460 461 462 463 464 465
    ;; 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
466
    ;; Now any previous server is properly stopped.
467 468 469 470
    (if leave-dead
	(progn
	  (server-log (message "Server stopped"))
	  (setq server-process nil))
471 472 473 474 475 476 477 478 479
      (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))
480
	  (add-hook 'suspend-tty-functions 'server-handle-suspend-tty)
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
	  (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
521

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
(defun server-running-p (&optional name)
  "Test whether server NAME is running."
  (interactive
   (list (if current-prefix-arg
	     (read-string "Server name: " nil nil server-name))))
  (unless name (setq name server-name))
  (condition-case nil
      (progn
	(delete-process
	 (make-network-process
	  :name "server-client-test" :family 'local :server nil :noquery t
	  :service (expand-file-name name server-socket-dir)))
	t)
    (file-error nil)))

Dave Love's avatar
Dave Love committed
537 538 539 540 541 542 543 544
;;;###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
545
  :version "22.1"
Dave Love's avatar
Dave Love committed
546 547 548
  ;; 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
549

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
(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)
578
                                (environment . ,(process-get proc 'env)))))))
579
  
580 581 582 583
    ;; ttys don't use the `display' parameter, but callproc.c does to set
    ;; the DISPLAY environment on subprocesses.
    (set-frame-parameter frame 'display
                         (getenv-internal "DISPLAY" (process-get proc 'env)))
584
    (select-frame frame)
585 586
    (process-put proc 'frame frame)
    (process-put proc 'terminal (frame-terminal frame))
587 588 589 590 591 592 593 594 595 596

    ;; 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)
597
  (if (not (fboundp 'make-frame-on-display))
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
      (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"))
615
                   params)))
616 617 618 619 620 621 622
      (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)
      (select-frame frame)
623 624
      (process-put proc 'frame frame)
      (process-put proc 'terminal (frame-terminal frame))
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

      ;; 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)))))

663
(defun* server-process-filter (proc string)
Dave Love's avatar
Dave Love committed
664
  "Process a request from the server to edit some files.
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
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:

682 683
`-auth AUTH-STRING'
  Authenticate the client using the secret authentication string
684
  AUTH-STRING.
685

686
`-env NAME=VALUE'
687 688
  An environment variable on the client side.

689 690 691
`-dir DIRNAME'
  The current working directory of the client process.

692 693 694
`-current-frame'
  Forbid the creation of new frames.

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
`-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.

724 725 726 727 728
`-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.

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 755
`-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)
756 757 758
  ;; First things first: let's check the authentication
  (unless (process-get proc :authenticated)
    (if (and (string-match "-auth \\(.*?\\)\n" string)
759 760 761 762 763
	     (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))
764
      (server-log "Authentication failed" proc)
765 766
      (server-send-string
       proc (concat "-error " (server-quote-arg "Authentication failed")))
767 768 769
      (delete-process proc)
      ;; We return immediately
      (return-from server-process-filter)))
770 771 772 773
  (let ((prev (process-get proc 'previous-string)))
    (when prev
      (setq string (concat prev string))
      (process-put proc 'previous-string nil)))
774
  (condition-case err
775
      (progn
Karoly Lorentey's avatar
Karoly Lorentey committed
776
	(server-add-client proc)
777 778 779 780 781 782 783 784 785
	(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)))
786 787 788 789
	  (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
790 791
		nowait ; t if emacsclient does not want to wait for us.
		frame ; The frame that was opened for the client (if any).
792
		display		     ; Open the frame on this display.
793
		dontkill       ; t if the client should not be killed.
794
                (commands ())
795
		dir
796 797
                (tty-name nil)       ;nil, `window-system', or the tty name.
                tty-type             ;string.
798 799 800 801 802
		(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
803
	    (while (string-match " *[^ ]* " request)
804 805
	      (let ((arg (substring request (match-beginning 0)
                                    (1- (match-end 0)))))
806 807
		(setq request (substring request (match-end 0)))
		(cond
808 809 810
		 ;; -version CLIENT-VERSION: obsolete at birth.
		 ((and (equal "-version" arg) (string-match "[^ ]+ " request))
                  (setq request (substring request (match-end 0))))
811

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

815
		 ;; -current-frame:  Don't create frames.
816
		 ((equal "-current-frame" arg) (setq tty-name nil))
817

Karoly Lorentey's avatar
Karoly Lorentey committed
818
		 ;; -display DISPLAY:
819
		 ;; Open X frames on the given display instead of the default.
820 821
		 ((and (equal "-display" arg)
                       (string-match "\\([^ ]*\\) " request))
822 823 824
		  (setq display (match-string 1 request)
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
825
		 ;; -window-system:  Open a new X frame.
826
		 ((equal "-window-system" arg)
827 828
                  (setq dontkill t)
                  (setq tty-name 'window-system))
Karoly Lorentey's avatar
Karoly Lorentey committed
829 830

		 ;; -resume:  Resume a suspended tty frame.
831
		 ((equal "-resume" arg)
832
		  (lexical-let ((terminal (process-get proc 'terminal)))
833
		    (setq dontkill t)
834 835 836 837
                    (push (lambda ()
                            (when (eq (terminal-live-p terminal) t)
                              (resume-tty terminal)))
                          commands)))
838

Karoly Lorentey's avatar
Karoly Lorentey committed
839 840 841
		 ;; -suspend:  Suspend the client's frame.  (In case we
		 ;; get out of sync, and a C-z sends a SIGTSTP to
		 ;; emacsclient.)
842
		 ((equal "-suspend" arg)
843
		  (lexical-let ((terminal (process-get proc 'terminal)))
844
		    (setq dontkill t)
845 846 847 848
                    (push (lambda ()
                            (when (eq (terminal-live-p terminal) t)
                              (suspend-tty terminal)))
                          commands)))
849

Karoly Lorentey's avatar
Karoly Lorentey committed
850 851
		 ;; -ignore COMMENT:  Noop; useful for debugging emacsclient.
		 ;; (The given comment appears in the server log.)
852
		 ((and (equal "-ignore" arg) (string-match "[^ ]* " request))
853 854 855
		  (setq dontkill t
			request (substring request (match-end 0))))

Karoly Lorentey's avatar
Karoly Lorentey committed
856
		 ;; -tty DEVICE-NAME TYPE:  Open a new tty frame at the client.
857 858 859 860 861 862 863 864 865 866 867 868
		 ((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))
869
		  (setq lineno (string-to-number (match-string 1 request))
870 871
			columnno (if (null (match-end 2)) 0
                                   (string-to-number (match-string 2 request)))
872
			request (substring request (match-end 0))))
873

Karoly Lorentey's avatar
Karoly Lorentey committed
874
		 ;; -file FILENAME:  Load the given file.
875 876
		 ((and (equal "-file" arg)
                       (string-match "\\([^ ]+\\) " request))
877 878 879 880 881
		  (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))
882
		    (push (list file lineno columnno) files)
883 884
		    (server-log (format "New file: %s (%d:%d)"
                                        file lineno columnno) proc))
885 886 887
		  (setq lineno 1
			columnno 0))

Karoly Lorentey's avatar
Karoly Lorentey committed
888
		 ;; -eval EXPR:  Evaluate a Lisp expression.
889 890 891 892
		 ((and (equal "-eval" arg)
                       (string-match "\\([^ ]+\\) " request))
		  (lexical-let ((expr (server-unquote-arg
                                       (match-string 1 request))))
893 894 895
		    (setq request (substring request (match-end 0)))
		    (if coding-system
			(setq expr (decode-coding-string expr coding-system)))
896 897
                    (push (lambda () (server-eval-and-print expr proc))
                          commands)
898 899 900
		    (setq lineno 1
			  columnno 0)))

901 902 903
		 ;; -env NAME=VALUE:  An environment variable.
		 ((and (equal "-env" arg) (string-match "\\([^ ]+\\) " request))
		  (let ((var (server-unquote-arg (match-string 1 request))))
904
		    ;; XXX Variables should be encoded as in getenv/setenv.
Karoly Lorentey's avatar
Karoly Lorentey committed
905
		    (setq request (substring request (match-end 0)))
906 907
                    (process-put proc 'env
                                 (cons var (process-get proc 'env)))))
Karoly Lorentey's avatar
Karoly Lorentey committed
908

909 910 911 912 913 914 915 916
		 ;; -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)))

917 918
		 ;; Unknown command.
		 (t (error "Unknown command: %s" arg)))))
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
            
            (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))))
943
    ;; condition-case
944 945 946 947
    (error (server-return-error proc err))))

(defun server-execute (proc files nowait commands dontkill frame tty-name)
  (condition-case err
948
      (let* ((buffers
949 950
              (when files
                (run-hooks 'pre-command-hook)
951
                (prog1 (server-visit-files files proc nowait)
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
                  (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
989

990
(defun server-goto-line-column (file-line-col)
Karoly Lorentey's avatar
Karoly Lorentey committed
991 992 993
  "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'."
994 995 996 997 998
  (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)))))

999
(defun server-visit-files (files proc &optional nowait)
1000
  "Find FILES and return a list of buffers created.
1001
FILES is an alist whose elements are (FILENAME LINENUMBER COLUMNNUMBER).
1002
PROC is the client that requested this operation.
1003 1004
NOWAIT non-nil means this client is not waiting for the results,
so don't mark these buffers specially, just visit them normally."
1005
  ;; Bind last-nonmenu-event to force use of keyboard, not mouse, for queries.
1006
  (let ((last-nonmenu-event t) client-record)
1007 1008 1009
    ;; 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.
1010 1011 1012 1013 1014
    (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.
1015
	(let* ((minibuffer-auto-raise (or server-raise-frame
1016
					  minibuffer-auto-raise))
1017
	       (filen (car file))
1018
	       (obuf (get-file-buffer filen)))
1019
	  (add-to-history 'file-name-history filen)
1020 1021 1022
	  (if (and obuf (set-buffer obuf))
	      (progn
		(cond ((file-exists-p filen)
1023
		       (when (not (verify-visited-file-modtime obuf))
1024
			 (revert-buffer t nil)))
1025
		      (t
1026
		       (when (y-or-n-p
1027 1028 1029
			      (concat "File no longer exists: " filen
				      ", write buffer to file? "))
			 (write-file filen))))
1030 1031
		(unless server-buffer-clients
		  (setq server-existing-buffer t))
1032 1033 1034 1035 1036 1037 1038
		(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)
1039
	  (push proc server-buffer-clients))
1040 1041
	(push (current-buffer) client-record)))
    (unless nowait
1042 1043
      (process-put proc 'buffers
                   (nconc (process-get proc 'buffers) client-record)))
1044
    client-record))
root's avatar
root committed
1045

1046
(defun server-buffer-done (buffer &optional for-killing)
root's avatar
root committed
1047
  "Mark BUFFER as \"done\" for its client(s).
1048 1049
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,
1050 1051 1052
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'."
1053
  (let ((next-buffer nil)
Karoly Lorentey's avatar
Karoly Lorentey committed
1054
	(killed nil))
1055 1056
    (dolist (proc server-clients)
      (let ((buffers (process-get proc 'buffers)))
1057
	(or next-buffer
Karoly Lorentey's avatar
Karoly Lorentey committed
1058 1059 1060
	    (setq next-buffer (nth 1 (memq buffer buffers))))
	(when buffers			; Ignore bufferless clients.
	  (setq buffers (delq buffer buffers))
1061
	  ;; Delete all dead buffers from PROC.
Karoly Lorentey's avatar
Karoly Lorentey committed
1062 1063 1064 1065
	  (dolist (b buffers)
	    (and (bufferp b)
		 (not (buffer-live-p b))
		 (setq buffers (delq b buffers))))