lisp/telnet.el

   1 ;;; telnet.el --- run a telnet session from within an Emacs buffer
   2
   3 ;; Copyright (C) 1985, 1988, 1992, 1994 Free Software Foundation, Inc.
   4
   5 ;; Author: William F. Schelter
   6 ;; Maintainer: FSF
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; This mode is intended to be used for telnet or rsh to a remode host;
  28 ;; `telnet' and `rsh' are the two entry points.  Multiple telnet or rsh
  29 ;; sessions are supported.
  30 ;;
  31 ;; Normally, input is sent to the remote telnet/rsh line-by-line, as you
  32 ;; type RET or LFD.  C-c C-c sends a C-c to the remote immediately;
  33 ;; C-c C-z sends C-z immediately.  C-c C-q followed by any character
  34 ;; sends that character immediately.
  35 ;;
  36 ;; All RET characters are filtered out of the output coming back from the
  37 ;; remote system.  The mode tries to do other useful translations based
  38 ;; on what it sees coming back from the other system before the password
  39 ;; query.  It knows about UNIX, ITS, TOPS-20 and Explorer systems.
  40
  41 ;;; Code:
  42
  43 ;; to do fix software types for lispm:
  44 ;; to eval current expression.  Also to try to send escape keys correctly.
  45 ;; essentially we'll want the rubout-handler off.
  46
  47 ;; filter is simplistic but should be okay for typical shell usage.
  48 ;; needs hacking if it is going to deal with asynchronous output in a sane
  49 ;; manner
  50
  51 (require 'comint)
  52
  53 (defvar telnet-new-line "\r")
  54 (defvar telnet-mode-map nil)
  55 (defvar telnet-prompt-pattern "^[^#$%>\n]*[#$%>] *")
  56 (defvar telnet-replace-c-g nil)
  57 (make-variable-buffer-local
  58  (defvar telnet-remote-echoes t
  59    "True if the telnet process will echo input."))
  60 (make-variable-buffer-local
  61  (defvar telnet-interrupt-string "\C-c" "String sent by C-c."))
  62
  63 (defvar telnet-count 0
  64   "Number of output strings from telnet process while looking for password.")
  65 (make-variable-buffer-local 'telnet-count)
  66
  67 (defvar telnet-program "telnet"
  68   "Program to run to open a telnet connection.")
  69
  70 (defvar telnet-initial-count -50
  71   "Initial value of `telnet-count'.  Should be set to the negative of the
  72 number of terminal writes telnet will make setting up the host connection.")
  73
  74 (defvar telnet-maximum-count 4
  75   "Maximum value `telnet-count' can have.
  76 After this many passes, we stop looking for initial setup data.
  77 Should be set to the number of terminal writes telnet will make
  78 rejecting one login and prompting again for a username and password.")
  79
  80 (defun telnet-interrupt-subjob ()
  81   (interactive)
  82   "Interrupt the program running through telnet on the remote host."
  83   (send-string nil telnet-interrupt-string))
  84
  85 (defun telnet-c-z ()
  86   (interactive)
  87   (send-string nil "\C-z"))
  88
  89 (defun send-process-next-char ()
  90   (interactive)
  91   (send-string nil
  92                (char-to-string
  93                 (let ((inhibit-quit t))
  94                   (prog1 (read-char)
  95                     (setq quit-flag nil))))))
  96
  97 ; initialization on first load.
  98 (if telnet-mode-map
  99     nil
 100   (setq telnet-mode-map (nconc (make-sparse-keymap) comint-mode-map))
 101   (define-key telnet-mode-map "\C-m" 'telnet-send-input)
 102 ;  (define-key telnet-mode-map "\C-j" 'telnet-send-input)
 103   (define-key telnet-mode-map "\C-c\C-q" 'send-process-next-char)
 104   (define-key telnet-mode-map "\C-c\C-c" 'telnet-interrupt-subjob)
 105   (define-key telnet-mode-map "\C-c\C-z" 'telnet-c-z))
 106
 107 ;;maybe should have a flag for when have found type
 108 (defun telnet-check-software-type-initialize (string)
 109   "Tries to put correct initializations in.  Needs work."
 110   (let ((case-fold-search t))
 111     (cond ((string-match "unix" string)
 112          (setq telnet-prompt-pattern comint-prompt-regexp)
 113          (setq telnet-new-line "\n"))
 114         ((string-match "tops-20" string) ;;maybe add telnet-replace-c-g
 115          (setq telnet-prompt-pattern  "[@>]*"))
 116         ((string-match "its" string)
 117          (setq telnet-prompt-pattern  "^[^*>\n]*[*>] *"))
 118         ((string-match "explorer" string)  ;;explorer telnet needs work
 119          (setq telnet-replace-c-g ?\n))))
 120   (setq comint-prompt-regexp telnet-prompt-pattern))
 121
 122 (defun telnet-initial-filter (proc string)
 123   ;For reading up to and including password; also will get machine type.
 124   (let ((case-fold-search t))
 125     (cond ((string-match "No such host" string)
 126            (kill-buffer (process-buffer proc))
 127            (error "No such host"))
 128           ((string-match "passw" string)
 129            (telnet-filter proc string)
 130            (setq telnet-count 0)
 131            (send-string proc (concat (comint-read-noecho "Password: " t)
 132                                      telnet-new-line)))
 133           (t (telnet-check-software-type-initialize string)
 134              (telnet-filter proc string)
 135              (cond ((> telnet-count telnet-maximum-count)
 136                     (set-process-filter proc 'telnet-filter))
 137                    (t (setq telnet-count (1+ telnet-count))))))))
 138
 139 ;; Identical to comint-simple-send, except that it sends telnet-new-line
 140 ;; instead of "\n".
 141 (defun telnet-simple-send (proc string)
 142   (comint-send-string proc string)
 143   (comint-send-string proc telnet-new-line))
 144
 145 (defun telnet-filter (proc string)
 146   (save-excursion
 147     (set-buffer (process-buffer proc))
 148     (let* ((last-insertion (marker-position (process-mark proc)))
 149            (delta (- (point) last-insertion))
 150            (ie (and comint-last-input-end
 151                     (marker-position comint-last-input-end)))
 152            (w (get-buffer-window (current-buffer)))
 153            (ws (and w (window-start w))))
 154       (goto-char last-insertion)
 155       (insert-before-markers string)
 156       (set-marker (process-mark proc) (point))
 157       (if ws (set-window-start w ws t))
 158       (if ie (set-marker comint-last-input-end ie))
 159       (while (progn (skip-chars-backward "^\C-m" last-insertion)
 160                     (> (point) last-insertion))
 161         (delete-region (1- (point)) (point)))
 162       (goto-char (process-mark proc))
 163       (and telnet-replace-c-g
 164            (subst-char-in-region last-insertion (point) ?\C-g
 165                                  telnet-replace-c-g t))
 166       ;; If point is after the insertion place, move it
 167       ;; along with the text.
 168       (if (> delta 0)
 169           (goto-char (+ (process-mark proc) delta))))))
 170
 171 (defun telnet-send-input ()
 172   (interactive)
 173 ;  (comint-send-input telnet-new-line telnet-remote-echoes)
 174   (comint-send-input)
 175   (if telnet-remote-echoes
 176       (delete-region comint-last-input-start
 177                      comint-last-input-end)))
 178
 179 ;;;###autoload (add-hook 'same-window-regexps "\\*telnet-.*\\*\\(\\|<[0-9]+>\\)")
 180
 181 ;;;###autoload
 182 (defun telnet (host)
 183   "Open a network login connection to host named HOST (a string).
 184 Communication with HOST is recorded in a buffer `*telnet-HOST*'.
 185 Normally input is edited in Emacs and sent a line at a time."
 186   (interactive "sOpen telnet connection to host: ")
 187   (let* ((comint-delimiter-argument-list '(?\  ?\t))
 188          (name (concat "telnet-" (comint-arguments host 0 nil) ))
 189          (buffer (get-buffer (concat "*" name "*")))
 190          process)
 191     (if (and buffer (get-buffer-process buffer))
 192         (pop-to-buffer (concat "*" name "*"))
 193       (pop-to-buffer (make-comint name telnet-program))
 194       (setq process (get-buffer-process (current-buffer)))
 195       (set-process-filter process 'telnet-initial-filter)
 196       ;; Don't send the `open' cmd till telnet is ready for it.
 197       (accept-process-output process)
 198       (erase-buffer)
 199       (send-string process (concat "open " host "\n"))
 200       (telnet-mode)
 201       (setq comint-input-sender 'telnet-simple-send)
 202       (setq telnet-count telnet-initial-count))))
 203
 204 (put 'telnet-mode 'mode-class 'special)
 205
 206 (defun telnet-mode ()
 207   "This mode is for using telnet (or rsh) from a buffer to another host.
 208 It has most of the same commands as comint-mode.
 209 There is a variable ``telnet-interrupt-string'' which is the character
 210 sent to try to stop execution of a job on the remote host.
 211 Data is sent to the remote host when RET is typed.
 212
 213 \\{telnet-mode-map}
 214 "
 215   (interactive)
 216   (comint-mode)
 217   (setq major-mode 'telnet-mode
 218         mode-name "Telnet"
 219         comint-prompt-regexp telnet-prompt-pattern)
 220   (use-local-map telnet-mode-map)
 221   (run-hooks 'telnet-mode-hook))
 222
 223 ;;;###autoload (add-hook 'same-window-regexps "\\*rsh-[^-]*\\*\\(\\|<[0-9]*>\\)")
 224
 225 ;;;###autoload
 226 (defun rsh (host)
 227   "Open a network login connection to host named HOST (a string).
 228 Communication with HOST is recorded in a buffer `*rsh-HOST*'.
 229 Normally input is edited in Emacs and sent a line at a time."
 230   (interactive "sOpen rsh connection to host: ")
 231   (require 'shell)
 232   (let ((name (concat "rsh-" host )))
 233     (pop-to-buffer (make-comint name remote-shell-program nil host))
 234     (set-process-filter (get-process name) 'telnet-initial-filter)
 235     (telnet-mode)
 236     (setq telnet-count -16)))
 237
 238 (provide 'telnet)
 239
 240 ;;; telnet.el ends here