X-Git-Url: https://git.hcoop.net/hcoop/domtool2.git/blobdiff_plain/b271ecb02a659115092aa73ebf2e15bf607c4bb8..06bd821502f57dcb4ef89295b221fc2b9a4f1ae3:/src/domain.sig diff --git a/src/domain.sig b/src/domain.sig index 6762fc6..a8de0de 100644 --- a/src/domain.sig +++ b/src/domain.sig @@ -24,9 +24,21 @@ signature DOMAIN = sig val isIdent : char -> bool val validHost : string -> bool val validDomain : string -> bool + val yourDomain : string -> bool + val validUser : string -> bool + val validEmailUser : string -> bool val ip : string Env.arg + val registerResetGlobal : (unit -> unit) -> unit + val registerResetLocal : (unit -> unit) -> unit + (* Register functions for clearing out all Domtool configuration at the global + * (AFS) and local levels, respectively. *) + + val resetGlobal : unit -> unit + val resetLocal : unit -> unit + (* Call all registered functions *) + val registerBefore : (string -> unit) -> unit val registerAfter : (string -> unit) -> unit (* Register handlers to run just before and after entering a domain @@ -38,6 +50,20 @@ signature DOMAIN = sig (* Open one of the current domain's configuration files for a particular * node. *) + val currentAliasDomains : unit -> string list + val currentDomains : unit -> string list + (* Return the auxiliary domains being configured (not including + * currentDomain) or the list of all domains being configured, + * respectively. *) + + (* The type of a set of files open for different domains. *) + type files = {write : string -> unit, (* Write a string to each. *) + writeDom : unit -> unit, (* Write each's domain name to it. *) + close : unit -> unit} (* Close all files. *) + + val domainsFile : {node : string, name : string} -> files + (* Open a configuration file for every domain being configured. *) + val dnsMaster : unit -> string option (* Name of the node that is the DNS master for the current domain, if there * is one *) @@ -62,4 +88,28 @@ signature DOMAIN = sig (* UNIX users, groups, and paths the user may act with *) val set_context : OpenSSL.context -> unit + + val hasPriv : string -> bool + + val rmdom : string list -> unit + val rmdom' : string -> string list -> unit + + val homedirOf : string -> string + val homedir : unit -> string + + type subject = {node : string, domain : string} + + val registerDescriber : (subject -> string) -> unit + (* When a user runs [domtool-admin describe $DOM], every function passed to + * [registerDescriber] will be run on [$DOM]. *) + val describe : string -> string + (* Argument is domain to describe, over all nodes. *) + + datatype description = + Filename of { filename : string, heading : string, showEmpty : bool } + | Extension of { extension : string, heading : string -> string } + + val considerAll : description list -> subject -> string + (* Find files in a domain directory matching some patterns and generate + * headings and contents listings for them. *) end