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 (* Apache HTTPD handling
*)
21 structure Apache
:> APACHE
= struct
25 val _
= Env
.type_one
"web_node"
28 List.exists (fn (x
, _
) => x
= node
) Config
.Apache
.webNodes_all
29 orelse (Domain
.hasPriv
"www"
30 andalso List.exists (fn (x
, _
) => x
= node
) Config
.Apache
.webNodes_admin
))
32 val _
= Env
.registerFunction ("web_node_to_node",
36 val _
= Env
.type_one
"proxy_port"
40 val _
= Env
.type_one
"proxy_target"
44 fun default () = List.exists (fn s
' => s
= s
') Config
.Apache
.proxyTargets
46 case String.fields (fn ch
=> ch
= #
":") s
of
47 ["http", "//localhost", rest
] =>
48 (case String.fields (fn ch
=> ch
= #
"/") rest
of
50 (case Int.fromString port
of
52 | SOME n
=> n
> 1024 orelse default ())
57 val _
= Env
.type_one
"rewrite_arg"
59 (CharVector
.all
Char.isAlphaNum
)
61 val _
= Env
.type_one
"suexec_flag"
63 (fn b
=> b
orelse Domain
.hasPriv
"www")
66 size s
> 0 andalso size s
< 1000 andalso CharVector
.all
67 (fn ch
=> Char.isAlphaNum ch
73 val _
= Env
.type_one
"location"
77 fun validCert s
= Acl
.query
{user
= Domain
.getUser (),
81 val _
= Env
.type_one
"ssl_cert_path"
86 (EVar
"no_ssl", _
) => SOME NONE
87 |
(EApp ((EVar
"use_cert", _
), s
), _
) => Option
.map
SOME (Env
.string s
)
90 val dl
= ErrorMsg
.dummyLoc
92 val _
= Defaults
.registerDefault ("WebNodes",
93 (TList (TBase
"web_node", dl
), dl
),
94 (fn () => (EList (map (fn s
=> (EString s
, dl
)) Config
.Apache
.webNodes_default
), dl
)))
96 val _
= Defaults
.registerDefault ("SSL",
98 (fn () => (EVar
"no_ssl", dl
)))
100 val _
= Defaults
.registerDefault ("User",
101 (TBase
"your_user", dl
),
102 (fn () => (EString (Domain
.getUser ()), dl
)))
104 val _
= Defaults
.registerDefault ("Group",
105 (TBase
"your_group", dl
),
106 (fn () => (EString (Domain
.getUser ()), dl
)))
108 val _
= Defaults
.registerDefault ("DocumentRoot",
109 (TBase
"your_path", dl
),
110 (fn () => (EString (Domain
.homedir () ^
"/" ^ Config
.Apache
.public_html
), dl
)))
112 val _
= Defaults
.registerDefault ("ServerAdmin",
114 (fn () => (EString (Domain
.getUser () ^
"@" ^ Config
.defaultDomain
), dl
)))
116 val _
= Defaults
.registerDefault ("SuExec",
117 (TBase
"suexec_flag", dl
),
118 (fn () => (EVar
"true", dl
)))
120 val redirect_code
= fn (EVar
"temp", _
) => SOME
"temp"
121 |
(EVar
"permanent", _
) => SOME
"permanent"
122 |
(EVar
"seeother", _
) => SOME
"seeother"
123 |
(EVar
"redir300", _
) => SOME
"300"
124 |
(EVar
"redir301", _
) => SOME
"301"
125 |
(EVar
"redir302", _
) => SOME
"302"
126 |
(EVar
"redir303", _
) => SOME
"303"
127 |
(EVar
"redir304", _
) => SOME
"304"
128 |
(EVar
"redir305", _
) => SOME
"305"
129 |
(EVar
"redir307", _
) => SOME
"307"
132 val flag
= fn (EVar
"redirect", _
) => SOME
"R"
133 |
(EVar
"forbidden", _
) => SOME
"F"
134 |
(EVar
"gone", _
) => SOME
"G"
135 |
(EVar
"last", _
) => SOME
"L"
136 |
(EVar
"chain", _
) => SOME
"C"
137 |
(EVar
"nosubreq", _
) => SOME
"NS"
138 |
(EVar
"nocase", _
) => SOME
"NC"
139 |
(EVar
"qsappend", _
) => SOME
"QSA"
140 |
(EVar
"noescape", _
) => SOME
"NE"
141 |
(EVar
"passthrough", _
) => SOME
"PT"
142 |
(EApp ((EVar
"mimeType", _
), e
), _
) =>
143 Option
.map (fn s
=> "T=" ^ s
) (Env
.string e
)
144 |
(EApp ((EVar
"redirectWith", _
), e
), _
) =>
145 Option
.map (fn s
=> "R=" ^ s
) (redirect_code e
)
146 |
(EApp ((EVar
"skip", _
), e
), _
) =>
147 Option
.map (fn n
=> "S=" ^
Int.toString n
) (Env
.int e
)
148 |
(EApp ((EApp ((EVar
"env", _
), e1
), _
), e2
), _
) =>
149 (case Env
.string e1
of
151 | SOME s1
=> Option
.map (fn s2
=> "E=" ^ s1 ^
":" ^ s2
)
156 val cond_flag
= fn (EVar
"cond_nocase", _
) => SOME
"NC"
157 |
(EVar
"ornext", _
) => SOME
"OR"
160 val apache_option
= fn (EVar
"execCGI", _
) => SOME
"ExecCGI"
161 |
(EVar
"includesNOEXEC", _
) => SOME
"IncludesNOEXEC"
162 |
(EVar
"indexes", _
) => SOME
"Indexes"
165 val autoindex_width
= fn (EVar
"autofit", _
) => SOME
"*"
166 |
(EApp ((EVar
"characters", _
), n
), _
) =>
167 Option
.map
Int.toString (Env
.int n
)
170 val autoindex_option
= fn (EApp ((EVar
"descriptionWidth", _
), w
), _
) =>
171 Option
.map (fn w
=> ("DescriptionWidth", SOME w
))
173 |
(EVar
"fancyIndexing", _
) => SOME ("FancyIndexing", NONE
)
174 |
(EVar
"foldersFirst", _
) => SOME ("FoldersFirst", NONE
)
175 |
(EVar
"htmlTable", _
) => SOME ("HTMLTable", NONE
)
176 |
(EVar
"iconsAreLinks", _
) => SOME ("IconsAreLinks", NONE
)
177 |
(EApp ((EVar
"iconHeight", _
), n
), _
) =>
178 Option
.map (fn w
=> ("IconHeight", SOME (Int.toString w
)))
180 |
(EApp ((EVar
"iconWidth", _
), n
), _
) =>
181 Option
.map (fn w
=> ("IconWidth", SOME (Int.toString w
)))
183 |
(EVar
"ignoreCase", _
) => SOME ("IgnoreCase", NONE
)
184 |
(EVar
"ignoreClient", _
) => SOME ("IgnoreClient", NONE
)
185 |
(EApp ((EVar
"nameWidth", _
), w
), _
) =>
186 Option
.map (fn w
=> ("NameWidth", SOME w
))
188 |
(EVar
"scanHtmlTitles", _
) => SOME ("ScanHTMLTitles", NONE
)
189 |
(EVar
"suppressColumnSorting", _
) => SOME ("SuppressColumnSorting", NONE
)
190 |
(EVar
"suppressDescription", _
) => SOME ("SuppressDescription", NONE
)
191 |
(EVar
"suppressHtmlPreamble", _
) => SOME ("SuppressHTMLPreamble", NONE
)
192 |
(EVar
"suppressIcon", _
) => SOME ("SuppressIcon", NONE
)
193 |
(EVar
"suppressLastModified", _
) => SOME ("SuppressLastModified", NONE
)
194 |
(EVar
"suppressRules", _
) => SOME ("SuppressRules", NONE
)
195 |
(EVar
"suppressSize", _
) => SOME ("SuppressSize", NONE
)
196 |
(EVar
"trackModified", _
) => SOME ("TrackModified", NONE
)
197 |
(EVar
"versionSort", _
) => SOME ("VersionSort", NONE
)
198 |
(EVar
"xhtml", _
) => SOME ("XHTML", NONE
)
202 val vhostsChanged
= ref
false
203 val logDeleted
= ref
false
205 val () = Slave
.registerPreHandler
206 (fn () => (vhostsChanged
:= false;
207 logDeleted
:= false))
209 fun findVhostUser fname
=
211 val inf
= TextIO.openIn fname
214 case TextIO.inputLine inf
of
217 if String.isPrefix
"# Owner: " line
then
218 case String.tokens
Char.isSpace line
of
219 [_
, _
, user
] => SOME user
225 before TextIO.closeIn inf
228 val webNodes_full
= Config
.Apache
.webNodes_all @ Config
.Apache
.webNodes_admin
230 fun isVersion1 node
=
231 List.exists (fn (n
, {version
= ConfigTypes
.APACHE_1_3
, ...}) => n
= node
232 | _
=> false) webNodes_full
234 fun imVersion1 () = isVersion1 (Slave
.hostname ())
237 List.exists (fn (n
, {auth
= ConfigTypes
.MOD_WAKLOG
, ...}) => n
= node
238 | _
=> false) webNodes_full
240 fun down () = if imVersion1 () then Config
.Apache
.down1
else Config
.Apache
.down
241 fun undown () = if imVersion1 () then Config
.Apache
.undown1
else Config
.Apache
.undown
242 fun reload () = if imVersion1 () then Config
.Apache
.reload1
else Config
.Apache
.reload
244 fun logDir
{user
, node
, vhostId
} =
245 String.concat
[Config
.Apache
.logDirOf user
,
251 val () = Slave
.registerFileHandler (fn fs
=>
253 val spl
= OS
.Path
.splitDirFile (#file fs
)
255 if String.isSuffix
".vhost" (#file spl
)
256 orelse String.isSuffix
".vhost_ssl" (#file spl
) then let
257 val realVhostFile
= OS
.Path
.joinDirFile
258 {dir
= Config
.Apache
.confDir
,
261 val user
= findVhostUser (#file fs
)
262 val oldUser
= findVhostUser realVhostFile
264 if (oldUser
= NONE
andalso #action fs
<> Slave
.Add
)
265 orelse (user
= NONE
andalso #action fs
<> Slave
.Delete
) then
266 print ("Can't find user in " ^ #file fs ^
" or " ^ realVhostFile ^
"! Taking no action.\n")
269 val vhostId
= if OS
.Path
.ext (#file spl
) = SOME
".vhost_ssl" then
270 OS
.Path
.base (#file spl
) ^
".ssl"
272 OS
.Path
.base (#file spl
)
274 fun realLogDir user
=
275 logDir
{user
= valOf user
,
276 node
= Slave
.hostname (),
279 vhostsChanged
:= true;
285 (ignore (OS
.Process
.system (down ()));
287 ignore (OS
.Process
.system (Config
.rm
290 ignore (OS
.Process
.system (Config
.rm
292 ^ realLogDir oldUser
)))
295 val rld
= realLogDir user
297 ignore (OS
.Process
.system (Config
.cp
302 if Posix
.FileSys
.access (rld
, []) then
309 (ignore (OS
.Process
.system (Config
.cp
314 if user
<> oldUser
then
316 val old
= realLogDir oldUser
317 val rld
= realLogDir user
322 (ignore (OS
.Process
.system (down ()));
324 ignore (OS
.Process
.system (Config
.rm
326 ^ realLogDir oldUser
));
327 if Posix
.FileSys
.access (rld
, []) then
340 val () = Slave
.registerPostHandler
342 (if !vhostsChanged
then
343 Slave
.shellF ([if !logDeleted
then undown () else reload ()],
344 fn cl
=> "Error reloading Apache with " ^ cl
)
348 val vhostFiles
: (string * TextIO.outstream
) list ref
= ref
[]
349 fun write
' s
= app (fn (node
, file
) => TextIO.output (file
, s node
)) (!vhostFiles
)
350 fun write s
= app (fn (_
, file
) => TextIO.output (file
, s
)) (!vhostFiles
)
352 val rewriteEnabled
= ref
false
353 val localRewriteEnabled
= ref
false
354 val currentVhost
= ref
""
355 val currentVhostId
= ref
""
357 val pre
= ref (fn _
: {user
: string, nodes
: string list
, id
: string, hostname
: string} => ())
362 pre
:= (fn x
=> (old x
; f x
))
365 val post
= ref (fn () => ())
370 post
:= (fn () => (old (); f ()))
373 val aliaser
= ref (fn _
: string => ())
374 fun registerAliaser f
=
378 aliaser
:= (fn x
=> (old x
; f x
))
381 val () = Env
.containerV_one
"vhost"
385 val nodes
= Env
.env (Env
.list Env
.string) (env
, "WebNodes")
387 val ssl
= Env
.env
ssl (env
, "SSL")
388 val user
= Env
.env Env
.string (env
, "User")
389 val group
= Env
.env Env
.string (env
, "Group")
390 val docroot
= Env
.env Env
.string (env
, "DocumentRoot")
391 val sadmin
= Env
.env Env
.string (env
, "ServerAdmin")
392 val suexec
= Env
.env Env
.bool (env
, "SuExec")
394 val fullHost
= host ^
"." ^ Domain
.currentDomain ()
395 val vhostId
= fullHost ^
(if Option
.isSome ssl
then ".ssl" else "")
396 val confFile
= fullHost ^
(if Option
.isSome ssl
then ".vhost_ssl" else ".vhost")
398 currentVhost
:= fullHost
;
399 currentVhostId
:= vhostId
;
401 rewriteEnabled
:= false;
402 localRewriteEnabled
:= false;
403 vhostFiles
:= map (fn node
=>
405 val file
= Domain
.domainFile
{node
= node
,
408 TextIO.output (file
, "# Owner: ");
409 TextIO.output (file
, user
);
410 TextIO.output (file
, "\n<VirtualHost ");
411 TextIO.output (file
, Domain
.nodeIp node
);
412 TextIO.output (file
, ":");
413 TextIO.output (file
, case ssl
of
416 TextIO.output (file
, ">\n");
417 TextIO.output (file
, "\tErrorLog ");
418 TextIO.output (file
, logDir
{user
= user
, node
= node
, vhostId
= vhostId
});
419 TextIO.output (file
, "/error.log\n\tCustomLog ");
420 TextIO.output (file
, logDir
{user
= user
, node
= node
, vhostId
= vhostId
});
421 TextIO.output (file
, "/access.log combined\n");
422 TextIO.output (file
, "\tServerName ");
423 TextIO.output (file
, fullHost
);
425 if isVersion1 node
then
426 (TextIO.output (file
, "\n\tUser ");
427 TextIO.output (file
, user
);
428 TextIO.output (file
, "\n\tGroup ");
429 TextIO.output (file
, group
))
431 (TextIO.output (file
, "\n\tSuexecUserGroup ");
432 TextIO.output (file
, user
);
433 TextIO.output (file
, " ");
434 TextIO.output (file
, group
))
437 if isWaklog node
then
438 (TextIO.output (file
, "\n\tWaklogProtected on\n\tWaklogPrincipal ");
439 TextIO.output (file
, user
);
440 TextIO.output (file
, "/cgi@HCOOP.NET /etc/keytabs/cgi/");
441 TextIO.output (file
, user
))
444 (logDir
{user
= user
, node
= node
, vhostId
= vhostId
}, file
)
447 write
"\n\tDocumentRoot ";
449 write
"\n\tServerAdmin ";
453 (write
"\n\tSSLEngine on\n\tSSLCertificateFile ";
457 !pre
{user
= user
, nodes
= nodes
, id
= vhostId
, hostname
= fullHost
}
460 write
"</VirtualHost>\n";
461 app (TextIO.closeOut
o #
2) (!vhostFiles
)))
463 val inLocal
= ref
false
465 val () = Env
.container_one
"location"
466 ("prefix", Env
.string)
468 (write
"\t<Location ";
472 fn () => (write
"\t</Location>\n";
474 localRewriteEnabled
:= false))
476 val () = Env
.container_one
"directory"
477 ("directory", Env
.string)
479 (write
"\t<Directory ";
483 fn () => (write
"\t</Directory>\n";
485 localRewriteEnabled
:= false))
487 fun checkRewrite () =
489 if !rewriteEnabled
orelse !localRewriteEnabled
then
492 (write
"\tRewriteEngine on\n";
493 localRewriteEnabled
:= true)
494 else if !rewriteEnabled
then
497 (write
"\tRewriteEngine on\n";
498 rewriteEnabled
:= true)
500 val () = Env
.action_three
"localProxyRewrite"
501 ("from", Env
.string, "to", Env
.string, "port", Env
.int)
502 (fn (from
, to
, port
) =>
504 write
"\tRewriteRule\t";
506 write
"\thttp://localhost:";
507 write (Int.toString port
);
512 val () = Env
.action_two
"proxyPass"
513 ("from", Env
.string, "to", Env
.string)
515 (write
"\tProxyPass\t";
521 val () = Env
.action_two
"proxyPassReverse"
522 ("from", Env
.string, "to", Env
.string)
524 (write
"\tProxyPassReverse\t";
530 val () = Env
.action_three
"rewriteRule"
531 ("from", Env
.string, "to", Env
.string, "flags", Env
.list flag
)
532 (fn (from
, to
, flags
) =>
534 write
"\tRewriteRule\t";
540 | flag
::rest
=> (write
" [";
542 app (fn flag
=> (write
",";
547 val () = Env
.action_three
"rewriteCond"
548 ("test", Env
.string, "pattern", Env
.string, "flags", Env
.list cond_flag
)
549 (fn (from
, to
, flags
) =>
551 write
"\tRewriteCond\t";
557 | flag
::rest
=> (write
" [";
559 app (fn flag
=> (write
",";
564 val () = Env
.action_one
"rewriteLogLevel"
568 write
"\tRewriteLog ";
570 write
"/rewrite.log\n\tRewriteLogLevel ";
571 write (Int.toString level
);
574 val () = Env
.action_two
"alias"
575 ("from", Env
.string, "to", Env
.string)
583 val () = Env
.action_two
"scriptAlias"
584 ("from", Env
.string, "to", Env
.string)
586 (write
"\tScriptAlias\t";
592 val () = Env
.action_two
"errorDocument"
593 ("code", Env
.string, "handler", Env
.string)
594 (fn (code
, handler
) =>
595 (write
"\tErrorDocument\t";
601 val () = Env
.action_one
"options"
602 ("options", Env
.list apache_option
)
606 | _
=> (write
"\tOptions";
607 app (fn opt
=> (write
" "; write opt
)) opts
;
610 val () = Env
.action_one
"set_options"
611 ("options", Env
.list apache_option
)
615 | _
=> (write
"\tOptions";
616 app (fn opt
=> (write
" +"; write opt
)) opts
;
619 val () = Env
.action_one
"unset_options"
620 ("options", Env
.list apache_option
)
624 | _
=> (write
"\tOptions";
625 app (fn opt
=> (write
" -"; write opt
)) opts
;
628 val () = Env
.action_one
"directoryIndex"
629 ("filenames", Env
.list Env
.string)
631 (write
"\tDirectoryIndex";
632 app (fn opt
=> (write
" "; write opt
)) opts
;
635 val () = Env
.action_one
"serverAlias"
638 (write
"\tServerAlias ";
643 val authType
= fn (EVar
"basic", _
) => SOME
"basic"
644 |
(EVar
"digest", _
) => SOME
"digest"
647 val () = Env
.action_one
"authType"
650 (write
"\tAuthType ";
654 val () = Env
.action_one
"authName"
657 (write
"\tAuthName \"";
661 val () = Env
.action_one
"authUserFile"
664 (write
"\tAuthUserFile ";
668 val () = Env
.action_none
"requireValidUser"
669 (fn () => write
"\tRequire valid-user\n")
671 val () = Env
.action_one
"requireUser"
672 ("users", Env
.list Env
.string)
676 | _
=> (write
"\tRequire user";
677 app (fn name
=> (write
" "; write name
)) names
;
680 val () = Env
.action_one
"requireGroup"
681 ("groups", Env
.list Env
.string)
685 | _
=> (write
"\tRequire group";
686 app (fn name
=> (write
" "; write name
)) names
;
689 val () = Env
.action_none
"orderAllowDeny"
690 (fn () => write
"\tOrder allow,deny\n")
692 val () = Env
.action_none
"orderDenyAllow"
693 (fn () => write
"\tOrder deny,allow\n")
695 val () = Env
.action_none
"allowFromAll"
696 (fn () => write
"\tAllow from all\n")
698 val () = Env
.action_one
"allowFrom"
699 ("entries", Env
.list Env
.string)
703 | _
=> (write
"\tAllow from";
704 app (fn name
=> (write
" "; write name
)) names
;
707 val () = Env
.action_none
"denyFromAll"
708 (fn () => write
"\tDeny from all\n")
710 val () = Env
.action_one
"denyFrom"
711 ("entries", Env
.list Env
.string)
715 | _
=> (write
"\tDeny from";
716 app (fn name
=> (write
" "; write name
)) names
;
719 val () = Env
.action_none
"satisfyAll"
720 (fn () => write
"\tSatisfy all\n")
722 val () = Env
.action_none
"satisfyAny"
723 (fn () => write
"\tSatisfy any\n")
725 val () = Env
.action_one
"forceType"
727 (fn ty
=> (write
"\tForceType ";
731 val () = Env
.action_none
"forceTypeOff"
732 (fn () => write
"\tForceType None\n")
734 val () = Env
.action_two
"action"
735 ("what", Env
.string, "how", Env
.string)
736 (fn (what
, how
) => (write
"\tAction ";
742 val () = Env
.action_one
"addDefaultCharset"
743 ("charset", Env
.string)
744 (fn ty
=> (write
"\tAddDefaultCharset ";
748 (*val () = Env
.action_one
"davSvn"
750 (fn path
=> (write
"\tDAV svn\n\tSVNPath ";
754 val () = Env
.action_one
"authzSvnAccessFile"
756 (fn path
=> (write
"\tAuthzSVNAccessFile ";
760 val () = Env
.action_two
"addDescription"
761 ("description", Env
.string, "patterns", Env
.list Env
.string)
765 | _
=> (write
"\tAddDescription \"";
766 write (String.toString desc
);
768 app (fn pat
=> (write
" "; write pat
)) pats
;
771 val () = Env
.action_one
"indexOptions"
772 ("options", Env
.list autoindex_option
)
776 | _
=> (write
"\tIndexOptions";
777 app (fn (opt
, arg
) =>
780 Option
.app (fn arg
=>
781 (write
"="; write arg
)) arg
)) opts
;
784 val () = Env
.action_one
"set_indexOptions"
785 ("options", Env
.list autoindex_option
)
789 | _
=> (write
"\tIndexOptions";
790 app (fn (opt
, arg
) =>
793 Option
.app (fn arg
=>
794 (write
"="; write arg
)) arg
)) opts
;
797 val () = Env
.action_one
"unset_indexOptions"
798 ("options", Env
.list autoindex_option
)
802 | _
=> (write
"\tIndexOptions";
808 val () = Env
.action_one
"headerName"
810 (fn name
=> (write
"\tHeaderName ";
814 val () = Env
.action_one
"readmeName"
816 (fn name
=> (write
"\tReadmeName ";
820 val () = Domain
.registerResetLocal (fn () =>
821 ignore (OS
.Process
.system (Config
.rm ^
" -rf /var/domtool/vhosts/*")))