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