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
"proxy_port"
29 val _
= Env
.type_one
"proxy_target"
33 fun default () = List.exists (fn s
' => s
= s
') Config
.Apache
.proxyTargets
35 case String.fields (fn ch
=> ch
= #
":") s
of
36 ["http", "//localhost", rest
] =>
37 (case String.fields (fn ch
=> ch
= #
"/") rest
of
39 (case Int.fromString port
of
41 | SOME n
=> n
> 1024 orelse default ())
46 val _
= Env
.type_one
"rewrite_arg"
48 (CharVector
.all
Char.isAlphaNum
)
51 size s
> 0 andalso size s
< 1000 andalso CharVector
.all
52 (fn ch
=> Char.isAlphaNum ch
58 val _
= Env
.type_one
"location"
62 val dl
= ErrorMsg
.dummyLoc
64 val _
= Main
.registerDefault ("WebNodes",
65 (TList (TBase
"node", dl
), dl
),
66 (fn () => (EList (map (fn s
=> (EString s
, dl
)) Config
.Apache
.webNodes
), dl
)))
68 val _
= Main
.registerDefault ("SSL",
70 (fn () => (EVar
"false", dl
)))
72 val _
= Main
.registerDefault ("User",
73 (TBase
"your_user", dl
),
74 (fn () => (EString (Domain
.getUser ()), dl
)))
76 val _
= Main
.registerDefault ("Group",
77 (TBase
"your_group", dl
),
78 (fn () => (EString (Domain
.getUser ()), dl
)))
80 val _
= Main
.registerDefault ("DocumentRoot",
81 (TBase
"your_path", dl
),
82 (fn () => (EString ("/home/" ^ Domain
.getUser () ^
"/public_html"), dl
)))
84 val _
= Main
.registerDefault ("ServerAdmin",
86 (fn () => (EString (Domain
.getUser () ^
"@" ^ Config
.defaultDomain
), dl
)))
89 val redirect_code
= fn (EVar
"temp", _
) => SOME
"temp"
90 |
(EVar
"permanent", _
) => SOME
"permanent"
91 |
(EVar
"seeother", _
) => SOME
"seeother"
92 |
(EVar
"redir300", _
) => SOME
"300"
93 |
(EVar
"redir301", _
) => SOME
"301"
94 |
(EVar
"redir302", _
) => SOME
"302"
95 |
(EVar
"redir303", _
) => SOME
"303"
96 |
(EVar
"redir304", _
) => SOME
"304"
97 |
(EVar
"redir305", _
) => SOME
"305"
98 |
(EVar
"redir307", _
) => SOME
"307"
101 val flag
= fn (EVar
"redirect", _
) => SOME
"R"
102 |
(EVar
"forbidden", _
) => SOME
"F"
103 |
(EVar
"gone", _
) => SOME
"G"
104 |
(EVar
"last", _
) => SOME
"L"
105 |
(EVar
"chain", _
) => SOME
"C"
106 |
(EVar
"nosubreq", _
) => SOME
"NS"
107 |
(EVar
"nocase", _
) => SOME
"NC"
108 |
(EVar
"qsappend", _
) => SOME
"QSA"
109 |
(EVar
"noescape", _
) => SOME
"NE"
110 |
(EVar
"passthrough", _
) => SOME
"PT"
111 |
(EApp ((EVar
"mimeType", _
), e
), _
) =>
112 Option
.map (fn s
=> "T=" ^ s
) (Env
.string e
)
113 |
(EApp ((EVar
"redirectWith", _
), e
), _
) =>
114 Option
.map (fn s
=> "R=" ^ s
) (redirect_code e
)
115 |
(EApp ((EVar
"skip", _
), e
), _
) =>
116 Option
.map (fn n
=> "S=" ^
Int.toString n
) (Env
.int e
)
117 |
(EApp ((EApp ((EVar
"env", _
), e1
), _
), e2
), _
) =>
118 (case Env
.string e1
of
120 | SOME s1
=> Option
.map (fn s2
=> "E=" ^ s1 ^
":" ^ s2
)
125 val cond_flag
= fn (EVar
"cond_nocase", _
) => SOME
"NC"
126 |
(EVar
"ornext", _
) => SOME
"OR"
129 val apache_option
= fn (EVar
"execCGI", _
) => SOME
"ExecCGI"
130 |
(EVar
"includesNOEXEC", _
) => SOME
"IncludesNOEXEC"
131 |
(EVar
"indexes", _
) => SOME
"Indexes"
134 val autoindex_width
= fn (EVar
"autofit", _
) => SOME
"*"
135 |
(EApp ((EVar
"characters", _
), n
), _
) =>
136 Option
.map
Int.toString (Env
.int n
)
139 val autoindex_option
= fn (EApp ((EVar
"descriptionWidth", _
), w
), _
) =>
140 Option
.map (fn w
=> ("DescriptionWidth", SOME w
))
142 |
(EVar
"fancyIndexing", _
) => SOME ("FancyIndexing", NONE
)
143 |
(EVar
"foldersFirst", _
) => SOME ("FoldersFirst", NONE
)
144 |
(EVar
"htmlTable", _
) => SOME ("HTMLTable", NONE
)
145 |
(EVar
"iconsAreLinks", _
) => SOME ("IconsAreLinks", NONE
)
146 |
(EApp ((EVar
"iconHeight", _
), n
), _
) =>
147 Option
.map (fn w
=> ("IconHeight", SOME (Int.toString w
)))
149 |
(EApp ((EVar
"iconWidth", _
), n
), _
) =>
150 Option
.map (fn w
=> ("IconWidth", SOME (Int.toString w
)))
152 |
(EVar
"ignoreCase", _
) => SOME ("IgnoreCase", NONE
)
153 |
(EVar
"ignoreClient", _
) => SOME ("IgnoreClient", NONE
)
154 |
(EApp ((EVar
"nameWidth", _
), w
), _
) =>
155 Option
.map (fn w
=> ("NameWidth", SOME w
))
157 |
(EVar
"scanHtmlTitles", _
) => SOME ("ScanHTMLTitles", NONE
)
158 |
(EVar
"suppressColumnSorting", _
) => SOME ("SuppressColumnSorting", NONE
)
159 |
(EVar
"suppressDescription", _
) => SOME ("SuppressDescription", NONE
)
160 |
(EVar
"suppressHtmlPreamble", _
) => SOME ("SuppressHTMLPreamble", NONE
)
161 |
(EVar
"suppressIcon", _
) => SOME ("SuppressIcon", NONE
)
162 |
(EVar
"suppressLastModified", _
) => SOME ("SuppressLastModified", NONE
)
163 |
(EVar
"suppressRules", _
) => SOME ("SuppressRules", NONE
)
164 |
(EVar
"suppressSize", _
) => SOME ("SuppressSize", NONE
)
165 |
(EVar
"trackModified", _
) => SOME ("TrackModified", NONE
)
166 |
(EVar
"versionSort", _
) => SOME ("VersionSort", NONE
)
167 |
(EVar
"xhtml", _
) => SOME ("XHTML", NONE
)
171 val vhostsChanged
= ref
false
173 val () = Slave
.registerPreHandler
174 (fn () => vhostsChanged
:= false)
176 val () = Slave
.registerFileHandler (fn fs
=>
178 val spl
= OS
.Path
.splitDirFile (#file fs
)
180 if String.isSuffix
".vhost" (#file spl
)
181 orelse String.isSuffix
".vhost_ssl" (#file spl
) then
182 (vhostsChanged
:= true;
185 ignore (OS
.Process
.system (Config
.rm
187 ^ Config
.Apache
.confDir
191 ignore (OS
.Process
.system (Config
.cp
195 ^ Config
.Apache
.confDir
202 val () = Slave
.registerPostHandler
204 (if !vhostsChanged
then
205 Slave
.shellF ([Config
.Apache
.reload
],
206 fn cl
=> "Error reloading Apache with " ^ cl
)
210 val vhostFiles
: TextIO.outstream list ref
= ref
[]
211 fun write s
= app (fn file
=> TextIO.output (file
, s
)) (!vhostFiles
)
213 val rewriteEnabled
= ref
false
214 val currentVhost
= ref
""
215 val currentVhostId
= ref
""
217 val () = Env
.containerV_one
"vhost"
221 val nodes
= Env
.env (Env
.list Env
.string) (env
, "WebNodes")
223 val ssl
= Env
.env Env
.bool (env
, "SSL")
224 val user
= Env
.env Env
.string (env
, "User")
225 val group
= Env
.env Env
.string (env
, "Group")
226 val docroot
= Env
.env Env
.string (env
, "DocumentRoot")
227 val sadmin
= Env
.env Env
.string (env
, "ServerAdmin")
229 val fullHost
= host ^
"." ^ Domain
.currentDomain ()
230 val vhostId
= fullHost ^
(if ssl
then ".ssl" else "")
231 val confFile
= fullHost ^
(if ssl
then ".vhost_ssl" else ".vhost")
233 currentVhost
:= fullHost
;
234 currentVhostId
:= vhostId
;
236 rewriteEnabled
:= false;
237 vhostFiles
:= map (fn node
=>
239 val file
= Domain
.domainFile
{node
= node
,
242 TextIO.output (file
, "<VirtualHost ");
243 TextIO.output (file
, Domain
.nodeIp node
);
244 TextIO.output (file
, ":");
245 TextIO.output (file
, if ssl
then
249 TextIO.output (file
, ">\n");
253 write
"\tServerName ";
255 write
"\n\tSuexecUserGroup ";
259 write
"\n\tDocumentRoot ";
261 write
"\n\tServerAdmin ";
263 write
"\n\tErrorLog ";
264 write Config
.Apache
.logDir
;
267 write
"/error.log\n\tCustomLog ";
268 write Config
.Apache
.logDir
;
271 write
"/access.log combined\n"
273 fn () => (write
"</VirtualHost>\n";
274 app
TextIO.closeOut (!vhostFiles
)))
276 val () = Env
.container_one
"location"
277 ("prefix", Env
.string)
279 (write
"\t<Location ";
282 fn () => write
"\t</Location>\n")
284 val () = Env
.container_one
"directory"
285 ("directory", Env
.string)
287 (write
"\t<Directory ";
290 fn () => write
"\t</Directory>\n")
292 fun checkRewrite () =
293 if !rewriteEnabled
then
296 (write
"\tRewriteEngine on\n";
297 rewriteEnabled
:= true)
299 val () = Env
.action_three
"localProxyRewrite"
300 ("from", Env
.string, "to", Env
.string, "port", Env
.int)
301 (fn (from
, to
, port
) =>
303 write
"\tRewriteRule\t";
305 write
"\thttp://localhost:";
306 write (Int.toString port
);
311 val () = Env
.action_two
"proxyPass"
312 ("from", Env
.string, "to", Env
.string)
314 (write
"\tProxyPass\t";
320 val () = Env
.action_two
"proxyPassReverse"
321 ("from", Env
.string, "to", Env
.string)
323 (write
"\tProxyPassReverse\t";
329 val () = Env
.action_three
"rewriteRule"
330 ("from", Env
.string, "to", Env
.string, "flags", Env
.list flag
)
331 (fn (from
, to
, flags
) =>
333 write
"\tRewriteRule\t";
339 | flag
::rest
=> (write
" [";
341 app (fn flag
=> (write
",";
346 val () = Env
.action_three
"rewriteCond"
347 ("test", Env
.string, "pattern", Env
.string, "flags", Env
.list cond_flag
)
348 (fn (from
, to
, flags
) =>
350 write
"\tRewriteCond\t";
356 | flag
::rest
=> (write
" [";
358 app (fn flag
=> (write
",";
363 val () = Env
.action_one
"rewriteLogLevel"
367 write
"\tRewriteLog ";
368 write Config
.Apache
.logDir
;
370 write (!currentVhostId
);
371 write
"/rewrite.log\n\tRewriteLogLevel ";
372 write (Int.toString level
);
375 val () = Env
.action_two
"alias"
376 ("from", Env
.string, "to", Env
.string)
384 val () = Env
.action_two
"scriptAlias"
385 ("from", Env
.string, "to", Env
.string)
387 (write
"\tScriptAlias\t";
393 val () = Env
.action_two
"errorDocument"
394 ("code", Env
.string, "handler", Env
.string)
395 (fn (code
, handler
) =>
396 (write
"\tErrorDocument\t";
402 val () = Env
.action_one
"options"
403 ("options", Env
.list apache_option
)
407 | _
=> (write
"\tOptions";
408 app (fn opt
=> (write
" "; write opt
)) opts
;
411 val () = Env
.action_one
"set_options"
412 ("options", Env
.list apache_option
)
416 | _
=> (write
"\tOptions";
417 app (fn opt
=> (write
" +"; write opt
)) opts
;
420 val () = Env
.action_one
"unset_options"
421 ("options", Env
.list apache_option
)
425 | _
=> (write
"\tOptions";
426 app (fn opt
=> (write
" -"; write opt
)) opts
;
429 val () = Env
.action_one
"directoryIndex"
430 ("filenames", Env
.list Env
.string)
432 (write
"\tDirectoryIndex";
433 app (fn opt
=> (write
" "; write opt
)) opts
;
436 val () = Env
.action_one
"serverAlias"
439 (write
"\tServerAlias ";
443 val authType
= fn (EVar
"basic", _
) => SOME
"basic"
444 |
(EVar
"digest", _
) => SOME
"digest"
447 val () = Env
.action_one
"authType"
450 (write
"\tAuthType ";
454 val () = Env
.action_one
"authName"
457 (write
"\tAuthName \"";
461 val () = Env
.action_one
"authUserFile"
464 (write
"\tAuthUserFile ";
468 val () = Env
.action_none
"requireValidUser"
469 (fn () => write
"\tRequire valid-user\n")
471 val () = Env
.action_one
"requireUser"
472 ("users", Env
.list Env
.string)
476 | _
=> (write
"\tRequire user";
477 app (fn name
=> (write
" "; write name
)) names
;
480 val () = Env
.action_one
"requireGroup"
481 ("groups", Env
.list Env
.string)
485 | _
=> (write
"\tRequire group";
486 app (fn name
=> (write
" "; write name
)) names
;
489 val () = Env
.action_none
"orderAllowDeny"
490 (fn () => write
"\tOrder allow,deny\n")
492 val () = Env
.action_none
"orderDenyAllow"
493 (fn () => write
"\tOrder deny,allow\n")
495 val () = Env
.action_none
"allowFromAll"
496 (fn () => write
"\tAllow from all\n")
498 val () = Env
.action_one
"allowFrom"
499 ("entries", Env
.list Env
.string)
503 | _
=> (write
"\tAllow from";
504 app (fn name
=> (write
" "; write name
)) names
;
507 val () = Env
.action_none
"denyFromAll"
508 (fn () => write
"\tDeny from all\n")
510 val () = Env
.action_one
"denyFrom"
511 ("entries", Env
.list Env
.string)
515 | _
=> (write
"\tDeny from";
516 app (fn name
=> (write
" "; write name
)) names
;
519 val () = Env
.action_none
"satisfyAll"
520 (fn () => write
"\tSatisfy all\n")
522 val () = Env
.action_none
"satisfyAny"
523 (fn () => write
"\tSatisfy any\n")
525 val () = Env
.action_one
"forceType"
527 (fn ty
=> (write
"\tForceType ";
531 val () = Env
.action_none
"forceTypeOff"
532 (fn () => write
"\tForceType None\n")
534 val () = Env
.action_two
"action"
535 ("what", Env
.string, "how", Env
.string)
536 (fn (what
, how
) => (write
"\tAction ";
542 val () = Env
.action_one
"addDefaultCharset"
543 ("charset", Env
.string)
544 (fn ty
=> (write
"\tAddDefaultCharset ";
548 val () = Env
.action_one
"davSvn"
550 (fn path
=> (write
"\tDAV svn\n\tSVNPath ";
554 val () = Env
.action_one
"authzSvnAccessFile"
556 (fn path
=> (write
"\tAuthzSVNAccessFile ";
560 val () = Env
.action_two
"addDescription"
561 ("description", Env
.string, "patterns", Env
.list Env
.string)
565 | _
=> (write
"\tAddDescription \"";
566 write (String.toString desc
);
568 app (fn pat
=> (write
" "; write pat
)) pats
;
571 val () = Env
.action_one
"indexOptions"
572 ("options", Env
.list autoindex_option
)
576 | _
=> (write
"\tIndexOptions";
577 app (fn (opt
, arg
) =>
580 Option
.app (fn arg
=>
581 (write
"="; write arg
)) arg
)) opts
;
584 val () = Env
.action_one
"set_indexOptions"
585 ("options", Env
.list autoindex_option
)
589 | _
=> (write
"\tIndexOptions";
590 app (fn (opt
, arg
) =>
593 Option
.app (fn arg
=>
594 (write
"="; write arg
)) arg
)) opts
;
597 val () = Env
.action_one
"unset_indexOptions"
598 ("options", Env
.list autoindex_option
)
602 | _
=> (write
"\tIndexOptions";
608 val () = Env
.action_one
"headerName"
610 (fn name
=> (write
"\tHeaderName ";
614 val () = Env
.action_one
"readmeName"
616 (fn name
=> (write
"\tReadmeName ";