Commit | Line | Data |
---|---|---|
0904599e | 1 | ;;; dns-mode.el --- a mode for viewing/editing Domain Name System master files |
3731a850 | 2 | |
12dc447f GM |
3 | ;; Copyright (C) 2000, 2001, 2004, 2005, 2006, 2007, 2008 |
4 | ;; Free Software Foundation, Inc. | |
0904599e SJ |
5 | |
6 | ;; Author: Simon Josefsson <simon@josefsson.org> | |
7 | ;; Keywords: DNS master zone file SOA | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
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 | |
5a9dffec | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
0904599e SJ |
14 | ;; any later version. |
15 | ||
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. | |
20 | ||
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 | |
4fc5845f LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
0904599e SJ |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;; Use M-x dns-mode RET to invoke in master files. | |
29 | ;; | |
30 | ;; C-c C-s Increment SOA serial. | |
31 | ;; Understands YYYYMMDDNN, Unix time, and serial number formats, | |
32 | ;; and complains if it fail to find SOA serial. | |
33 | ;; | |
34 | ;; Put something similar to the following in your ~/.emacs to use this file: | |
35 | ;; | |
36 | ;; (load "~/path/to/dns-mode.el") | |
37 | ;; (setq auto-mode-alist (cons '("\\.soa\\'" . dns-mode) auto-mode-alist)) | |
38 | ||
39 | ;;; References: | |
40 | ||
41 | ;; RFC 1034, "DOMAIN NAMES - CONCEPTS AND FACILITIES", P. Mockapetris. | |
42 | ;; RFC 1035, "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION", P. Mockapetris. | |
43 | ||
44 | ;;; Release history: | |
45 | ||
46 | ;; 2004-09-11 Posted on gnu.emacs.sources. | |
47 | ;; 2004-09-13 Ported to XEmacs. | |
48 | ;; 2004-09-14 Installed in Emacs CVS. | |
49 | ||
50 | ;;; Code: | |
51 | ||
52 | (defgroup dns-mode nil | |
55d56d32 LK |
53 | "DNS master file mode configuration." |
54 | :group 'data) | |
0904599e SJ |
55 | |
56 | (defconst dns-mode-classes '("IN" "CS" "CH" "HS") | |
57 | "List of strings with known DNS classes.") | |
58 | ||
59 | (defconst dns-mode-types '("A" "NS" "MD" "MF" "CNAME" "SOA" "MB" "MG" "MR" | |
60 | "NULL" "WKS" "PTR" "HINFO" "MINFO" "MX" "TXT" | |
61 | "RP" "AFSDB" "X25" "ISDN" "RT" "NSAP" "NSAP" | |
62 | "SIG" "KEY" "PX" "GPOS" "AAAA" "LOC" "NXT" | |
63 | "EID" "NIMLOC" "SRV" "ATMA" "NAPTR" "KX" "CERT" | |
64 | "A6" "DNAME" "SINK" "OPT" "APL" "DS" "SSHFP" | |
65 | "RRSIG" "NSEC" "DNSKEY" "UINFO" "UID" "GID" | |
66 | "UNSPEC" "TKEY" "TSIG" "IXFR" "AXFR" "MAILB" | |
67 | "MAILA") | |
68 | "List of strings with known DNS types.") | |
69 | ||
70 | ;; Font lock. | |
71 | ||
72 | (defvar dns-mode-control-entity-face 'font-lock-keyword-face | |
73 | "Name of face used for control entities, e.g. $ORIGIN.") | |
74 | ||
75 | (defvar dns-mode-bad-control-entity-face 'font-lock-warning-face | |
76 | "Name of face used for non-standard control entities, e.g. $FOO.") | |
77 | ||
78 | (defvar dns-mode-type-face 'font-lock-type-face | |
79 | "Name of face used for DNS types, e.g., SOA.") | |
80 | ||
81 | (defvar dns-mode-class-face 'font-lock-constant-face | |
82 | "Name of face used for DNS classes, e.g., IN.") | |
83 | ||
84 | (defcustom dns-mode-font-lock-keywords | |
85 | `(("^$ORIGIN" 0 ,dns-mode-control-entity-face) | |
86 | ("^$INCLUDE" 0 ,dns-mode-control-entity-face) | |
87 | ("^$[a-z0-9A-Z]+" 0 ,dns-mode-bad-control-entity-face) | |
88 | (,(regexp-opt dns-mode-classes) 0 ,dns-mode-class-face) | |
89 | (,(regexp-opt dns-mode-types) 0 ,dns-mode-type-face)) | |
90 | "Font lock keywords used to highlight text in DNS master file mode." | |
91 | :type 'sexp | |
92 | :group 'dns-mode) | |
93 | ||
c40408fb RF |
94 | (defcustom dns-mode-soa-auto-increment-serial t |
95 | "Whether to increment the SOA serial number automatically. | |
96 | ||
97 | If this variable is t, the serial number is incremented upon each save of | |
98 | the file. If it is `ask', Emacs asks for confirmation whether it should | |
99 | increment the serial upon saving. If nil, serials must be incremented | |
100 | manually with \\[dns-mode-soa-increment-serial]." | |
101 | :type '(choice (const :tag "Always" t) | |
102 | (const :tag "Ask" ask) | |
103 | (const :tag "Never" nil)) | |
104 | :group 'dns-mode) | |
105 | ||
0904599e SJ |
106 | ;; Syntax table. |
107 | ||
108 | (defvar dns-mode-syntax-table | |
109 | (let ((table (make-syntax-table))) | |
110 | (modify-syntax-entry ?\; "< " table) | |
111 | (modify-syntax-entry ?\n "> " table) | |
112 | table) | |
113 | "Syntax table in use in DNS master file buffers.") | |
114 | ||
115 | ;; Keymap. | |
116 | ||
117 | (defvar dns-mode-map | |
118 | (let ((map (make-sparse-keymap))) | |
119 | (define-key map "\C-c\C-s" 'dns-mode-soa-increment-serial) | |
120 | map) | |
121 | "Keymap for DNS master file mode.") | |
122 | ||
123 | ;; Menu. | |
124 | ||
125 | (defvar dns-mode-menu nil | |
126 | "Menubar used in DNS master file mode.") | |
127 | ||
128 | (easy-menu-define dns-mode-menu dns-mode-map | |
129 | "DNS Menu." | |
130 | '("DNS" | |
131 | ["Increment SOA serial" dns-mode-soa-increment-serial t])) | |
132 | ||
133 | ;; Mode. | |
134 | ||
135 | ;;;###autoload | |
136 | (define-derived-mode dns-mode text-mode "DNS" | |
137 | "Major mode for viewing and editing DNS master files. | |
138 | This mode is inherited from text mode. It add syntax | |
139 | highlighting, and some commands for handling DNS master files. | |
140 | Its keymap inherits from `text-mode' and it has the same | |
141 | variables for customizing indentation. It has its own abbrev | |
142 | table and its own syntax table. | |
143 | ||
144 | Turning on DNS mode runs `dns-mode-hook'." | |
145 | (set (make-local-variable 'comment-start) ";") | |
146 | (set (make-local-variable 'comment-end) "") | |
147 | (set (make-local-variable 'comment-start-skip) ";+ *") | |
148 | (unless (featurep 'xemacs) | |
149 | (set (make-local-variable 'font-lock-defaults) | |
150 | '(dns-mode-font-lock-keywords nil nil ((?_ . "w"))))) | |
aa7adb2a | 151 | (add-hook 'before-save-hook 'dns-mode-soa-maybe-increment-serial |
c40408fb | 152 | nil t) |
0904599e SJ |
153 | (easy-menu-add dns-mode-menu dns-mode-map)) |
154 | ||
c40408fb RF |
155 | ;;;###autoload (defalias 'zone-mode 'dns-mode) |
156 | ||
0904599e SJ |
157 | ;; Tools. |
158 | ||
159 | ;;;###autoload | |
160 | (defun dns-mode-soa-increment-serial () | |
161 | "Locate SOA record and increment the serial field." | |
162 | (interactive) | |
163 | (save-excursion | |
164 | (goto-char (point-min)) | |
165 | (unless (re-search-forward | |
166 | (concat "^\\(\\(\\([^ \t]+[ \t]+\\)?[^ \t]+" | |
167 | "[ \t]+\\)?[^ \t]+[ \t]+\\)?SOA") nil t) | |
168 | (error "Cannot locate SOA record")) | |
169 | (if (re-search-forward (concat "\\<\\(" | |
170 | ;; year | |
171 | "\\(198\\|199\\|20[0-9]\\)[0-9]" | |
172 | ;; month | |
173 | "\\(0[0-9]\\|10\\|11\\|12\\)" | |
174 | ;; day | |
175 | "\\([012][0-9]\\|30\\|31\\)" | |
176 | ;; counter | |
177 | "\\([0-9]\\{1,3\\}\\)" | |
178 | "\\)\\>") | |
179 | nil t) | |
180 | ;; YYYYMMDDIII format, one to three I's. | |
181 | (let* ((serial (match-string 1)) | |
182 | (counterstr (match-string 5)) | |
183 | (counter (string-to-number counterstr)) | |
184 | (now (format-time-string "%Y%m%d")) | |
185 | (nowandoldserial (concat now counterstr))) | |
186 | (if (string< serial nowandoldserial) | |
187 | (let ((new (format "%s00" now))) | |
188 | (replace-match new nil nil nil 1) | |
189 | (message "Replaced old serial %s with %s" serial new)) | |
190 | (if (string= serial nowandoldserial) | |
191 | (let ((new (format (format "%%s%%0%dd" (length counterstr)) | |
192 | now (1+ counter)))) | |
193 | (replace-match new nil nil nil 1) | |
194 | (message "Replaced old serial %s with %s" serial new)) | |
195 | (error "Current SOA serial is in the future")))) | |
196 | (if (re-search-forward "\\<\\([0-9]\\{9,10\\}\\)\\>" nil t) | |
197 | ;; Unix time | |
198 | (let* ((serial (match-string 1)) | |
199 | (new (format-time-string "%s"))) | |
200 | (if (not (string< serial new)) | |
201 | (error "Current SOA serial is in the future") | |
202 | (replace-match new nil nil nil 1) | |
203 | (message "Replaced old serial %s with %s" serial new))) | |
204 | (if (re-search-forward "\\<\\([0-9]+\\)\\>" nil t) | |
205 | ;; Just any serial number. | |
206 | (let* ((serial (match-string 1)) | |
207 | (new (format "%d" (1+ (string-to-number serial))))) | |
208 | (replace-match new nil nil nil 1) | |
209 | (message "Replaced old serial %s with %s" serial new)) | |
210 | (error "Cannot locate serial number in SOA record")))))) | |
211 | ||
c40408fb RF |
212 | (defun dns-mode-soa-maybe-increment-serial () |
213 | "Increment SOA serial if needed. | |
214 | ||
aa7adb2a | 215 | This function is run from `before-save-hook'." |
c40408fb RF |
216 | (when (and (buffer-modified-p) |
217 | dns-mode-soa-auto-increment-serial | |
218 | (or (eq dns-mode-soa-auto-increment-serial t) | |
219 | (y-or-n-p "Increment SOA serial? "))) | |
08eedb79 RF |
220 | ;; If `dns-mode-soa-increment-serial' signals an error saving will |
221 | ;; fail but that probably means that the serial should be fixed to | |
222 | ;; comply with the RFC anyway! -rfr | |
aa7adb2a | 223 | (progn (dns-mode-soa-increment-serial) |
08eedb79 RF |
224 | ;; We return nil in case this is used in write-contents-functions. |
225 | nil))) | |
c40408fb | 226 | |
0904599e SJ |
227 | ;;;###autoload(add-to-list 'auto-mode-alist '("\\.soa\\'" . dns-mode)) |
228 | ||
229 | (provide 'dns-mode) | |
230 | ||
231 | ;; arch-tag: 6a179f0a-072f-49db-8b01-37b8f23998c0 | |
232 | ;;; dns-mode.el ends here |