Add HCoop home directory extern function
[hcoop/domtool2.git] / src / domain.sig
CommitLineData
a3698041
AC
1(* HCoop Domtool (http://hcoop.sourceforge.net/)
2 * Copyright (c) 2006, Adam Chlipala
3 *
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.
8 *
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.
13 *
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.
dac62e84 17 *)
a3698041
AC
18
19(* Domain-related primitive actions *)
20
21signature DOMAIN = sig
22
629a34f6
AC
23 val isIdent : char -> bool
24 val validHost : string -> bool
25 val validDomain : string -> bool
26
97665758
AC
27 val ip : string Env.arg
28
a3698041
AC
29 val registerBefore : (string -> unit) -> unit
30 val registerAfter : (string -> unit) -> unit
31 (* Register handlers to run just before and after entering a domain
32 * block. *)
33
dac62e84
AC
34 val currentDomain : unit -> string
35
e0b0abd2
AC
36 val domainFile : {node : string, name : string} -> TextIO.outstream
37 (* Open one of the current domain's configuration files for a particular
38 * node. *)
dac62e84 39
e0b0abd2
AC
40 val dnsMaster : unit -> string option
41 (* Name of the node that is the DNS master for the current domain, if there
42 * is one *)
2ed6d0e5
AC
43
44 val nodes : string list
45 (* Names of all system nodes *)
46 val nodeMap : string Ast.StringMap.map
47 (* Map node names to IP addresses *)
8a7c40fa
AC
48 val nodeIp : string -> string
49 (* Look up a node in nodeMap *)
12adf55a
AC
50
51 val setUser : string -> unit
52 val getUser : unit -> string
53 (* Name of the UNIX user providing this configuration *)
54
55 val your_domains : unit -> DataStructures.StringSet.set
56 (* The domains the current user may configure *)
8a7c40fa
AC
57
58 val your_users : unit -> DataStructures.StringSet.set
59 val your_groups : unit -> DataStructures.StringSet.set
60 val your_paths : unit -> DataStructures.StringSet.set
61 (* UNIX users, groups, and paths the user may act with *)
36e42cb8
AC
62
63 val set_context : OpenSSL.context -> unit
a3698041 64end