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.
25 (* Ensures that Whentools module is linked to the whenjobs tool. *)
26 let _ = Whentools.set_variable
28 let libdir = ref Libdir.libdir
31 (* Running the program as root is a mistake. It must be run as a
34 let euid = geteuid () in
36 eprintf "whenjobs: this program must not be run as root\n";
40 (* $HOME must be defined and must exist and be a directory and must be
41 * owned by the current user.
46 eprintf "whenjobs: $HOME environment variable must be defined\n";
51 with Unix_error (err, fn, _) ->
52 eprintf "whenjobs: %s: %s ($HOME): %s\n" fn home (error_message err);
54 if stat.st_kind != S_DIR then (
55 eprintf "whenjobs: %s ($HOME): not a directory\n" home;
59 if stat.st_uid != euid then (
60 eprintf "whenjobs: %s ($HOME): not owned by the current user (uid %d)\n"
65 (* Make the $HOME/.whenjobs directory if it doesn't exist. *)
66 let jobsdir = sprintf "%s/.whenjobs" home in
67 (try mkdir jobsdir 0o700 with Unix_error _ -> ());
72 (* Parse the command line arguments. *)
73 let mode = ref None in
74 let typ = ref `String in
76 let set_mode m () = mode := Some m in
81 | "bool"|"boolean" -> `Bool
84 | "float"|"double" -> `Float
87 eprintf "whenjobs: --type: unknown type (%s)\n" t;
91 let display_version () =
92 printf "%s %s\n" Config.package_name Config.package_version;
96 let argspec = Arg.align [
97 "--cancel", Arg.Unit (set_mode `Cancel), " Cancel a job";
98 "--daemon-start", Arg.Unit (set_mode `Daemon_start), " Start the daemon";
99 "--daemon-status", Arg.Unit (set_mode `Daemon_status), " Display the status of the daemon";
100 "--daemon-stop", Arg.Unit (set_mode `Daemon_stop), " Stop the daemon";
101 "--daemon-restart", Arg.Unit (set_mode `Daemon_restart), " Restart the daemon";
102 "-e", Arg.Unit (set_mode `Edit), " Edit and upload the script";
103 "--edit", Arg.Unit (set_mode `Edit), " Edit and upload the script";
104 "--get", Arg.Unit (set_mode `Get), "var Display the variable";
105 "--job-names", Arg.Unit (set_mode `JobNames), " List names of loaded jobs";
106 "--jobs", Arg.Unit (set_mode `Jobs), " List running jobs";
107 "-l", Arg.Unit (set_mode `List), " List the script";
108 "--list", Arg.Unit (set_mode `List), " List the script";
109 "--lib", Arg.Set_string libdir, "dir Specify directory that contains pa_when.cmo";
110 "--set", Arg.Unit (set_mode `Set), " Set the variable";
111 "--start", Arg.Unit (set_mode `Start), "name Start a job manually";
112 "--tail", Arg.Unit (set_mode `Tail), "serial Tail job output";
113 "--test", Arg.Unit (set_mode `Test), " Test the effect of setting variables";
114 "--type", Arg.String set_type, "bool|int|float|string|.. Set the variable type";
115 "--upload", Arg.Unit (set_mode `Upload), " Upload the script";
116 "--variables", Arg.Unit (set_mode `Variables), " Display all variables and values";
117 "-V", Arg.Unit display_version, " Display version number and exit";
118 "--version", Arg.Unit display_version, " Display version number and exit";
121 (* anon_fun normally just collects up the anonymous arguments as
122 * strings, and most modes just use 'args' as a list of strings.
123 * However for `Set and `Test modes we need to record the type of
124 * each argument as well, so we keep that in a separate list
127 let argtypes = ref [] in
128 let anon_fun str = argtypes := (str, !typ) :: !argtypes in
131 Whenjobs is a powerful but simple cron replacement.
132 Whenjobs copyright (C) 2012 Red Hat Inc.
139 Get and set variables:
141 whenjobs --get variable
142 whenjobs --set variable=value
144 Start and stop the per-user daemon:
146 whenjobs --daemon-start | --daemon-stop | --daemon-status
148 For documentation see the whenjobs(1) man page.
153 Arg.parse argspec anon_fun usage_msg;
156 let argtypes = List.rev !argtypes in
157 let args = List.map fst argtypes in
158 let nr_args = List.length args in
159 let arg1 = match args with [] -> "" | a::_ -> a in
161 (* Depending on the selected mode, perform a different action. *)
164 eprintf "whenjobs: no operation selected.\n";
169 unused_error args "-e";
173 unused_error args "-l";
177 unused_error args "--upload";
181 if nr_args = 2 && not (String.contains arg1 '=') then (
182 eprintf "'whenjobs --set variable value' is the old whenjobs <= 0.5 syntax!\n";
183 eprintf "You need to change this to:\n";
184 eprintf " whenjobs --set variable=value\n";
188 (* Just ignore the case where no variables are defined, to make
189 * it easier to write shell scripts.
192 set_variables argtypes
196 test_variables argtypes
199 if nr_args != 1 then (
200 eprintf "whenjobs --get variable\n";
207 unused_error args "--variables";
210 | Some `Daemon_start ->
211 unused_error args "--daemon-start";
214 | Some `Daemon_stop ->
215 unused_error args "--daemon-stop";
218 | Some `Daemon_restart ->
219 unused_error args "--daemon-restart";
222 | Some `Daemon_status ->
223 unused_error args "--daemon-status";
227 unused_error args "--jobs";
231 if nr_args != 1 then (
232 eprintf "whenjobs --cancel serial\n";
239 if nr_args != 1 then (
240 eprintf "whenjobs --start jobname\n";
241 eprintf "If 'value' contains spaces, you may need to quote it.\n";
248 if nr_args != 1 then (
249 eprintf "whenjobs --tail serial\n";
256 unused_error args "--job-names";
260 (* If there is no initial file, create an empty one containing the
263 let file = get_jobs_filename () in
264 if not (Sys.file_exists file) then
265 create_tutorial file;
267 (* Is $EDITOR set? If not, use a default. *)
268 let editor = try getenv "EDITOR" with Not_found -> "vi" in
270 (* Get the (size, MD5) of the file to tell if it changed. *)
272 try (lstat file).st_size, Digest.file file
273 with Unix_error (err, fn, _) ->
274 eprintf "whenjobs: %s: %s: %s\n" fn file (error_message err);
277 let old_stamp = file_stamp () in
279 let cmd = sprintf "%s %s" editor file in
280 if Sys.command cmd != 0 then (
281 eprintf "whenjobs: error editing file (is $EDITOR set correctly?)\n";
285 let new_stamp = file_stamp () in
287 if old_stamp <> new_stamp then
291 let file = get_jobs_filename () in
292 if not (Sys.file_exists file) then (
293 eprintf "whenjobs: there is no jobs file, use 'whenjobs -e' to create one\n";
296 let chan = open_in file in
298 printf "%s\n" (input_line chan);
301 (try loop () with End_of_file -> ());
305 (* Recompile the jobs file. *)
306 let file = get_jobs_filename () in
307 let cmo_file = sprintf "%s/jobs.cmo" jobsdir in
308 let cmd = sprintf "ocamlfind ocamlc -I +camlp4 -I %s -package unix,camlp4.lib -pp 'camlp4o %s/pa_when.cmo' -c %s -o %s"
309 !libdir !libdir file cmo_file in
310 if Sys.command cmd <> 0 then (
311 eprintf "whenjobs: could not compile jobs script, see earlier error messages\n";
312 eprintf "compile command was:\n%s\n" cmd;
316 (* Test-load the jobs file to ensure it makes sense. *)
317 Whenfile.init Whenstate.empty;
319 Dynlink.loadfile cmo_file
322 eprintf "whenjobs: %s\n" (Dynlink.error_message err);
323 (* Since it failed, unlink it. *)
324 (try unlink cmo_file with Unix_error _ -> ());
328 (* OK now let's tell the daemon to reload it. *)
329 let client = start_client () in
330 (match Whenproto_clnt.When.V1.reload_file client () with
333 eprintf "whenjobs: reload: %s\n" msg;
334 suggest_check_server_logs ();
339 and set_variables argtypes =
340 let vars = List.map (
342 (* 'def' should have the form "name=value". The value part may
343 * be missing, but the equals sign is required.
346 try String.index def '='
348 eprintf "whenjobs: set: missing = sign in variable definition\n";
351 let name = String.sub def 0 i in
352 let value = String.sub def (i+1) (String.length def - (i+1)) in
353 let value = value_of_string value typ in
354 { Whenproto_aux.sv_name = name; sv_value = value }
356 let vars = Array.of_list vars in
358 let client = start_client () in
359 (match Whenproto_clnt.When.V1.set_variables client vars with
362 eprintf "whenjobs: set: %s\n" msg;
363 suggest_check_server_logs ();
368 and test_variables argtypes =
369 let vars = List.map (
371 (* 'def' should have the form "name=value". The value part may
372 * be missing, but the equals sign is required.
375 try String.index def '='
377 eprintf "whenjobs: set: missing = sign in variable definition\n";
380 let name = String.sub def 0 i in
381 let value = String.sub def (i+1) (String.length def - (i+1)) in
382 let value = value_of_string value typ in
383 { Whenproto_aux.sv_name = name; sv_value = value }
385 let vars = Array.of_list vars in
387 let client = start_client () in
388 let jobnames = Whenproto_clnt.When.V1.test_variables client vars in
391 Array.iter print_endline jobnames
393 and get_variable name =
394 let client = start_client () in
395 let value = Whenproto_clnt.When.V1.get_variable client name in
396 print_endline (string_of_variable value);
399 and list_variables () =
400 let client = start_client () in
401 let names = Whenproto_clnt.When.V1.get_variable_names client () in
404 let value = Whenproto_clnt.When.V1.get_variable client name in
405 printf "%s=%s\n" name (string_of_variable value)
409 and daemon_start () =
413 let client = start_client () in
414 (match Whenproto_clnt.When.V1.exit_daemon client () with
417 eprintf "whenjobs: daemon-stop: %s\n" msg;
418 suggest_check_server_logs ();
423 and daemon_restart () =
426 and daemon_status () =
430 let client = start_client () in
431 let jobs = Whenproto_clnt.When.V1.get_jobs client () in
434 let cmp { Whenproto_aux.job_name = name1; job_serial = serial1 }
435 { Whenproto_aux.job_name = name2; job_serial = serial2 } =
436 let i = compare name1 name2 in
439 compare_big_int (big_int_of_string serial1) (big_int_of_string serial2)
444 fun { Whenproto_aux.job_serial = serial; job_name = name;
445 job_tmpdir = tmpdir; job_start_time = time } ->
446 printf "%s %s\n\trunning in: %s\n\tstarted at: %s\n"
448 (string_of_time_t ~localtime:true (Int64.to_float time))
451 and cancel_job serial =
452 let client = start_client () in
453 (match Whenproto_clnt.When.V1.cancel_job client serial with
456 eprintf "whenjobs: cancel-job: %s\n" msg;
457 suggest_check_server_logs ();
463 let client = start_client () in
464 (match Whenproto_clnt.When.V1.start_job client name with
467 eprintf "whenjobs: start-job: %s\n" msg;
468 suggest_check_server_logs ();
473 (* This only works for local. If we ever make whenjobs work
474 * remotely we'll have to change the implementation to use
478 let client = start_client () in
479 let job = Whenproto_clnt.When.V1.get_job client serial in
482 sprintf "tail -f %s/output.txt"
483 (Filename.quote job.Whenproto_aux.job_tmpdir) in
484 exit (Sys.command cmd)
487 let client = start_client () in
488 let names = Whenproto_clnt.When.V1.get_job_names client () in
490 Array.iter print_endline names
492 and unused_error args op =
494 eprintf "whenjobs %s: unused parameters on the command line.\n" op;
499 and suggest_help () =
500 eprintf "Use 'whenjobs --help' for a summary of options or read whenjobs(1) man page.\n"
502 and suggest_check_server_logs () =
503 eprintf "Look at the server logs (/var/log/cron or /var/log/syslog usually) for\n";
504 eprintf "further information on why this daemon operation failed.\n"
506 and get_jobs_filename () =
507 sprintf "%s/jobs.ml" jobsdir
509 and create_tutorial file =
510 let chan = open_out file in
511 output_string chan Tutorial.tutorial;
514 and start_client () =
515 let addr = sprintf "%s/socket" jobsdir in
518 Whenproto_clnt.When.V1.create_client
519 (Rpc_client.Unix addr)
520 Rpc.Tcp (* not TCP, this is the same as SOCK_STREAM *)
522 | Unix_error ((ECONNREFUSED|ENOENT), _, _) ->
523 eprintf "whenjobs: error: the daemon ('whenjobsd') is not running\n";
524 eprintf "Use 'whenjobs --daemon-start' to start the daemon.\n";
526 | Unix_error (err, fn, _) ->
527 eprintf "whenjobs: %s: %s: %s\n" fn addr (error_message err);
531 and stop_client client =
532 Rpc_client.shut_down client
534 and string_of_variable = function
536 | `bool_t b -> string_of_bool b
538 | `int_t i -> i (* passed on the wire as a string *)
539 | `float_t f -> string_of_float f
541 and value_of_string value = function
544 | "true"|"t"|"yes"|"y"|"on"|"1" -> `bool_t true
545 | "false"|"f"|"no"|"n"|"off"|"0" -> `bool_t false
547 eprintf "whenjobs: variable does not have a boolean value\n";
550 | `String -> `string_t value
552 (try ignore (big_int_of_string value)
554 eprintf "whenjobs: variable is not an integer\n";
557 `int_t value (* the string is what we pass over the wire *)
559 (try `float_t (float_of_string value)
561 eprintf "whenjobs: variable is not a floating point number\n";
565 if value <> "" then (
566 eprintf "whenjobs: unit variables must be empty strings\n";
574 (* Pretty print some of the exceptions that main can throw. *)
575 | Rpc.Rpc_server err ->
576 eprintf "whenjobs: rpc error: %s\n" (Rpc.string_of_server_error err);
577 suggest_check_server_logs ();
580 eprintf "whenjobs: error: %s\n" msg;
582 | Invalid_argument msg ->
583 eprintf "whenjobs: invalid argument: %s\n" msg;
586 eprintf "whenjobs: error: %s\n" (Printexc.to_string exn);