1 ;;; dns-mode.el --- a mode for viewing/editing Domain Name System master files
2 ;; Copyright (c) 2000, 2001, 2003, 2004 Free Software Foundation, Inc.
4 ;; Author: Simon Josefsson <simon@josefsson.org>
5 ;; Keywords: DNS master zone file SOA
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 ;; Boston, MA 02110-1301, USA.
26 ;; Use M-x dns-mode RET to invoke in master files.
28 ;; C-c C-s Increment SOA serial.
29 ;; Understands YYYYMMDDNN, Unix time, and serial number formats,
30 ;; and complains if it fail to find SOA serial.
32 ;; Put something similar to the following in your ~/.emacs to use this file:
34 ;; (load "~/path/to/dns-mode.el")
35 ;; (setq auto-mode-alist (cons '("\\.soa\\'" . dns-mode) auto-mode-alist))
39 ;; RFC 1034, "DOMAIN NAMES - CONCEPTS AND FACILITIES", P. Mockapetris.
40 ;; RFC 1035, "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION", P. Mockapetris.
44 ;; 2004-09-11 Posted on gnu.emacs.sources.
45 ;; 2004-09-13 Ported to XEmacs.
46 ;; 2004-09-14 Installed in Emacs CVS.
50 (defgroup dns-mode nil
51 "DNS master file mode configuration."
54 (defconst dns-mode-classes
'("IN" "CS" "CH" "HS")
55 "List of strings with known DNS classes.")
57 (defconst dns-mode-types
'("A" "NS" "MD" "MF" "CNAME" "SOA" "MB" "MG" "MR"
58 "NULL" "WKS" "PTR" "HINFO" "MINFO" "MX" "TXT"
59 "RP" "AFSDB" "X25" "ISDN" "RT" "NSAP" "NSAP"
60 "SIG" "KEY" "PX" "GPOS" "AAAA" "LOC" "NXT"
61 "EID" "NIMLOC" "SRV" "ATMA" "NAPTR" "KX" "CERT"
62 "A6" "DNAME" "SINK" "OPT" "APL" "DS" "SSHFP"
63 "RRSIG" "NSEC" "DNSKEY" "UINFO" "UID" "GID"
64 "UNSPEC" "TKEY" "TSIG" "IXFR" "AXFR" "MAILB"
66 "List of strings with known DNS types.")
70 (defvar dns-mode-control-entity-face
'font-lock-keyword-face
71 "Name of face used for control entities, e.g. $ORIGIN.")
73 (defvar dns-mode-bad-control-entity-face
'font-lock-warning-face
74 "Name of face used for non-standard control entities, e.g. $FOO.")
76 (defvar dns-mode-type-face
'font-lock-type-face
77 "Name of face used for DNS types, e.g., SOA.")
79 (defvar dns-mode-class-face
'font-lock-constant-face
80 "Name of face used for DNS classes, e.g., IN.")
82 (defcustom dns-mode-font-lock-keywords
83 `(("^$ORIGIN" 0 ,dns-mode-control-entity-face
)
84 ("^$INCLUDE" 0 ,dns-mode-control-entity-face
)
85 ("^$[a-z0-9A-Z]+" 0 ,dns-mode-bad-control-entity-face
)
86 (,(regexp-opt dns-mode-classes
) 0 ,dns-mode-class-face
)
87 (,(regexp-opt dns-mode-types
) 0 ,dns-mode-type-face
))
88 "Font lock keywords used to highlight text in DNS master file mode."
94 (defvar dns-mode-syntax-table
95 (let ((table (make-syntax-table)))
96 (modify-syntax-entry ?\
; "< " table)
97 (modify-syntax-entry ?
\n "> " table
)
99 "Syntax table in use in DNS master file buffers.")
104 (let ((map (make-sparse-keymap)))
105 (define-key map
"\C-c\C-s" 'dns-mode-soa-increment-serial
)
107 "Keymap for DNS master file mode.")
111 (defvar dns-mode-menu nil
112 "Menubar used in DNS master file mode.")
114 (easy-menu-define dns-mode-menu dns-mode-map
117 ["Increment SOA serial" dns-mode-soa-increment-serial t
]))
122 (define-derived-mode dns-mode text-mode
"DNS"
123 "Major mode for viewing and editing DNS master files.
124 This mode is inherited from text mode. It add syntax
125 highlighting, and some commands for handling DNS master files.
126 Its keymap inherits from `text-mode' and it has the same
127 variables for customizing indentation. It has its own abbrev
128 table and its own syntax table.
130 Turning on DNS mode runs `dns-mode-hook'."
131 (set (make-local-variable 'comment-start
) ";")
132 (set (make-local-variable 'comment-end
) "")
133 (set (make-local-variable 'comment-start-skip
) ";+ *")
134 (unless (featurep 'xemacs
)
135 (set (make-local-variable 'font-lock-defaults
)
136 '(dns-mode-font-lock-keywords nil nil
((?_ .
"w")))))
137 (easy-menu-add dns-mode-menu dns-mode-map
))
142 (defun dns-mode-soa-increment-serial ()
143 "Locate SOA record and increment the serial field."
146 (goto-char (point-min))
147 (unless (re-search-forward
148 (concat "^\\(\\(\\([^ \t]+[ \t]+\\)?[^ \t]+"
149 "[ \t]+\\)?[^ \t]+[ \t]+\\)?SOA") nil t
)
150 (error "Cannot locate SOA record"))
151 (if (re-search-forward (concat "\\<\\("
153 "\\(198\\|199\\|20[0-9]\\)[0-9]"
155 "\\(0[0-9]\\|10\\|11\\|12\\)"
157 "\\([012][0-9]\\|30\\|31\\)"
159 "\\([0-9]\\{1,3\\}\\)"
162 ;; YYYYMMDDIII format, one to three I's.
163 (let* ((serial (match-string 1))
164 (counterstr (match-string 5))
165 (counter (string-to-number counterstr
))
166 (now (format-time-string "%Y%m%d"))
167 (nowandoldserial (concat now counterstr
)))
168 (if (string< serial nowandoldserial
)
169 (let ((new (format "%s00" now
)))
170 (replace-match new nil nil nil
1)
171 (message "Replaced old serial %s with %s" serial new
))
172 (if (string= serial nowandoldserial
)
173 (let ((new (format (format "%%s%%0%dd" (length counterstr
))
175 (replace-match new nil nil nil
1)
176 (message "Replaced old serial %s with %s" serial new
))
177 (error "Current SOA serial is in the future"))))
178 (if (re-search-forward "\\<\\([0-9]\\{9,10\\}\\)\\>" nil t
)
180 (let* ((serial (match-string 1))
181 (new (format-time-string "%s")))
182 (if (not (string< serial new
))
183 (error "Current SOA serial is in the future")
184 (replace-match new nil nil nil
1)
185 (message "Replaced old serial %s with %s" serial new
)))
186 (if (re-search-forward "\\<\\([0-9]+\\)\\>" nil t
)
187 ;; Just any serial number.
188 (let* ((serial (match-string 1))
189 (new (format "%d" (1+ (string-to-number serial
)))))
190 (replace-match new nil nil nil
1)
191 (message "Replaced old serial %s with %s" serial new
))
192 (error "Cannot locate serial number in SOA record"))))))
194 ;;;###autoload(add-to-list 'auto-mode-alist '("\\.soa\\'" . dns-mode))
198 ;; arch-tag: 6a179f0a-072f-49db-8b01-37b8f23998c0
199 ;;; dns-mode.el ends here