a8de0de4c165168489f583c3b85c56798d948f3a
[hcoop/domtool2.git] / src / domain.sig
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.
17 *)
18
19 (* Domain-related primitive actions *)
20
21 signature DOMAIN = sig
22
23 val yourPath : string -> bool
24 val isIdent : char -> bool
25 val validHost : string -> bool
26 val validDomain : string -> bool
27 val yourDomain : string -> bool
28 val validUser : string -> bool
29 val validEmailUser : string -> bool
30
31 val ip : string Env.arg
32
33 val registerResetGlobal : (unit -> unit) -> unit
34 val registerResetLocal : (unit -> unit) -> unit
35 (* Register functions for clearing out all Domtool configuration at the global
36 * (AFS) and local levels, respectively. *)
37
38 val resetGlobal : unit -> unit
39 val resetLocal : unit -> unit
40 (* Call all registered functions *)
41
42 val registerBefore : (string -> unit) -> unit
43 val registerAfter : (string -> unit) -> unit
44 (* Register handlers to run just before and after entering a domain
45 * block. *)
46
47 val currentDomain : unit -> string
48
49 val domainFile : {node : string, name : string} -> TextIO.outstream
50 (* Open one of the current domain's configuration files for a particular
51 * node. *)
52
53 val currentAliasDomains : unit -> string list
54 val currentDomains : unit -> string list
55 (* Return the auxiliary domains being configured (not including
56 * currentDomain) or the list of all domains being configured,
57 * respectively. *)
58
59 (* The type of a set of files open for different domains. *)
60 type files = {write : string -> unit, (* Write a string to each. *)
61 writeDom : unit -> unit, (* Write each's domain name to it. *)
62 close : unit -> unit} (* Close all files. *)
63
64 val domainsFile : {node : string, name : string} -> files
65 (* Open a configuration file for every domain being configured. *)
66
67 val dnsMaster : unit -> string option
68 (* Name of the node that is the DNS master for the current domain, if there
69 * is one *)
70
71 val nodes : string list
72 (* Names of all system nodes *)
73 val nodeMap : string Ast.StringMap.map
74 (* Map node names to IP addresses *)
75 val nodeIp : string -> string
76 (* Look up a node in nodeMap *)
77
78 val setUser : string -> unit
79 val getUser : unit -> string
80 (* Name of the UNIX user providing this configuration *)
81
82 val your_domains : unit -> DataStructures.StringSet.set
83 (* The domains the current user may configure *)
84
85 val your_users : unit -> DataStructures.StringSet.set
86 val your_groups : unit -> DataStructures.StringSet.set
87 val your_paths : unit -> DataStructures.StringSet.set
88 (* UNIX users, groups, and paths the user may act with *)
89
90 val set_context : OpenSSL.context -> unit
91
92 val hasPriv : string -> bool
93
94 val rmdom : string list -> unit
95 val rmdom' : string -> string list -> unit
96
97 val homedirOf : string -> string
98 val homedir : unit -> string
99
100 type subject = {node : string, domain : string}
101
102 val registerDescriber : (subject -> string) -> unit
103 (* When a user runs [domtool-admin describe $DOM], every function passed to
104 * [registerDescriber] will be run on [$DOM]. *)
105 val describe : string -> string
106 (* Argument is domain to describe, over all nodes. *)
107
108 datatype description =
109 Filename of { filename : string, heading : string, showEmpty : bool }
110 | Extension of { extension : string, heading : string -> string }
111
112 val considerAll : description list -> subject -> string
113 (* Find files in a domain directory matching some patterns and generate
114 * headings and contents listings for them. *)
115 end