1 (* HCoop
Domtool (http
://hcoop
.sourceforge
.net
/)
2 * Copyright (c
) 2006, Adam Chlipala
4 * This program is free software
; you can redistribute it
and/or
5 * modify it under the terms
of the GNU General Public License
6 * as published by the Free Software Foundation
; either version
2
7 * of the License
, or (at your option
) any later version
.
9 * This program is distributed
in the hope that it will be useful
,
10 * but WITHOUT ANY WARRANTY
; without even the implied warranty
of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
. See the
12 * GNU General Public License for more details
.
14 * You should have received a copy
of the GNU General Public License
15 * along
with this program
; if not
, write to the Free Software
16 * Foundation
, Inc
., 51 Franklin Street
, Fifth Floor
, Boston
, MA
02110-1301, USA
.
19 (* Domain
-related primitive actions
*)
21 structure Domain
:> DOMAIN
= struct
25 structure SM
= DataStructures
.StringMap
26 structure SS
= DataStructures
.StringSet
28 val ssl_context
= ref (NONE
: OpenSSL
.context option
)
29 fun set_context ctx
= ssl_context
:= SOME ctx
31 val nodes
= map #
1 Config
.nodeIps
32 val nodeMap
= foldl (fn ((node
, ip
), mp
) => SM
.insert (mp
, node
, ip
))
33 SM
.empty Config
.nodeIps
34 fun nodeIp node
= valOf (SM
.find (nodeMap
, node
))
39 val your_doms
= ref SS
.empty
40 fun your_domains () = !your_doms
42 val your_usrs
= ref SS
.empty
43 fun your_users () = !your_usrs
45 val your_grps
= ref SS
.empty
46 fun your_groups () = !your_grps
48 val your_pths
= ref SS
.empty
49 fun your_paths () = !your_pths
53 your_doms
:= Acl
.class
{user
= getUser (),
55 your_usrs
:= Acl
.class
{user
= getUser (),
57 your_grps
:= Acl
.class
{user
= getUser (),
59 your_pths
:= Acl
.class
{user
= getUser (),
63 case map
Int.fromString (String.fields (fn ch
=> ch
= #
".") s
) of
64 [SOME n1
, SOME n2
, SOME n3
, SOME n4
] =>
65 n1
>= 0 andalso n1
< 256 andalso n2
>= 0 andalso n2
< 256 andalso n3
>= 0 andalso n3
< 256 andalso n4
>= 0 andalso n4
< 256
68 fun isIdent ch
= Char.isLower ch
orelse Char.isDigit ch
71 size s
> 0 andalso size s
< 20
72 andalso CharVector
.all (fn ch
=> isIdent ch
orelse ch
= #
"-") s
75 size s
> 0 andalso size s
< 100
76 andalso List.all
validHost (String.fields (fn ch
=> ch
= #
".") s
)
78 fun validNode s
= List.exists (fn s
' => s
= s
') nodes
80 fun yourDomain s
= SS
.member (your_domains (), s
)
81 fun yourUser s
= SS
.member (your_users (), s
)
82 fun yourGroup s
= SS
.member (your_groups (), s
)
84 List.all (fn s
=> s
<> "..") (String.fields (fn ch
=> ch
= #
"/") path
)
85 andalso CharVector
.all (fn ch
=> Char.isAlphaNum ch
orelse ch
= #
"." orelse ch
= #
"/"
86 orelse ch
= #
"-" orelse ch
= #
"_") path
87 andalso SS
.exists (fn s
' => path
= s
' orelse String.isPrefix (s
' ^
"/") path
) (your_paths ())
89 fun yourDomainHost s
=
92 val (pref
, suf
) = Substring
.splitl (fn ch
=> ch
<> #
".") (Substring
.full s
)
94 Substring
.size suf
> 0
95 andalso validHost (Substring
.string pref
)
96 andalso yourDomain (Substring
.string
97 (Substring
.slice (suf
, 1, NONE
)))
100 val yourDomain
= yourDomainHost
102 fun validUser s
= size s
> 0 andalso size s
< 20
103 andalso CharVector
.all
Char.isAlphaNum s
105 val validGroup
= validUser
107 val _
= Env
.type_one
"no_spaces"
109 (CharVector
.all (fn ch
=> not (Char.isSpace ch
)))
110 val _
= Env
.type_one
"no_newlines"
112 (CharVector
.all (fn ch
=> ch
<> #
"\n" andalso ch
<> #
"\r"))
114 val _
= Env
.type_one
"ip"
118 val _
= Env
.type_one
"host"
122 val _
= Env
.type_one
"domain"
126 val _
= Env
.type_one
"your_domain"
130 val _
= Env
.type_one
"your_domain_host"
134 val _
= Env
.type_one
"user"
138 val _
= Env
.type_one
"group"
142 val _
= Env
.type_one
"your_user"
146 val _
= Env
.type_one
"your_group"
150 val _
= Env
.type_one
"your_path"
154 val _
= Env
.type_one
"node"
158 val _
= Env
.registerFunction ("dns_node_to_node",
162 val _
= Env
.registerFunction ("mail_node_to_node",
167 val dl
= ErrorMsg
.dummyLoc
169 val nsD
= (EString Config
.defaultNs
, dl
)
170 val serialD
= (EVar
"serialAuto", dl
)
171 val refD
= (EInt Config
.defaultRefresh
, dl
)
172 val retD
= (EInt Config
.defaultRetry
, dl
)
173 val expD
= (EInt Config
.defaultExpiry
, dl
)
174 val minD
= (EInt Config
.defaultMinimum
, dl
)
176 val soaD
= multiApp ((EVar
"soa", dl
),
178 [nsD
, serialD
, refD
, retD
, expD
, minD
])
180 val masterD
= (EApp ((EVar
"internalMaster", dl
),
181 (EString Config
.masterNode
, dl
)),
184 val slavesD
= (EList (map (fn s
=> (EString s
, dl
)) Config
.slaveNodes
), dl
)
186 val _
= Defaults
.registerDefault ("Mailbox",
188 (fn () => (EString (getUser ()), dl
)))
190 val _
= Defaults
.registerDefault ("DNS",
191 (TBase
"dnsKind", dl
),
192 (fn () => multiApp ((EVar
"useDns", dl
),
194 [soaD
, masterD
, slavesD
])))
196 val _
= Defaults
.registerDefault ("TTL",
198 (fn () => (EInt Config
.Bind
.defaultTTL
, dl
)))
200 type soa
= {ns
: string,
207 val serial
= fn (EVar
"serialAuto", _
) => SOME NONE
208 |
(EApp ((EVar
"serialConst", _
), n
), _
) => Option
.map
SOME (Env
.int n
)
211 val soa
= fn (EApp ((EApp ((EApp ((EApp ((EApp ((EApp
212 ((EVar
"soa", _
), ns
), _
),
218 (case (Env
.string ns
, serial sl
, Env
.int rf
,
219 Env
.int ret
, Env
.int exp
, Env
.int min
) of
220 (SOME ns
, SOME sl
, SOME rf
,
221 SOME ret
, SOME exp
, SOME min
) =>
232 ExternalMaster
of string
233 | InternalMaster
of string
237 val _
= Env
.registerFunction ("ip_of_node",
238 fn [(EString node
, _
)] => SOME (EString (nodeIp node
), dl
)
241 val master
= fn (EApp ((EVar
"externalMaster", _
), e
), _
) => Option
.map
ExternalMaster (ip e
)
242 |
(EApp ((EVar
"internalMaster", _
), e
), _
) => Option
.map
InternalMaster (Env
.string e
)
246 UseDns
of {soa
: soa
,
248 slaves
: string list
}
251 val dnsKind
= fn (EApp ((EApp ((EApp
252 ((EVar
"useDns", _
), sa
), _
),
255 (case (soa sa
, master mstr
, Env
.list Env
.string slaves
) of
256 (SOME sa
, SOME mstr
, SOME slaves
) =>
257 SOME (UseDns
{soa
= sa
,
261 |
(EVar
"noDns", _
) => SOME NoDns
264 val befores
= ref (fn (_
: string) => ())
265 val afters
= ref (fn (_
: string) => ())
267 fun registerBefore f
=
271 befores
:= (fn x
=> (old x
; f x
))
274 fun registerAfter f
=
278 afters
:= (fn x
=> (old x
; f x
))
281 val globals
= ref (fn () => ())
282 val locals
= ref (fn () => ())
284 fun registerResetGlobal f
=
288 globals
:= (fn x
=> (old x
; f x
))
291 fun registerResetLocal f
=
295 locals
:= (fn x
=> (old x
; f x
))
298 fun resetGlobal () = (!globals ();
299 ignore (OS
.Process
.system (Config
.rm ^
" -rf " ^ Config
.resultRoot ^
"/*")))
300 fun resetLocal () = !locals ()
303 val currentPath
= ref (fn (_
: string) => "")
307 fun currentDomain () = !current
309 fun domainFile
{node
, name
} = ((*print ("Opening " ^
!currentPath node ^ name ^
"\n");*)
310 TextIO.openOut (!currentPath node ^ name
))
314 val toks
= String.fields (fn ch
=> ch
= #
".") domain
316 val elems
= foldr (fn (piece
, elems
) =>
318 val elems
= piece
:: elems
322 val path
= String.concatWith
"/"
323 (Config
.resultRoot
:: node
:: rev elems
)
324 val tmpPath
= String.concatWith
"/"
325 (Config
.tmpDir
:: node
:: rev elems
)
327 (if Posix
.FileSys
.ST
.isDir
328 (Posix
.FileSys
.stat path
) then
331 (OS
.FileSys
.remove path
;
332 OS
.FileSys
.mkDir path
))
333 handle OS
.SysErr _
=> OS
.FileSys
.mkDir path
;
335 (if Posix
.FileSys
.ST
.isDir
336 (Posix
.FileSys
.stat tmpPath
) then
339 (OS
.FileSys
.remove tmpPath
;
340 OS
.FileSys
.mkDir tmpPath
))
341 handle OS
.SysErr _
=> OS
.FileSys
.mkDir tmpPath
348 fn (root
, site
) => String.concatWith
"/" (root
:: site
:: rev ("" :: elems
))
351 datatype file_action
' =
352 Add
' of {src
: string, dst
: string}
354 | Modify
' of {src
: string, dst
: string}
356 fun findDiffs (site
, dom
, acts
) =
359 val realPath
= gp (Config
.resultRoot
, site
)
360 val tmpPath
= gp (Config
.tmpDir
, site
)
362 (*val _
= print ("getDiffs(" ^ site ^
", " ^ dom ^
")... " ^ realPath ^
"; " ^ tmpPath ^
"\n")*)
364 val dir
= Posix
.FileSys
.opendir realPath
367 case Posix
.FileSys
.readdir dir
of
368 NONE
=> (Posix
.FileSys
.closedir dir
;
372 val real = OS
.Path
.joinDirFile
{dir
= realPath
,
374 val tmp
= OS
.Path
.joinDirFile
{dir
= tmpPath
,
377 if Posix
.FileSys
.ST
.isDir (Posix
.FileSys
.stat
real) then
379 else if Posix
.FileSys
.access (tmp
, []) then
380 if Slave
.shell
[Config
.diff
, " ", real, " ", tmp
] then
383 loopReal ((site
, dom
, realPath
, Modify
' {src
= tmp
, dst
= real}) :: acts
)
385 loopReal ((site
, dom
, realPath
, Delete
' real) :: acts
)
388 val acts
= loopReal acts
390 val dir
= Posix
.FileSys
.opendir tmpPath
393 case Posix
.FileSys
.readdir dir
of
394 NONE
=> (Posix
.FileSys
.closedir dir
;
398 val real = OS
.Path
.joinDirFile
{dir
= realPath
,
400 val tmp
= OS
.Path
.joinDirFile
{dir
= tmpPath
,
403 if Posix
.FileSys
.ST
.isDir (Posix
.FileSys
.stat tmp
) then
405 else if Posix
.FileSys
.access (real, []) then
408 loopTmp ((site
, dom
, realPath
, Add
' {src
= tmp
, dst
= real}) :: acts
)
411 val acts
= loopTmp acts
416 fun findAllDiffs () =
418 val dir
= Posix
.FileSys
.opendir Config
.tmpDir
419 val len
= length (String.fields (fn ch
=> ch
= #
"/") Config
.tmpDir
) + 1
421 fun exploreSites diffs
=
422 case Posix
.FileSys
.readdir dir
of
426 fun explore (dname
, diffs
) =
428 val dir
= Posix
.FileSys
.opendir dname
431 case Posix
.FileSys
.readdir dir
of
435 val fname
= OS
.Path
.joinDirFile
{dir
= dname
,
438 loop (if Posix
.FileSys
.ST
.isDir (Posix
.FileSys
.stat fname
) then
440 val dom
= String.fields (fn ch
=> ch
= #
"/") fname
441 val dom
= List.drop (dom
, len
)
442 val dom
= String.concatWith
"." (rev dom
)
444 val dname
' = OS
.Path
.joinDirFile
{dir
= dname
,
448 findDiffs (site
, dom
, diffs
))
455 before Posix
.FileSys
.closedir dir
458 exploreSites (explore (OS
.Path
.joinDirFile
{dir
= Config
.tmpDir
,
459 file
= site
}, diffs
))
463 before Posix
.FileSys
.closedir dir
466 val masterNode
: string option ref
= ref NONE
467 fun dnsMaster () = !masterNode
469 val _
= Env
.containerV_one
"domain"
470 ("domain", Env
.string)
473 val kind
= Env
.env
dnsKind (evs
, "DNS")
474 val ttl
= Env
.env Env
.int (evs
, "TTL")
476 val path
= getPath dom
478 val () = (current
:= dom
;
479 currentPath
:= (fn site
=> path (Config
.tmpDir
, site
)))
481 fun saveSoa (kind
, soa
: soa
) node
=
483 val outf
= domainFile
{node
= node
, name
= "soa"}
485 TextIO.output (outf
, kind
);
486 TextIO.output (outf
, "\n");
487 TextIO.output (outf
, Int.toString ttl
);
488 TextIO.output (outf
, "\n");
489 TextIO.output (outf
, #ns soa
);
490 TextIO.output (outf
, "\n");
493 | SOME n
=> TextIO.output (outf
, Int.toString n
);
494 TextIO.output (outf
, "\n");
495 TextIO.output (outf
, Int.toString (#ref soa
));
496 TextIO.output (outf
, "\n");
497 TextIO.output (outf
, Int.toString (#ret soa
));
498 TextIO.output (outf
, "\n");
499 TextIO.output (outf
, Int.toString (#exp soa
));
500 TextIO.output (outf
, "\n");
501 TextIO.output (outf
, Int.toString (#min soa
));
502 TextIO.output (outf
, "\n");
506 fun saveNamed (kind
, soa
: soa
, masterIp
) node
=
508 val outf
= domainFile
{node
= node
, name
= "named.conf"}
510 TextIO.output (outf
, "\nzone \"");
511 TextIO.output (outf
, dom
);
512 TextIO.output (outf
, "\" IN {\n\ttype ");
513 TextIO.output (outf
, kind
);
514 TextIO.output (outf
, ";\n\tfile \"");
515 TextIO.output (outf
, Config
.Bind
.zonePath_real
);
516 TextIO.output (outf
, "/");
517 TextIO.output (outf
, dom
);
518 TextIO.output (outf
, ".zone\";\n");
520 "master" => TextIO.output (outf
, "\tallow-update { none; };\n")
521 | _
=> (TextIO.output (outf
, "\tmasters { ");
522 TextIO.output (outf
, masterIp
);
523 TextIO.output (outf
, "; };\n"));
524 TextIO.output (outf
, "};\n");
529 NoDns
=> masterNode
:= NONE
534 InternalMaster node
=> valOf (SM
.find (nodeMap
, node
))
535 | ExternalMaster ip
=> ip
537 app (saveSoa ("slave", #soa dns
)) (#slaves dns
);
538 app (saveNamed ("slave", #soa dns
, masterIp
)) (#slaves dns
);
540 InternalMaster node
=>
541 (masterNode
:= SOME node
;
542 saveSoa ("master", #soa dns
) node
;
543 saveNamed ("master", #soa dns
, masterIp
) node
)
544 | _
=> masterNode
:= NONE
;
548 fn () => !afters (!current
))
550 val () = Env
.registerPre (fn () => (ignore (Slave
.shellF ([Config
.rm
, " -rf ", Config
.tmpDir
, ""],
551 fn cl
=> "Temp file cleanup failed: " ^ cl
));
552 OS
.FileSys
.mkDir Config
.tmpDir
;
553 app (fn node
=> OS
.FileSys
.mkDir
554 (OS
.Path
.joinDirFile
{dir
= Config
.tmpDir
,
557 app (fn node
=> OS
.FileSys
.mkDir
558 (OS
.Path
.joinDirFile
{dir
= Config
.resultRoot
,
560 handle OS
.SysErr _
=> ())
563 fun handleSite (site
, files
) =
567 print ("New configuration for node " ^ site ^
"\n");
568 if site
= Config
.defaultNode
then
569 Slave
.handleChanges files
571 val bio
= OpenSSL
.connect (valOf (!ssl_context
),
574 ^
Int.toString Config
.slavePort
)
576 app (fn file
=> Msg
.send (bio
, MsgFile file
)) files
;
577 Msg
.send (bio
, MsgDoFiles
);
579 NONE
=> print
"Slave closed connection unexpectedly\n"
582 MsgOk
=> print ("Slave " ^ site ^
" finished\n")
583 | MsgError s
=> print ("Slave " ^ site
584 ^
" returned error: " ^
586 | _
=> print ("Slave " ^ site
587 ^
" returned unexpected command\n");
592 val () = Env
.registerPost (fn () =>
594 val diffs
= findAllDiffs ()
596 val diffs
= map (fn (site
, dom
, dir
, Add
' {src
, dst
}) =>
597 (Slave
.shellF ([Config
.cp
, " ", src
, " ", dst
],
598 fn cl
=> "Copy failed: " ^ cl
);
604 |
(site
, dom
, dir
, Delete
' dst
) =>
605 (OS
.FileSys
.remove dst
606 handle OS
.SysErr _
=>
607 ErrorMsg
.error
NONE ("Delete failed for " ^ dst
);
609 {action
= Slave
.Delete
,
613 |
(site
, dom
, dir
, Modify
' {src
, dst
}) =>
614 (Slave
.shellF ([Config
.cp
, " ", src
, " ", dst
],
615 fn cl
=> "Copy failed: " ^ cl
);
617 {action
= Slave
.Modify
,
622 if !ErrorMsg
.anyErrors
then
625 val changed
= foldl (fn ((site
, file
), changed
) =>
627 val ls
= case SM
.find (changed
, site
) of
631 SM
.insert (changed
, site
, file
:: ls
)
634 SM
.appi handleSite changed
636 ignore (Slave
.shellF ([Config
.rm
, " -rf ", Config
.tmpDir
, ""],
637 fn cl
=> "Temp file cleanup failed: " ^ cl
))
640 fun hasPriv priv
= Acl
.query
{user
= getUser (), class
= "priv", value
= "all"}
641 orelse Acl
.query
{user
= getUser (), class
= "priv", value
= priv
}
643 val _
= Env
.type_one
"dns_node"
646 List.exists (fn x
=> x
= node
) Config
.dnsNodes_all
647 orelse (hasPriv
"dns"
648 andalso List.exists (fn x
=> x
= node
) Config
.dnsNodes_admin
))
650 val _
= Env
.type_one
"mail_node"
653 List.exists (fn x
=> x
= node
) Config
.mailNodes_all
654 orelse (hasPriv
"mail"
655 andalso List.exists (fn x
=> x
= node
) Config
.mailNodes_admin
))
659 fun doNode (node
, _
) =
661 val dname
= OS
.Path
.joinDirFile
{dir
= Config
.resultRoot
,
664 fun doDom (dom
, actions
) =
666 val domPath
= String.concatWith
"/" (rev (String.fields (fn ch
=> ch
= #
".") dom
))
667 val dname
= OS
.Path
.concat (dname
, domPath
)
669 fun visitDom (dom
, dname
, actions
) =
671 val dir
= Posix
.FileSys
.opendir dname
674 case Posix
.FileSys
.readdir dir
of
678 val fnameFull
= OS
.Path
.joinDirFile
{dir
= dname
,
681 if Posix
.FileSys
.ST
.isDir (Posix
.FileSys
.stat fnameFull
) then
682 loop (visitDom (fname ^
"." ^ dom
,
686 loop ({action
= Slave
.Delete
,
689 file
= fnameFull
} :: actions
)
693 before Posix
.FileSys
.closedir dir
695 handle OS
.SysErr _
=>
696 (print ("Warning: System error deleteing domain " ^ dom ^
" on " ^ node ^
".\n");
699 visitDom (dom
, dname
, actions
)
702 val actions
= foldl doDom
[] doms
704 handleSite (node
, actions
)
706 handle IO
.Io _
=> print ("Warning: IO error deleting domains on " ^ node ^
".\n")
708 fun cleanupNode (node
, _
) =
712 val domPath
= String.concatWith
"/" (rev (String.fields (fn ch
=> ch
= #
".") dom
))
713 val dname
= OS
.Path
.joinDirFile
{dir
= Config
.resultRoot
,
715 val dname
= OS
.Path
.concat (dname
, domPath
)
717 ignore (OS
.Process
.system (Config
.rm ^
" -rf " ^ dname
))
723 app doNode Config
.nodeIps
;
724 app cleanupNode Config
.nodeIps