2014-03-31 05:29:47 +00:00
|
|
|
module Propellor.Property.Cron where
|
|
|
|
|
|
|
|
import Propellor
|
|
|
|
import qualified Propellor.Property.File as File
|
|
|
|
import qualified Propellor.Property.Apt as Apt
|
2015-04-02 14:20:44 +00:00
|
|
|
import Propellor.Bootstrap
|
2014-04-17 23:43:12 +00:00
|
|
|
import Utility.SafeCommand
|
2014-07-18 16:35:00 +00:00
|
|
|
import Utility.FileMode
|
2014-03-31 05:29:47 +00:00
|
|
|
|
2014-04-13 02:36:36 +00:00
|
|
|
import Data.Char
|
|
|
|
|
2015-02-01 21:34:04 +00:00
|
|
|
-- | When to run a cron job.
|
|
|
|
--
|
|
|
|
-- The Daily, Monthly, and Weekly options allow the cron job to be run
|
|
|
|
-- by anacron, which is useful for non-servers.
|
|
|
|
data Times
|
|
|
|
= Times String -- ^ formatted as in crontab(5)
|
|
|
|
| Daily
|
|
|
|
| Weekly
|
|
|
|
| Monthly
|
2014-03-31 05:29:47 +00:00
|
|
|
|
2015-02-01 21:34:04 +00:00
|
|
|
-- | Installs a cron job, that will run as a specified user in a particular
|
|
|
|
-- directory. Note that the Desc must be unique, as it is used for the
|
|
|
|
-- cron job filename.
|
2014-04-17 23:43:12 +00:00
|
|
|
--
|
|
|
|
-- Only one instance of the cron job is allowed to run at a time, no matter
|
|
|
|
-- how long it runs. This is accomplished using flock locking of the cron
|
|
|
|
-- job file.
|
2014-04-18 01:01:06 +00:00
|
|
|
--
|
|
|
|
-- The cron job's output will only be emailed if it exits nonzero.
|
2015-04-22 17:04:39 +00:00
|
|
|
job :: Desc -> Times -> User -> FilePath -> String -> Property NoInfo
|
|
|
|
job desc times (User u) cddir command = combineProperties ("cronned " ++ desc)
|
2014-07-18 16:35:00 +00:00
|
|
|
[ cronjobfile `File.hasContent`
|
2015-02-25 18:58:40 +00:00
|
|
|
[ case times of
|
|
|
|
Times _ -> ""
|
|
|
|
_ -> "#!/bin/sh\nset -e"
|
|
|
|
, "# Generated by propellor"
|
2014-07-18 16:35:00 +00:00
|
|
|
, ""
|
|
|
|
, "SHELL=/bin/sh"
|
|
|
|
, "PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
|
|
|
|
, ""
|
2015-02-01 21:34:04 +00:00
|
|
|
, case times of
|
2015-04-22 17:04:39 +00:00
|
|
|
Times t -> t ++ "\t" ++ u ++ "\tchronic " ++ shellEscape scriptfile
|
|
|
|
_ -> case u of
|
2015-02-01 21:34:04 +00:00
|
|
|
"root" -> "chronic " ++ shellEscape scriptfile
|
2015-04-22 17:04:39 +00:00
|
|
|
_ -> "chronic su " ++ u ++ " -c " ++ shellEscape scriptfile
|
2014-07-18 16:35:00 +00:00
|
|
|
]
|
2015-02-01 21:38:05 +00:00
|
|
|
, case times of
|
|
|
|
Times _ -> doNothing
|
|
|
|
_ -> cronjobfile `File.mode` combineModes (readModes ++ executeModes)
|
2014-07-18 16:35:00 +00:00
|
|
|
-- Use a separate script because it makes the cron job name
|
|
|
|
-- prettier in emails, and also allows running the job manually.
|
|
|
|
, scriptfile `File.hasContent`
|
|
|
|
[ "#!/bin/sh"
|
|
|
|
, "# Generated by propellor"
|
|
|
|
, "set -e"
|
2014-07-18 16:39:45 +00:00
|
|
|
, "flock -n " ++ shellEscape cronjobfile
|
2014-07-18 16:35:00 +00:00
|
|
|
++ " sh -c " ++ shellEscape cmdline
|
|
|
|
]
|
|
|
|
, scriptfile `File.mode` combineModes (readModes ++ executeModes)
|
2014-03-31 05:29:47 +00:00
|
|
|
]
|
2014-04-08 23:31:03 +00:00
|
|
|
`requires` Apt.serviceInstalledRunning "cron"
|
2014-04-18 01:01:06 +00:00
|
|
|
`requires` Apt.installed ["util-linux", "moreutils"]
|
2014-04-13 02:36:36 +00:00
|
|
|
where
|
2014-04-18 03:32:42 +00:00
|
|
|
cmdline = "cd " ++ cddir ++ " && ( " ++ command ++ " )"
|
2015-02-01 21:34:04 +00:00
|
|
|
cronjobfile = "/etc" </> cronjobdir </> name
|
|
|
|
cronjobdir = case times of
|
|
|
|
Times _ -> "cron.d"
|
|
|
|
Daily -> "cron.daily"
|
|
|
|
Weekly -> "cron.weekly"
|
|
|
|
Monthly -> "cron.monthly"
|
2014-07-18 16:35:00 +00:00
|
|
|
scriptfile = "/usr/local/bin/" ++ name ++ "_cronjob"
|
|
|
|
name = map sanitize desc
|
2014-04-13 02:36:36 +00:00
|
|
|
sanitize c
|
|
|
|
| isAlphaNum c = c
|
|
|
|
| otherwise = '_'
|
2014-04-01 21:54:20 +00:00
|
|
|
|
|
|
|
-- | Installs a cron job, and runs it niced and ioniced.
|
2015-04-22 17:04:39 +00:00
|
|
|
niceJob :: Desc -> Times -> User -> FilePath -> String -> Property NoInfo
|
2014-04-01 21:54:20 +00:00
|
|
|
niceJob desc times user cddir command = job desc times user cddir
|
2014-07-17 19:33:02 +00:00
|
|
|
("nice ionice -c 3 sh -c " ++ shellEscape command)
|
2014-04-01 21:54:20 +00:00
|
|
|
|
|
|
|
-- | Installs a cron job to run propellor.
|
2015-02-01 21:34:04 +00:00
|
|
|
runPropellor :: Times -> Property NoInfo
|
2015-04-22 17:04:39 +00:00
|
|
|
runPropellor times = niceJob "propellor" times (User "root") localdir
|
2015-04-02 14:20:44 +00:00
|
|
|
(bootstrapPropellorCommand ++ "; ./propellor")
|