1 ;;; net-utils.el --- network functions
3 ;; Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
5 ;; Author: Peter Breton <pbreton@cs.umb.edu>
6 ;; Created: Sun Mar 16 1997
7 ;; Keywords: network comm
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
29 ;; There are three main areas of functionality:
31 ;; * Wrap common network utility programs (ping, traceroute, netstat,
32 ;; nslookup, arp, route). Note that these wrappers are of the diagnostic
33 ;; functions of these programs only.
35 ;; * Implement some very basic protocols in Emacs Lisp (finger and whois)
37 ;; * Support connections to HOST/PORT, generally for debugging and the like.
38 ;; In other words, for doing much the same thing as "telnet HOST PORT", and
39 ;; then typing commands.
43 ;; On some systems, some of these programs are not in normal user path,
44 ;; but rather in /sbin, /usr/sbin, and so on.
51 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
52 ;; Customization Variables
53 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
55 (defgroup net-utils nil
56 "Network utility functions."
61 (defcustom net-utils-remove-ctl-m
62 (member system-type
(list 'windows-nt
'msdos
))
63 "If non-nil, remove control-Ms from output."
67 (defcustom traceroute-program
68 (if (eq system-type
'windows-nt
)
71 "Program to trace network hops to a destination."
75 (defcustom traceroute-program-options nil
76 "Options for the traceroute program."
78 :type
'(repeat string
))
80 (defcustom ping-program
"ping"
81 "Program to send network test packets to a host."
85 ;; On GNU/Linux and Irix, the system's ping program seems to send packets
86 ;; indefinitely unless told otherwise
87 (defcustom ping-program-options
88 (and (memq system-type
(list 'linux
'gnu
/linux
'irix
))
90 "Options for the ping program.
91 These options can be used to limit how many ICMP packets are emitted."
93 :type
'(repeat string
))
95 (defcustom ipconfig-program
96 (if (eq system-type
'windows-nt
)
99 "Program to print network configuration information."
103 (defcustom ipconfig-program-options
105 (if (eq system-type
'windows-nt
)
107 "Options for ipconfig-program."
109 :type
'(repeat string
))
111 (defcustom netstat-program
"netstat"
112 "Program to print network statistics."
116 (defcustom netstat-program-options
118 "Options for netstat-program."
120 :type
'(repeat string
))
122 (defcustom arp-program
"arp"
123 "Program to print IP to address translation tables."
127 (defcustom arp-program-options
129 "Options for arp-program."
131 :type
'(repeat string
))
133 (defcustom route-program
134 (if (eq system-type
'windows-nt
)
137 "Program to print routing tables."
141 (defcustom route-program-options
142 (if (eq system-type
'windows-nt
)
145 "Options for route-program."
147 :type
'(repeat string
))
149 (defcustom nslookup-program
"nslookup"
150 "Program to interactively query DNS information."
154 (defcustom nslookup-program-options nil
155 "List of options to pass to the nslookup program."
157 :type
'(repeat string
))
159 (defcustom nslookup-prompt-regexp
"^> "
160 "Regexp to match the nslookup prompt.
162 This variable is only used if the variable
163 `comint-use-prompt-regexp-instead-of-fields' is non-nil."
167 (defcustom dig-program
"dig"
168 "Program to query DNS information."
172 (defcustom ftp-program
"ftp"
173 "Progam to run to do FTP transfers."
177 (defcustom ftp-program-options nil
178 "List of options to pass to the FTP program."
180 :type
'(repeat string
))
182 (defcustom ftp-prompt-regexp
"^ftp>"
183 "Regexp which matches the FTP program's prompt.
185 This variable is only used if the variable
186 `comint-use-prompt-regexp-instead-of-fields' is non-nil."
190 (defcustom smbclient-program
"smbclient"
195 (defcustom smbclient-program-options nil
196 "List of options to pass to the smbclient program."
198 :type
'(repeat string
))
200 (defcustom smbclient-prompt-regexp
"^smb: \>"
201 "Regexp which matches the smbclient program's prompt.
203 This variable is only used if the variable
204 `comint-use-prompt-regexp-instead-of-fields' is non-nil."
208 ;; Internal variables
209 (defvar network-connection-service nil
)
210 (defvar network-connection-host nil
)
212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
214 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
216 (defconst nslookup-font-lock-keywords
218 (defvar font-lock-type-face
)
219 (defvar font-lock-keyword-face
)
220 (defvar font-lock-variable-name-face
)
223 (list "^[A-Za-z0-9 _]+:" 0 font-lock-type-face
)
224 (list "\\<\\(SOA\\|NS\\|MX\\|A\\|CNAME\\)\\>"
225 1 font-lock-keyword-face
)
229 (make-list 4 "[0-9]+")
231 0 font-lock-variable-name-face
)
234 (let ((host-expression "[-A-Za-z0-9]+"))
237 (make-list 2 host-expression
)
239 "\\(\\." host-expression
"\\)*"))
240 0 font-lock-variable-name-face
)))
241 "Expressions to font-lock for nslookup.")
243 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
245 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
247 ;; Simplified versions of some at-point functions from ffap.el.
248 ;; It's not worth loading all of ffap just for these.
249 (defun net-utils-machine-at-point ()
251 (buffer-substring-no-properties
253 (skip-chars-backward "-a-zA-Z0-9.")
256 (skip-chars-forward "-a-zA-Z0-9.")
257 (skip-chars-backward "." pt
)
260 (defun net-utils-url-at-point ()
262 (buffer-substring-no-properties
264 (skip-chars-backward "--:=&?$+@-Z_a-z~#,%")
265 (skip-chars-forward "^A-Za-z0-9" pt
)
268 (skip-chars-forward "--:=&?$+@-Z_a-z~#,%")
269 (skip-chars-backward ":;.,!?" pt
)
273 (defun net-utils-remove-ctrl-m-filter (process output-string
)
274 "Remove trailing control Ms."
275 (let ((old-buffer (current-buffer))
276 (filtered-string output-string
))
279 (set-buffer (process-buffer process
))
280 (setq moving
(= (point) (process-mark process
)))
282 (while (string-match "\r" filtered-string
)
283 (setq filtered-string
284 (replace-match "" nil nil filtered-string
)))
287 ;; Insert the text, moving the process-marker.
288 (goto-char (process-mark process
))
289 (insert filtered-string
)
290 (set-marker (process-mark process
) (point)))
291 (if moving
(goto-char (process-mark process
))))
292 (set-buffer old-buffer
))))
294 (defmacro net-utils-run-program
(name header program
&rest args
)
295 "Run a network information program."
296 ` (let ((buf (get-buffer-create (concat "*" ,name
"*"))))
299 (insert ,header
"\n")
301 (apply 'start-process
,name buf
,program
,@args
)
302 'net-utils-remove-ctrl-m-filter
)
306 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
307 ;; Wrappers for external network programs
308 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
311 (defun traceroute (target)
312 "Run traceroute program for TARGET."
313 (interactive "sTarget: ")
315 (if traceroute-program-options
316 (append traceroute-program-options
(list target
))
318 (net-utils-run-program
319 (concat "Traceroute" " " target
)
320 (concat "** Traceroute ** " traceroute-program
" ** " target
)
327 If your system's ping continues until interrupted, you can try setting
328 `ping-program-options'."
330 (list (read-from-minibuffer "Ping host: " (net-utils-machine-at-point))))
332 (if ping-program-options
333 (append ping-program-options
(list host
))
335 (net-utils-run-program
336 (concat "Ping" " " host
)
337 (concat "** Ping ** " ping-program
" ** " host
)
343 "Run ipconfig program."
345 (net-utils-run-program
347 (concat "** Ipconfig ** " ipconfig-program
" ** ")
349 ipconfig-program-options
))
351 ;; This is the normal name on most Unixes.
353 (defalias 'ifconfig
'ipconfig
)
357 "Run netstat program."
359 (net-utils-run-program
361 (concat "** Netstat ** " netstat-program
" ** ")
363 netstat-program-options
))
367 "Run the arp program."
369 (net-utils-run-program
371 (concat "** Arp ** " arp-program
" ** ")
373 arp-program-options
))
377 "Run the route program."
379 (net-utils-run-program
381 (concat "** Route ** " route-program
" ** ")
383 route-program-options
))
385 ;; FIXME -- Needs to be a process filter
386 ;; (defun netstat-with-filter (filter)
387 ;; "Run netstat program."
388 ;; (interactive "sFilter: ")
390 ;; (set-buffer (get-buffer "*Netstat*"))
391 ;; (goto-char (point-min))
392 ;; (delete-matching-lines filter))
395 (defun nslookup-host (host)
396 "Lookup the DNS information for HOST."
398 (list (read-from-minibuffer "Lookup host: " (net-utils-machine-at-point))))
400 (if nslookup-program-options
401 (append nslookup-program-options
(list host
))
403 (net-utils-run-program
407 (list "Nslookup" host nslookup-program
)
414 "Run nslookup program."
417 (comint-run nslookup-program
)
420 ;; Using a derived mode gives us keymaps, hooks, etc.
421 (define-derived-mode nslookup-mode comint-mode
"Nslookup"
422 "Major mode for interacting with the nslookup program."
424 (make-local-variable 'font-lock-defaults
)
425 '((nslookup-font-lock-keywords)))
426 (setq comint-prompt-regexp nslookup-prompt-regexp
)
427 (setq comint-input-autoexpand t
))
429 (define-key nslookup-mode-map
"\t" 'comint-dynamic-complete
)
438 (read-from-minibuffer
440 (or (ffap-string-at-point 'machine
) "")))))
441 (net-utils-run-program
445 (list "Dig" host dig-program
)
450 ;; This is a lot less than ange-ftp, but much simpler.
456 (read-from-minibuffer
457 "Ftp to Host: " (net-utils-machine-at-point))))
459 (let ((buf (get-buffer-create (concat "*ftp [" host
"]*"))))
462 (comint-exec buf
(concat "ftp-" host
) ftp-program nil
463 (if ftp-program-options
464 (append (list host
) ftp-program-options
)
466 (pop-to-buffer buf
)))
468 (define-derived-mode ftp-mode comint-mode
"FTP"
469 "Major mode for interacting with the ftp program."
470 (setq comint-prompt-regexp ftp-prompt-regexp
)
471 (setq comint-input-autoexpand t
)
472 ;; Only add the password-prompting hook if it's not already in the
473 ;; global hook list. This stands a small chance of losing, if it's
474 ;; later removed from the global list (very small, since any
475 ;; password prompts will probably immediately follow the initial
476 ;; connection), but it's better than getting prompted twice for the
478 (unless (memq 'comint-watch-for-password-prompt
479 (default-value 'comint-output-filter-functions
))
480 (add-hook 'comint-output-filter-functions
'comint-watch-for-password-prompt
483 ;; Occasionally useful
484 (define-key ftp-mode-map
"\t" 'comint-dynamic-complete
)
486 (defun smbclient (host service
)
487 "Connect to SERVICE on HOST via SMB."
490 (read-from-minibuffer
491 "Connect to Host: " (net-utils-machine-at-point))
492 (read-from-minibuffer "SMB Service: ")))
494 (let* ((name (format "smbclient [%s\\%s]" host service
))
495 (buf (get-buffer-create (concat "*" name
"*")))
496 (service-name (concat "\\\\" host
"\\" service
)))
499 (comint-exec buf name smbclient-program nil
500 (if smbclient-program-options
501 (append (list service-name
) smbclient-program-options
)
502 (list service-name
)))
503 (pop-to-buffer buf
)))
505 (defun smbclient-list-shares (host)
506 "List services on HOST."
509 (read-from-minibuffer
510 "Connect to Host: " (net-utils-machine-at-point))))
511 (let ((buf (get-buffer-create (format "*SMB Shares on %s*" host
))))
514 (comint-exec buf
"smbclient-list-shares"
515 smbclient-program nil
(list "-L" host
))
516 (pop-to-buffer buf
)))
518 (define-derived-mode smbclient-mode comint-mode
"smbclient"
519 "Major mode for interacting with the smbclient program."
520 (setq comint-prompt-regexp smbclient-prompt-regexp
)
521 (setq comint-input-autoexpand t
)
522 ;; Only add the password-prompting hook if it's not already in the
523 ;; global hook list. This stands a small chance of losing, if it's
524 ;; later removed from the global list (very small, since any
525 ;; password prompts will probably immediately follow the initial
526 ;; connection), but it's better than getting prompted twice for the
528 (unless (memq 'comint-watch-for-password-prompt
529 (default-value 'comint-output-filter-functions
))
530 (add-hook 'comint-output-filter-functions
'comint-watch-for-password-prompt
534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
535 ;; Network Connections
536 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
538 ;; Full list is available at:
539 ;; ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
540 (defvar network-connection-service-alist
543 (cons 'active-users
11)
559 (cons 'netbios-name
137)
560 (cons 'netbios-data
139)
564 "Alist of services and associated TCP port numbers.
565 This list is not complete.")
568 (defmacro run-network-program
(process-name host port
569 &optional initial-string
)
570 `(let ((tcp-connection)
572 (setq buf
(get-buffer-create (concat "*" ,process-name
"*")))
581 (error "Could not open connection to %s" ,host
))
583 (set-marker (process-mark tcp-connection
) (point-min))
584 (set-process-filter tcp-connection
'net-utils-remove-ctrl-m-filter
)
586 (process-send-string tcp-connection
587 (concat ,initial-string
"\r\n")))
588 (display-buffer buf
)))
590 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
592 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
594 (defcustom finger-X
.500-host-regexps nil
595 "A list of regular expressions matching host names.
596 If a host name passed to `finger' matches one of these regular
597 expressions, it is assumed to be a host that doesn't accept
598 queries of the form USER@HOST, and wants a query containing USER only."
600 :type
'(repeat regexp
)
605 (defun finger (user host
)
606 "Finger USER on HOST."
607 ;; One of those great interactive statements that's actually
608 ;; longer than the function call! The idea is that if the user
609 ;; uses a string like "pbreton@cs.umb.edu", we won't ask for the
610 ;; host name. If we don't see an "@", we'll prompt for the host.
612 (let* ((answer (read-from-minibuffer "Finger User: "
613 (net-utils-url-at-point)))
614 (index (string-match (regexp-quote "@") answer
)))
616 (list (substring answer
0 index
)
617 (substring answer
(1+ index
)))
619 (read-from-minibuffer "At Host: "
620 (net-utils-machine-at-point))))))
621 (let* ((user-and-host (concat user
"@" host
))
622 (process-name (concat "Finger [" user-and-host
"]"))
623 (regexps finger-X
.500-host-regexps
)
625 (while (and regexps
(not (string-match (car regexps
) host
)))
626 (setq regexps
(cdr regexps
)))
628 (setq user-and-host user
))
632 (cdr (assoc 'finger network-connection-service-alist
))
635 (defcustom whois-server-name
"rs.internic.net"
636 "Default host name for the whois service."
640 (defcustom whois-server-list
641 '(("whois.arin.net") ; Networks, ASN's, and related POC's (numbers)
642 ("rs.internic.net") ; domain related info
649 "A list of whois servers that can be queried."
651 :type
'(repeat (list string
)))
653 (defcustom whois-server-tld
654 '(("rs.internic.net" .
"com")
655 ("rs.internic.net" .
"org")
656 ("whois.ripe.net" .
"be")
657 ("whois.ripe.net" .
"de")
658 ("whois.ripe.net" .
"dk")
659 ("whois.ripe.net" .
"it")
660 ("whois.ripe.net" .
"fi")
661 ("whois.ripe.net" .
"fr")
662 ("whois.ripe.net" .
"uk")
663 ("whois.apnic.net" .
"au")
664 ("whois.apnic.net" .
"ch")
665 ("whois.apnic.net" .
"hk")
666 ("whois.apnic.net" .
"jp")
667 ("whois.nic.gov" .
"gov")
668 ("whois.nic.mil" .
"mil"))
669 "Alist to map top level domains to whois servers."
671 :type
'(repeat (cons string string
)))
673 (defcustom whois-guess-server t
674 "If non-nil then whois will try to deduce the appropriate whois
675 server from the query. If the query doesn't look like a domain or hostname
676 then the server named by whois-server-name is used."
680 (defun whois-get-tld (host)
681 "Return the top level domain of `host', or nil if it isn't a domain name."
682 (let ((i (1- (length host
)))
683 (max-len (- (length host
) 5)))
684 (while (not (or (= i max-len
) (char-equal (aref host i
) ?.
)))
688 (substring host
(1+ i
)))))
692 (defun whois (arg search-string
)
693 "Send SEARCH-STRING to server defined by the `whois-server-name' variable.
694 If `whois-guess-server' is non-nil, then try to deduce the correct server
695 from SEARCH-STRING. With argument, prompt for whois server."
696 (interactive "P\nsWhois: ")
697 (let* ((whois-apropos-host (if whois-guess-server
698 (rassoc (whois-get-tld search-string
)
701 (server-name (if whois-apropos-host
702 (car whois-apropos-host
)
706 (completing-read "Whois server name: "
707 whois-server-list nil nil
"whois.")
712 (cdr (assoc 'whois network-connection-service-alist
))
715 (defcustom whois-reverse-lookup-server
"whois.arin.net"
716 "Server which provides inverse DNS mapping."
721 (defun whois-reverse-lookup ()
723 (let ((whois-server-name whois-reverse-lookup-server
))
724 (call-interactively 'whois
)))
726 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
727 ;;; General Network connection
728 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
730 ;; Using a derived mode gives us keymaps, hooks, etc.
732 network-connection-mode comint-mode
"Network-Connection"
733 "Major mode for interacting with the network-connection program.")
735 (defun network-connection-mode-setup (host service
)
736 (make-local-variable 'network-connection-host
)
737 (setq network-connection-host host
)
738 (make-local-variable 'network-connection-service
)
739 (setq network-connection-service service
))
742 (defun network-connection-to-service (host service
)
743 "Open a network connection to SERVICE on HOST."
746 (read-from-minibuffer "Host: " (net-utils-machine-at-point))
747 (completing-read "Service: "
751 (list (symbol-name (car elt
)))))
752 network-connection-service-alist
))))
755 (cdr (assoc (intern service
) network-connection-service-alist
))))
758 (defun network-connection (host port
)
759 "Open a network connection to HOST on PORT."
760 (interactive "sHost: \nnPort: ")
761 (network-service-connection host
(number-to-string port
)))
763 (defun network-service-connection (host service
)
764 "Open a network connection to SERVICE on HOST."
766 (let* ((process-name (concat "Network Connection [" host
" " service
"]"))
767 (portnum (string-to-number service
))
768 (buf (get-buffer-create (concat "*" process-name
"*"))))
769 (or (zerop portnum
) (setq service portnum
))
774 (network-connection-mode)
775 (network-connection-mode-setup host service
)
776 (pop-to-buffer buf
)))
778 (defun network-connection-reconnect ()
779 "Reconnect a network connection, preserving the old input ring."
781 (let ((proc (get-buffer-process (current-buffer)))
782 (old-comint-input-ring comint-input-ring
)
783 (host network-connection-host
)
784 (service network-connection-service
))
785 (if (not (or (not proc
)
786 (eq (process-status proc
) 'closed
)))
787 (message "Still connected")
788 (goto-char (point-max))
789 (insert (format "Reopening connection to %s\n" host
))
790 (network-connection host
791 (if (numberp service
)
793 (cdr (assoc service network-connection-service-alist
))))
794 (and old-comint-input-ring
795 (setq comint-input-ring old-comint-input-ring
)))))
799 ;;; net-utils.el ends here