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 val () = Slave
.registerFileHandler (fn fs
=>
246 val spl
= OS
.Path
.splitDirFile (#file fs
)
248 if String.isSuffix
".vhost" (#file spl
)
249 orelse String.isSuffix
".vhost_ssl" (#file spl
) then let
250 val realVhostFile
= OS
.Path
.joinDirFile
251 {dir
= Config
.Apache
.confDir
,
254 val user
= findVhostUser (#file fs
)
255 val oldUser
= findVhostUser realVhostFile
257 if (oldUser
= NONE
andalso #action fs
<> Slave
.Add
)
258 orelse (user
= NONE
andalso #action fs
<> Slave
.Delete
) then
259 print ("Can't find user in " ^ #file fs ^
" or " ^ realVhostFile ^
"! Taking no action.\n")
262 fun realLogDir user
=
264 val realLogDir
= Domain
.homedirOf (valOf user
)
265 val realLogDir
= OS
.Path
.joinDirFile
268 val realLogDir
= OS
.Path
.joinDirFile
271 val realLogDir
= OS
.Path
.joinDirFile
273 file
= Slave
.hostname ()}
274 val {base
, ...} = OS
.Path
.splitBaseExt (#file spl
)
276 val realLogDir
= OS
.Path
.concat (realLogDir
, base
)
278 if String.isSuffix
".vhost_ssl" (#file spl
) then
284 vhostsChanged
:= true;
290 (ignore (OS
.Process
.system (down ()));
292 ignore (OS
.Process
.system (Config
.rm
295 ignore (OS
.Process
.system (Config
.rm
297 ^ realLogDir oldUser
)))
300 val rld
= realLogDir user
302 ignore (OS
.Process
.system (Config
.cp
307 if Posix
.FileSys
.access (rld
, []) then
314 (ignore (OS
.Process
.system (Config
.cp
319 if user
<> oldUser
then
321 val old
= realLogDir oldUser
322 val rld
= realLogDir user
327 (ignore (OS
.Process
.system (down ()));
329 ignore (OS
.Process
.system (Config
.rm
331 ^ realLogDir oldUser
));
332 if Posix
.FileSys
.access (rld
, []) then
345 val () = Slave
.registerPostHandler
347 (if !vhostsChanged
then
348 Slave
.shellF ([if !logDeleted
then undown () else reload ()],
349 fn cl
=> "Error reloading Apache with " ^ cl
)
353 val vhostFiles
: (string * TextIO.outstream
) list ref
= ref
[]
354 fun write
' s
= app (fn (node
, file
) => TextIO.output (file
, s node
)) (!vhostFiles
)
355 fun write s
= app (fn (_
, file
) => TextIO.output (file
, s
)) (!vhostFiles
)
357 val rewriteEnabled
= ref
false
358 val localRewriteEnabled
= ref
false
359 val currentVhost
= ref
""
360 val currentVhostId
= ref
""
362 val pre
= ref (fn _
: {user
: string, nodes
: string list
, id
: string, hostname
: string} => ())
367 pre
:= (fn x
=> (old x
; f x
))
370 val post
= ref (fn () => ())
375 post
:= (fn () => (old (); f ()))
378 val aliaser
= ref (fn _
: string => ())
379 fun registerAliaser f
=
383 aliaser
:= (fn x
=> (old x
; f x
))
386 val () = Env
.containerV_one
"vhost"
390 val nodes
= Env
.env (Env
.list Env
.string) (env
, "WebNodes")
392 val ssl
= Env
.env
ssl (env
, "SSL")
393 val user
= Env
.env Env
.string (env
, "User")
394 val group
= Env
.env Env
.string (env
, "Group")
395 val docroot
= Env
.env Env
.string (env
, "DocumentRoot")
396 val sadmin
= Env
.env Env
.string (env
, "ServerAdmin")
397 val suexec
= Env
.env Env
.bool (env
, "SuExec")
399 val fullHost
= host ^
"." ^ Domain
.currentDomain ()
400 val vhostId
= fullHost ^
(if Option
.isSome ssl
then ".ssl" else "")
401 val confFile
= fullHost ^
(if Option
.isSome ssl
then ".vhost_ssl" else ".vhost")
403 currentVhost
:= fullHost
;
404 currentVhostId
:= vhostId
;
406 rewriteEnabled
:= false;
407 localRewriteEnabled
:= false;
408 vhostFiles
:= map (fn node
=>
410 val file
= Domain
.domainFile
{node
= node
,
413 TextIO.output (file
, "# Owner: ");
414 TextIO.output (file
, user
);
415 TextIO.output (file
, "\n<VirtualHost ");
416 TextIO.output (file
, Domain
.nodeIp node
);
417 TextIO.output (file
, ":");
418 TextIO.output (file
, case ssl
of
421 TextIO.output (file
, ">\n");
422 TextIO.output (file
, "\tErrorLog ");
423 TextIO.output (file
, Domain
.homedirOf user
);
424 TextIO.output (file
, "/apache/log/");
425 TextIO.output (file
, node
);
426 TextIO.output (file
, "/");
427 TextIO.output (file
, vhostId
);
428 TextIO.output (file
, "/error.log\n\tCustomLog ");
429 TextIO.output (file
, Domain
.homedirOf user
);
430 TextIO.output (file
, "/apache/log/");
431 TextIO.output (file
, node
);
432 TextIO.output (file
, "/");
433 TextIO.output (file
, vhostId
);
434 TextIO.output (file
, "/access.log combined\n");
435 TextIO.output (file
, "\tServerName ");
436 TextIO.output (file
, fullHost
);
438 if isVersion1 node
then
439 (TextIO.output (file
, "\n\tUser ");
440 TextIO.output (file
, user
);
441 TextIO.output (file
, "\n\tGroup ");
442 TextIO.output (file
, group
))
444 (TextIO.output (file
, "\n\tSuexecUserGroup ");
445 TextIO.output (file
, user
);
446 TextIO.output (file
, " ");
447 TextIO.output (file
, group
))
450 if isWaklog node
then
451 (TextIO.output (file
, "\n\tWaklogProtected on\n\tWaklogPrincipal ");
452 TextIO.output (file
, user
);
453 TextIO.output (file
, "/cgi@HCOOP.NET /etc/keytabs/cgi/");
454 TextIO.output (file
, user
))
457 (Domain
.homedirOf user ^
"/apache/log/"
458 ^ node ^
"/" ^ vhostId
, file
)
461 write
"\n\tDocumentRoot ";
463 write
"\n\tServerAdmin ";
467 (write
"\n\tSSLEngine on\n\tSSLCertificateFile ";
471 !pre
{user
= user
, nodes
= nodes
, id
= vhostId
, hostname
= fullHost
}
474 write
"</VirtualHost>\n";
475 app (TextIO.closeOut
o #
2) (!vhostFiles
)))
477 val inLocal
= ref
false
479 val () = Env
.container_one
"location"
480 ("prefix", Env
.string)
482 (write
"\t<Location ";
486 fn () => (write
"\t</Location>\n";
488 localRewriteEnabled
:= false))
490 val () = Env
.container_one
"directory"
491 ("directory", Env
.string)
493 (write
"\t<Directory ";
497 fn () => (write
"\t</Directory>\n";
499 localRewriteEnabled
:= false))
501 fun checkRewrite () =
503 if !rewriteEnabled
orelse !localRewriteEnabled
then
506 (write
"\tRewriteEngine on\n";
507 localRewriteEnabled
:= true)
508 else if !rewriteEnabled
then
511 (write
"\tRewriteEngine on\n";
512 rewriteEnabled
:= true)
514 val () = Env
.action_three
"localProxyRewrite"
515 ("from", Env
.string, "to", Env
.string, "port", Env
.int)
516 (fn (from
, to
, port
) =>
518 write
"\tRewriteRule\t";
520 write
"\thttp://localhost:";
521 write (Int.toString port
);
526 val () = Env
.action_two
"proxyPass"
527 ("from", Env
.string, "to", Env
.string)
529 (write
"\tProxyPass\t";
535 val () = Env
.action_two
"proxyPassReverse"
536 ("from", Env
.string, "to", Env
.string)
538 (write
"\tProxyPassReverse\t";
544 val () = Env
.action_three
"rewriteRule"
545 ("from", Env
.string, "to", Env
.string, "flags", Env
.list flag
)
546 (fn (from
, to
, flags
) =>
548 write
"\tRewriteRule\t";
554 | flag
::rest
=> (write
" [";
556 app (fn flag
=> (write
",";
561 val () = Env
.action_three
"rewriteCond"
562 ("test", Env
.string, "pattern", Env
.string, "flags", Env
.list cond_flag
)
563 (fn (from
, to
, flags
) =>
565 write
"\tRewriteCond\t";
571 | flag
::rest
=> (write
" [";
573 app (fn flag
=> (write
",";
578 val () = Env
.action_one
"rewriteLogLevel"
582 write
"\tRewriteLog ";
584 write
"/rewrite.log\n\tRewriteLogLevel ";
585 write (Int.toString level
);
588 val () = Env
.action_two
"alias"
589 ("from", Env
.string, "to", Env
.string)
597 val () = Env
.action_two
"scriptAlias"
598 ("from", Env
.string, "to", Env
.string)
600 (write
"\tScriptAlias\t";
606 val () = Env
.action_two
"errorDocument"
607 ("code", Env
.string, "handler", Env
.string)
608 (fn (code
, handler
) =>
609 (write
"\tErrorDocument\t";
615 val () = Env
.action_one
"options"
616 ("options", Env
.list apache_option
)
620 | _
=> (write
"\tOptions";
621 app (fn opt
=> (write
" "; write opt
)) opts
;
624 val () = Env
.action_one
"set_options"
625 ("options", Env
.list apache_option
)
629 | _
=> (write
"\tOptions";
630 app (fn opt
=> (write
" +"; write opt
)) opts
;
633 val () = Env
.action_one
"unset_options"
634 ("options", Env
.list apache_option
)
638 | _
=> (write
"\tOptions";
639 app (fn opt
=> (write
" -"; write opt
)) opts
;
642 val () = Env
.action_one
"directoryIndex"
643 ("filenames", Env
.list Env
.string)
645 (write
"\tDirectoryIndex";
646 app (fn opt
=> (write
" "; write opt
)) opts
;
649 val () = Env
.action_one
"serverAlias"
652 (write
"\tServerAlias ";
657 val authType
= fn (EVar
"basic", _
) => SOME
"basic"
658 |
(EVar
"digest", _
) => SOME
"digest"
661 val () = Env
.action_one
"authType"
664 (write
"\tAuthType ";
668 val () = Env
.action_one
"authName"
671 (write
"\tAuthName \"";
675 val () = Env
.action_one
"authUserFile"
678 (write
"\tAuthUserFile ";
682 val () = Env
.action_none
"requireValidUser"
683 (fn () => write
"\tRequire valid-user\n")
685 val () = Env
.action_one
"requireUser"
686 ("users", Env
.list Env
.string)
690 | _
=> (write
"\tRequire user";
691 app (fn name
=> (write
" "; write name
)) names
;
694 val () = Env
.action_one
"requireGroup"
695 ("groups", Env
.list Env
.string)
699 | _
=> (write
"\tRequire group";
700 app (fn name
=> (write
" "; write name
)) names
;
703 val () = Env
.action_none
"orderAllowDeny"
704 (fn () => write
"\tOrder allow,deny\n")
706 val () = Env
.action_none
"orderDenyAllow"
707 (fn () => write
"\tOrder deny,allow\n")
709 val () = Env
.action_none
"allowFromAll"
710 (fn () => write
"\tAllow from all\n")
712 val () = Env
.action_one
"allowFrom"
713 ("entries", Env
.list Env
.string)
717 | _
=> (write
"\tAllow from";
718 app (fn name
=> (write
" "; write name
)) names
;
721 val () = Env
.action_none
"denyFromAll"
722 (fn () => write
"\tDeny from all\n")
724 val () = Env
.action_one
"denyFrom"
725 ("entries", Env
.list Env
.string)
729 | _
=> (write
"\tDeny from";
730 app (fn name
=> (write
" "; write name
)) names
;
733 val () = Env
.action_none
"satisfyAll"
734 (fn () => write
"\tSatisfy all\n")
736 val () = Env
.action_none
"satisfyAny"
737 (fn () => write
"\tSatisfy any\n")
739 val () = Env
.action_one
"forceType"
741 (fn ty
=> (write
"\tForceType ";
745 val () = Env
.action_none
"forceTypeOff"
746 (fn () => write
"\tForceType None\n")
748 val () = Env
.action_two
"action"
749 ("what", Env
.string, "how", Env
.string)
750 (fn (what
, how
) => (write
"\tAction ";
756 val () = Env
.action_one
"addDefaultCharset"
757 ("charset", Env
.string)
758 (fn ty
=> (write
"\tAddDefaultCharset ";
762 (*val () = Env
.action_one
"davSvn"
764 (fn path
=> (write
"\tDAV svn\n\tSVNPath ";
768 val () = Env
.action_one
"authzSvnAccessFile"
770 (fn path
=> (write
"\tAuthzSVNAccessFile ";
774 val () = Env
.action_two
"addDescription"
775 ("description", Env
.string, "patterns", Env
.list Env
.string)
779 | _
=> (write
"\tAddDescription \"";
780 write (String.toString desc
);
782 app (fn pat
=> (write
" "; write pat
)) pats
;
785 val () = Env
.action_one
"indexOptions"
786 ("options", Env
.list autoindex_option
)
790 | _
=> (write
"\tIndexOptions";
791 app (fn (opt
, arg
) =>
794 Option
.app (fn arg
=>
795 (write
"="; write arg
)) arg
)) opts
;
798 val () = Env
.action_one
"set_indexOptions"
799 ("options", Env
.list autoindex_option
)
803 | _
=> (write
"\tIndexOptions";
804 app (fn (opt
, arg
) =>
807 Option
.app (fn arg
=>
808 (write
"="; write arg
)) arg
)) opts
;
811 val () = Env
.action_one
"unset_indexOptions"
812 ("options", Env
.list autoindex_option
)
816 | _
=> (write
"\tIndexOptions";
822 val () = Env
.action_one
"headerName"
824 (fn name
=> (write
"\tHeaderName ";
828 val () = Env
.action_one
"readmeName"
830 (fn name
=> (write
"\tReadmeName ";
834 val () = Domain
.registerResetLocal (fn () =>
835 ignore (OS
.Process
.system (Config
.rm ^
" -rf /var/domtool/vhosts/*")))