2 * Copyright (C) 2012 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (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 along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 let libdir = ref Libdir.libdir
26 (* Running the program as root is a mistake. It must be run as a
29 let euid = geteuid () in
31 eprintf "whenjobs: this program must not be run as root\n";
35 (* $HOME must be defined and must exist and be a directory and must be
36 * owned by the current user.
41 eprintf "whenjobs: $HOME environment variable must be defined\n";
46 with Unix_error (err, fn, _) ->
47 eprintf "whenjobs: %s: %s ($HOME): %s\n" fn home (error_message err);
49 if stat.st_kind != S_DIR then (
50 eprintf "whenjobs: %s ($HOME): not a directory\n" home;
54 if stat.st_uid != euid then (
55 eprintf "whenjobs: %s ($HOME): not owned by the current user (uid %d)\n"
60 (* Make the $HOME/.whenjobs directory if it doesn't exist. *)
61 let jobsdir = sprintf "%s/.whenjobs" home in
62 (try mkdir jobsdir 0o700 with Unix_error _ -> ());
67 (* Parse the command line arguments. *)
68 let mode = ref None in
69 let typ = ref "string" in
71 let set_mode m () = mode := Some m in
73 let display_version () =
74 printf "%s %s\n" Config.package_name Config.package_version;
78 let argspec = Arg.align [
79 "--daemon-start", Arg.Unit (set_mode `Daemon_start), " Start the daemon";
80 "--daemon-status", Arg.Unit (set_mode `Daemon_status), " Display the status of the daemon";
81 "--daemon-stop", Arg.Unit (set_mode `Daemon_stop), " Stop the daemon";
82 "--daemon-restart", Arg.Unit (set_mode `Daemon_restart), " Restart the daemon";
83 "-e", Arg.Unit (set_mode `Edit), " Edit and upload the script";
84 "--edit", Arg.Unit (set_mode `Edit), " Edit and upload the script";
85 "--get", Arg.Unit (set_mode `Get), " Display the variable";
86 "-l", Arg.Unit (set_mode `List), " List the script";
87 "--list", Arg.Unit (set_mode `List), " List the script";
88 "--lib", Arg.Set_string libdir, "dir Specify directory that contains pa_when.cmo";
89 "--set", Arg.Unit (set_mode `Set), " Set the variable";
90 "--type", Arg.Set_string typ, "bool|int|float|string|unit Set the variable type";
91 "--upload", Arg.Unit (set_mode `Upload), " Upload the script";
92 "--variables", Arg.Unit (set_mode `Variables), " Display all variables and values";
93 "-V", Arg.Unit display_version, " Display version number and exit";
94 "--version", Arg.Unit display_version, " Display version number and exit";
98 let anon_fun str = args := str :: !args in
101 Whenjobs is a powerful but simple cron replacement.
102 Whenjobs copyright (C) 2012 Red Hat Inc.
109 Get and set variables:
111 whenjobs --get variable
112 whenjobs --set variable value
114 Start and stop the per-user daemon:
116 whenjobs --daemon-start | --daemon-stop | --daemon-status
118 For documentation see the whenjobs(1) man page.
123 Arg.parse argspec anon_fun usage_msg;
126 let args = List.rev !args in
128 let typ = match !typ with
129 | "bool"|"boolean" -> `Bool
130 | "string" -> `String
132 | "float"|"double" -> `Float
135 eprintf "whenjobs: --type: unknown type (%s)\n" t;
138 (* Depending on the selected mode, perform a different action. *)
141 eprintf "whenjobs: no operation selected.\n";
146 unused_error args "-e";
150 unused_error args "-l";
154 unused_error args "--upload";
158 if List.length args != 2 then (
159 eprintf "whenjobs --set variable value\n";
160 eprintf "If 'value' contains spaces, you may need to quote it.\n";
164 set_variable (List.hd args) (List.hd (List.tl args)) typ
167 if List.length args != 1 then (
168 eprintf "whenjobs --get variable\n";
172 get_variable (List.hd args)
175 unused_error args "--variables";
178 | Some `Daemon_start ->
179 unused_error args "--daemon-start";
182 | Some `Daemon_stop ->
183 unused_error args "--daemon-stop";
186 | Some `Daemon_restart ->
187 unused_error args "--daemon-restart";
190 | Some `Daemon_status ->
191 unused_error args "--daemon-status";
195 (* If there is no initial file, create an empty one containing the
198 let file = get_jobs_filename () in
199 if not (Sys.file_exists file) then
200 create_tutorial file;
202 (* Is $EDITOR set? If not, use a default. *)
203 let editor = try getenv "EDITOR" with Not_found -> "vi" in
205 (* Get the (size, MD5) of the file to tell if it changed. *)
207 try (lstat file).st_size, Digest.file file
208 with Unix_error (err, fn, _) ->
209 eprintf "whenjobs: %s: %s: %s\n" fn file (error_message err);
212 let old_stamp = file_stamp () in
214 let cmd = sprintf "%s %s" editor file in
215 if Sys.command cmd != 0 then (
216 eprintf "whenjobs: error editing file (is $EDITOR set correctly?)\n";
220 let new_stamp = file_stamp () in
222 if old_stamp <> new_stamp then
226 let file = get_jobs_filename () in
227 if not (Sys.file_exists file) then (
228 eprintf "whenjobs: there is no jobs file, use 'whenjobs -e' to create one\n";
231 let chan = open_in file in
233 printf "%s\n" (input_line chan);
236 (try loop () with End_of_file -> ());
240 (* Recompile the jobs file. *)
241 let file = get_jobs_filename () in
242 let cmo_file = sprintf "%s/jobs.cmo" jobsdir in
243 let cmd = sprintf "ocamlfind ocamlc -I +camlp4 -I %s -package unix,camlp4.lib -pp 'camlp4o %s/pa_when.cmo' -c %s -o %s"
244 !libdir !libdir file cmo_file in
245 if Sys.command cmd <> 0 then (
246 eprintf "whenjobs: could not compile jobs script, see earlier error messages\n";
247 eprintf "compile command was:\n%s\n" cmd;
251 (* Test-load the jobs file to ensure it makes sense. *)
252 Whenfile.init Whenstate.empty;
254 Dynlink.loadfile cmo_file
257 eprintf "whenjobs: %s\n" (Dynlink.error_message err);
258 (* Since it failed, unlink it. *)
259 (try unlink cmo_file with Unix_error _ -> ());
263 (* OK now let's tell the daemon to reload it. *)
264 let client = start_client () in
265 (match Whenproto_clnt.When.V1.reload_file client () with
268 eprintf "whenjobs: reload: %s\n" msg;
269 suggest_check_server_logs ();
274 and set_variable name value typ =
275 let value = match typ with
278 | "true"|"t"|"yes"|"y"|"on"|"1" -> `bool_t true
279 | "false"|"f"|"no"|"n"|"off"|"0" -> `bool_t false
281 eprintf "whenjobs: variable does not have a boolean value\n";
284 | `String -> `string_t value
286 (try ignore (big_int_of_string value)
288 eprintf "whenjobs: variable is not an integer\n";
291 `int_t value (* the string is what we pass over the wire *)
293 (try `float_t (float_of_string value)
295 eprintf "whenjobs: variable is not a floating point number\n";
299 if value <> "" then (
300 eprintf "whenjobs: unit variables must be empty strings\n";
305 let client = start_client () in
306 (match Whenproto_clnt.When.V1.set_variable client (name, value) with
309 eprintf "whenjobs: set: %s\n" msg;
310 suggest_check_server_logs ();
315 and get_variable name =
316 let client = start_client () in
317 let value = Whenproto_clnt.When.V1.get_variable client name in
318 print_endline (string_of_variable value);
321 and list_variables () =
322 let client = start_client () in
323 let names = Whenproto_clnt.When.V1.get_variable_names client () in
326 let value = Whenproto_clnt.When.V1.get_variable client name in
327 printf "%s=%s\n" name (string_of_variable value)
331 and daemon_start () =
335 let client = start_client () in
336 (match Whenproto_clnt.When.V1.exit_daemon client () with
339 eprintf "whenjobs: daemon-stop: %s\n" msg;
340 suggest_check_server_logs ();
345 and daemon_restart () =
348 and daemon_status () =
351 and unused_error args op =
353 eprintf "whenjobs %s: unused parameters on the command line.\n" op;
358 and suggest_help () =
359 eprintf "Use 'whenjobs --help' for a summary of options or read whenjobs(1) man page.\n"
361 and suggest_check_server_logs () =
362 eprintf "Look at the server logs (/var/log/cron or /var/log/syslog usually) for\n";
363 eprintf "further information on why this daemon operation failed.\n"
365 and get_jobs_filename () =
366 sprintf "%s/jobs.ml" jobsdir
368 and create_tutorial file =
369 let chan = open_out file in
370 output_string chan Tutorial.tutorial;
373 and start_client () =
374 let addr = sprintf "%s/socket" jobsdir in
377 Whenproto_clnt.When.V1.create_client
378 (Rpc_client.Unix addr)
379 Rpc.Tcp (* not TCP, this is the same as SOCK_STREAM *)
381 | Unix_error ((ECONNREFUSED|ENOENT), _, _) ->
382 eprintf "whenjobs: error: the daemon ('whenjobsd') is not running\n";
383 eprintf "Use 'whenjobs --daemon-start' to start the daemon.\n";
385 | Unix_error (err, fn, _) ->
386 eprintf "whenjobs: %s: %s: %s\n" fn addr (error_message err);
390 and stop_client client =
391 Rpc_client.shut_down client
393 and string_of_variable = function
395 | `bool_t b -> string_of_bool b
397 | `int_t i -> i (* passed on the wire as a string *)
398 | `float_t f -> string_of_float f
403 (* Pretty print some of the exceptions that main can throw. *)
404 | Rpc.Rpc_server err ->
405 eprintf "whenjobs: rpc error: %s\n" (Rpc.string_of_server_error err);
406 suggest_check_server_logs ();
409 eprintf "whenjobs: error: %s\n" msg;
411 | Invalid_argument msg ->
412 eprintf "whenjobs: invalid argument: %s\n" msg;
415 eprintf "whenjobs: error: %s\n" (Printexc.to_string exn);