Testing log directory backup
[hcoop/domtool2.git] / src / plugins / apache.sml
index 511901c..1f0fe83 100644 (file)
@@ -1,5 +1,5 @@
 (* HCoop Domtool (http://hcoop.sourceforge.net/)
- * Copyright (c) 2006, Adam Chlipala
+ * Copyright (c) 2006-2007, Adam Chlipala
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -89,33 +89,29 @@ fun ssl e = case e of
 
 val dl = ErrorMsg.dummyLoc
 
-val _ = Defaults.registerDefault ("WebNodes",
-                                 (TList (TBase "web_node", dl), dl),
-                                 (fn () => (EList (map (fn s => (EString s, dl)) Config.Apache.webNodes_default), dl)))
-
-val _ = Defaults.registerDefault ("SSL",
-                                 (TBase "ssl", dl),
-                                 (fn () => (EVar "no_ssl", dl)))
-
-val _ = Defaults.registerDefault ("User",
-                                 (TBase "your_user", dl),
-                                 (fn () => (EString (Domain.getUser ()), dl)))
-
-val _ = Defaults.registerDefault ("Group",
-                                 (TBase "your_group", dl),
-                                 (fn () => (EString (Domain.getUser ()), dl)))
-
-val _ = Defaults.registerDefault ("DocumentRoot",
-                                 (TBase "your_path", dl),
-                                 (fn () => (EString (Domain.homedir () ^ "/" ^ Config.Apache.public_html), dl)))
-
-val _ = Defaults.registerDefault ("ServerAdmin",
-                                 (TBase "email", dl),
-                                 (fn () => (EString (Domain.getUser () ^ "@" ^ Config.defaultDomain), dl)))
-
-val _ = Defaults.registerDefault ("SuExec",
-                                 (TBase "suexec_flag", dl),
-                                 (fn () => (EVar "true", dl)))
+val defaults = [("WebNodes",
+                (TList (TBase "web_node", dl), dl),
+                (fn () => (EList (map (fn s => (EString s, dl)) Config.Apache.webNodes_default), dl))),
+               ("SSL",
+                (TBase "ssl", dl),
+                (fn () => (EVar "no_ssl", dl))),
+               ("User",
+                (TBase "your_user", dl),
+                (fn () => (EString (Domain.getUser ()), dl))),
+               ("Group",
+                (TBase "your_group", dl),
+                (fn () => (EString "nogroup", dl))),
+               ("DocumentRoot",
+                (TBase "your_path", dl),
+                (fn () => (EString (Domain.homedir () ^ "/" ^ Config.Apache.public_html), dl))),
+               ("ServerAdmin",
+                (TBase "email", dl),
+                (fn () => (EString (Domain.getUser () ^ "@" ^ Config.defaultDomain), dl))),
+               ("SuExec",
+                (TBase "suexec_flag", dl),
+                (fn () => (EVar "true", dl)))]
+
+val () = app Defaults.registerDefault defaults
 
 val redirect_code = fn (EVar "temp", _) => SOME "temp"
                     | (EVar "permanent", _) => SOME "permanent"
@@ -241,6 +237,13 @@ fun down () = if imVersion1 () then Config.Apache.down1 else Config.Apache.down
 fun undown () = if imVersion1 () then Config.Apache.undown1 else Config.Apache.undown
 fun reload () = if imVersion1 () then Config.Apache.reload1 else Config.Apache.reload
 
+fun logDir {user, node, vhostId} =
+    String.concat [Config.Apache.logDirOf (isVersion1 node) user,
+                  "/",
+                  node,
+                  "/",
+                  vhostId]
+
 val () = Slave.registerFileHandler (fn fs =>
                                       let
                                           val spl = OS.Path.splitDirFile (#file fs)
@@ -259,42 +262,34 @@ val () = Slave.registerFileHandler (fn fs =>
                                                       print ("Can't find user in " ^ #file fs ^ " or " ^ realVhostFile ^ "!  Taking no action.\n")
                                                   else
                                                       let
+                                                          val vhostId = if OS.Path.ext (#file spl) = SOME "vhost_ssl" then
+                                                                            OS.Path.base (#file spl) ^ ".ssl"
+                                                                        else
+                                                                            OS.Path.base (#file spl)
+
                                                           fun realLogDir user =
-                                                              let
-                                                                  val realLogDir = Domain.homedirOf (valOf user)
-                                                                  val realLogDir = OS.Path.joinDirFile
-                                                                                       {dir = realLogDir,
-                                                                                        file = "apache"}
-                                                                  val realLogDir = OS.Path.joinDirFile
-                                                                                       {dir = realLogDir,
-                                                                                        file = "log"}
-                                                                  val realLogDir = OS.Path.joinDirFile
-                                                                                       {dir = realLogDir,
-                                                                                        file = Slave.hostname ()}
-                                                                  val {base, ...} = OS.Path.splitBaseExt (#file spl)
-
-                                                                  val realLogDir = OS.Path.concat (realLogDir, base)
-                                                              in
-                                                                  if String.isSuffix ".vhost_ssl" (#file spl) then
-                                                                      realLogDir ^ ".ssl"
-                                                                  else
-                                                                      realLogDir
-                                                              end
+                                                              logDir {user = valOf user,
+                                                                      node = Slave.hostname (),
+                                                                      vhostId = vhostId}
                                                       in
                                                           vhostsChanged := true;
                                                           case #action fs of
                                                               Slave.Delete =>
-                                                              (if !logDeleted then
-                                                                   ()
-                                                               else
-                                                                   (ignore (OS.Process.system (down ()));
-                                                                    logDeleted := true);
-                                                               ignore (OS.Process.system (Config.rm
-                                                                                          ^ " -rf "
-                                                                                          ^ realVhostFile));
-                                                               ignore (OS.Process.system (Config.rm
-                                                                                          ^ " -rf "
-                                                                                          ^ realLogDir oldUser)))
+                                                              let
+                                                                  val ldir = realLogDir oldUser
+                                                              in
+                                                                  if !logDeleted then
+                                                                      ()
+                                                                  else
+                                                                      (ignore (OS.Process.system (down ()));
+                                                                       logDeleted := true);
+                                                                  ignore (OS.Process.system (Config.rm
+                                                                                             ^ " -rf "
+                                                                                             ^ realVhostFile));
+                                                                  Slave.moveDirCreate {from = ldir,
+                                                                                       to = Config.Apache.backupLogDirOf
+                                                                                                (isVersion1 (Slave.hostname ()))}
+                                                              end
                                                             | Slave.Add =>
                                                               let
                                                                   val rld = realLogDir user
@@ -307,7 +302,9 @@ val () = Slave.registerFileHandler (fn fs =>
                                                                   if Posix.FileSys.access (rld, []) then
                                                                       ()
                                                                   else
-                                                                      OS.FileSys.mkDir rld
+                                                                      Slave.moveDirCreate {from = Config.Apache.backupLogDirOf
+                                                                                                      (isVersion1 (Slave.hostname ())),
+                                                                                           to = rld}
                                                               end
                                                               
                                                             | _ =>
@@ -332,7 +329,7 @@ val () = Slave.registerFileHandler (fn fs =>
                                                                        if Posix.FileSys.access (rld, []) then
                                                                            ()
                                                                        else
-                                                                           OS.FileSys.mkDir rld
+                                                                           Slave.mkDirAll rld
                                                                    end
                                                                else
                                                                    ())
@@ -358,6 +355,7 @@ val rewriteEnabled = ref false
 val localRewriteEnabled = ref false
 val currentVhost = ref ""
 val currentVhostId = ref ""
+val sslEnabled = ref false
 
 val pre = ref (fn _ : {user : string, nodes : string list, id : string, hostname : string} => ())
 fun registerPre f =
@@ -402,6 +400,7 @@ val () = Env.containerV_one "vhost"
             in
                 currentVhost := fullHost;
                 currentVhostId := vhostId;
+                sslEnabled := Option.isSome ssl;
 
                 rewriteEnabled := false;
                 localRewriteEnabled := false;
@@ -409,6 +408,8 @@ val () = Env.containerV_one "vhost"
                                       let
                                           val file = Domain.domainFile {node = node,
                                                                         name = confFile}
+
+                                          val ld = logDir {user = user, node = node, vhostId = vhostId}
                                       in
                                           TextIO.output (file, "# Owner: ");
                                           TextIO.output (file, user);
@@ -420,20 +421,19 @@ val () = Env.containerV_one "vhost"
                                                                  | NONE => "80");
                                           TextIO.output (file, ">\n");
                                           TextIO.output (file, "\tErrorLog ");
-                                          TextIO.output (file, Domain.homedirOf user);
-                                          TextIO.output (file, "/apache/log/");
-                                          TextIO.output (file, node);
-                                          TextIO.output (file, "/");
-                                          TextIO.output (file, vhostId);
+                                          TextIO.output (file, ld);
                                           TextIO.output (file, "/error.log\n\tCustomLog ");
-                                          TextIO.output (file, Domain.homedirOf user);
-                                          TextIO.output (file, "/apache/log/");
-                                          TextIO.output (file, node);
-                                          TextIO.output (file, "/");
-                                          TextIO.output (file, vhostId);
+                                          TextIO.output (file, ld);
                                           TextIO.output (file, "/access.log combined\n");
                                           TextIO.output (file, "\tServerName ");
                                           TextIO.output (file, fullHost);
+                                          app
+                                              (fn dom => (TextIO.output (file, "\n\tServerAlias ");
+                                                          TextIO.output (file, host);
+                                                          TextIO.output (file, ".");
+                                                          TextIO.output (file, dom)))
+                                              (Domain.currentAliasDomains ());
+
                                           if suexec then
                                               if isVersion1 node then
                                                   (TextIO.output (file, "\n\tUser ");
@@ -447,15 +447,20 @@ val () = Env.containerV_one "vhost"
                                                    TextIO.output (file, group))
                                           else
                                               ();
+
                                           if isWaklog node then
-                                              (TextIO.output (file, "\n\tWaklogProtected on\n\tWaklogPrincipal ");
+                                              (TextIO.output (file, "\n\tWaklogEnabled on\n\tWaklogLocationPrincipal ");
                                                TextIO.output (file, user);
-                                               TextIO.output (file, "/cgi@HCOOP.NET /etc/keytabs/cgi/");
+                                               TextIO.output (file, "/daemon@HCOOP.NET /etc/keytabs/user.daemon/");
                                                TextIO.output (file, user))
                                           else
                                               ();
-                                          (Domain.homedirOf user ^ "/apache/log/"
-                                           ^ node ^ "/" ^ vhostId, file)
+
+                                          TextIO.output (file, "\n\tDAVLockDB /var/lock/apache2/dav/");
+                                          TextIO.output (file, user);
+                                          TextIO.output (file, "/DAVLock");
+
+                                          (ld, file)
                                       end)
                                   nodes;
                 write "\n\tDocumentRoot ";
@@ -468,7 +473,8 @@ val () = Env.containerV_one "vhost"
                      write cert)
                   | NONE => ();
                 write "\n";
-                !pre {user = user, nodes = nodes, id = vhostId, hostname = fullHost}
+                !pre {user = user, nodes = nodes, id = vhostId, hostname = fullHost};
+                app (fn dom => !aliaser (host ^ "." ^ dom)) (Domain.currentAliasDomains ())
             end,
          fn () => (!post ();
                    write "</VirtualHost>\n";
@@ -575,6 +581,14 @@ val () = Env.action_three "rewriteCond"
                                 write "]");
              write "\n"))
 
+val () = Env.action_one "rewriteBase"
+        ("prefix", Env.string)
+        (fn prefix =>
+            (checkRewrite ();
+             write "\tRewriteBase\t";
+             write prefix;
+             write "\n"))
+
 val () = Env.action_one "rewriteLogLevel"
         ("level", Env.int)
         (fn level =>
@@ -646,7 +660,7 @@ val () = Env.action_one "directoryIndex"
              app (fn opt => (write " "; write opt)) opts;
              write "\n"))
 
-val () = Env.action_one "serverAlias"
+val () = Env.action_one "serverAliasHost"
         ("host", Env.string)
         (fn host =>
             (write "\tServerAlias ";
@@ -654,16 +668,52 @@ val () = Env.action_one "serverAlias"
              write "\n";
              !aliaser host))
 
+val () = Env.action_one "serverAlias"
+        ("host", Env.string)
+        (fn host =>
+            (app
+                 (fn dom =>
+                     let
+                         val full = host ^ "." ^ dom
+                     in
+                         write "\tServerAlias ";
+                         write full;
+                         write "\n";
+                         !aliaser full
+                     end)
+                 (Domain.currentDomains ())))
+
+val () = Env.action_none "serverAliasDefault"
+        (fn () =>
+            (app
+                 (fn dom =>
+                         (write "\tServerAlias ";
+                          write dom;
+                          write "\n";
+                          !aliaser dom))
+                 (Domain.currentDomains ())))
+
 val authType = fn (EVar "basic", _) => SOME "basic"
                | (EVar "digest", _) => SOME "digest"
+               | (EVar "kerberos", _) => SOME "kerberos"
                | _ => NONE
 
+fun allowAuthType "kerberos" = !sslEnabled
+  | allowAuthType _ = true
+
 val () = Env.action_one "authType"
         ("type", authType)
         (fn ty =>
-            (write "\tAuthType ";
-             write ty;
-             write "\n"))
+            if allowAuthType ty then
+                (write "\tAuthType ";
+                 write ty;
+                 write "\n";
+                 case ty of
+                     "kerberos" => 
+                     write "\tKrbMethodNegotiate off\n\tKrbMethodK5Passwd on\n\tKrbVerifyKDC off\n\tKrbAuthRealms HCOOP.NET\n\tKrbSaveCredentials on\n"
+                   | _ => ())
+            else
+                print "WARNING: Skipped Kerberos authType because this isn't an SSL vhost.\n")
 
 val () = Env.action_one "authName"
         ("name", Env.string)
@@ -771,6 +821,9 @@ val () = Env.action_one "authzSvnAccessFile"
                      write path;
                      write "\n"))*)
 
+val () = Env.action_none "davFilesystem"
+        (fn path => write "\tDAV filesystem\n")
+
 val () = Env.action_two "addDescription"
         ("description", Env.string, "patterns", Env.list Env.string)
         (fn (desc, pats) =>
@@ -831,7 +884,22 @@ val () = Env.action_one "readmeName"
                      write name;
                      write "\n"))
 
+val () = Env.action_two "setEnv"
+        ("key", Env.string, "value", Env.string)
+        (fn (key, value) => (write "\tSetEnv \"";
+                             write key;
+                             write "\" \"";
+                             write (String.translate (fn #"\"" => "\\\""
+                                                       | ch => str ch) value);
+                             write "\"\n"))
+
 val () = Domain.registerResetLocal (fn () =>
                                       ignore (OS.Process.system (Config.rm ^ " -rf /var/domtool/vhosts/*")))
 
+val () = Domain.registerDescriber (Domain.considerAll
+                                  [Domain.Extension {extension = "vhost",
+                                                     heading = fn host => "Web vhost " ^ host},
+                                   Domain.Extension {extension = "vhost_ssl",
+                                                     heading = fn host => "SSL web vhost " ^ host}])
+
 end