2 * ypp-commodities main program: argument parsing etc.
5 * This is part of ypp-sc-tools, a set of third-party tools for assisting
6 * players of Yohoho Puzzle Pirates.
8 * Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
24 * are used without permission. This program is not endorsed or
25 * sponsored by Three Rings.
30 void debug_flush(void) {
31 sysassert(!ferror(debug));
32 sysassert(!fflush(debug));
35 const char *get_vardir(void) { return "."; }
36 const char *get_libdir(void) { return "."; }
42 mf_readscreenshot= 00020,
46 mode_findwindow= 00001,
47 mode_screenshot= 00011,
49 mode_showcharset= 01000,
55 omk_unset, omk_upload, omk_str, omk_raw, omk_none
57 static enum outmodekind o_outmode_kind;
58 static const char *o_outmode_str= 0;
60 static enum mode o_mode= mode_all;
61 static char *o_screenshot_fn;
62 static const char *o_serv_pctb, *o_serv_dict_fetch, *o_serv_dict_submit;
64 const char *o_resolver= "./dictionary-manager";
65 FILE *screenshot_file;
66 const char *o_ocean, *o_pirate;
70 ff_charset_allowedit |
71 ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
73 static void vbadusage(const char *fmt, va_list) FMT(1,0) NORET;
74 static void vbadusage(const char *fmt, va_list al) {
75 fputs("bad usage: ",stderr);
76 vfprintf(stderr,fmt,al);
80 DEFINE_VWRAPPERF(static, badusage, NORET);
82 static void open_screenshot_file(const char *mode) {
83 screenshot_file= fopen(o_screenshot_fn, mode);
85 fatal("could not open screenshots file `%s': %s",
86 o_screenshot_fn, strerror(errno));
89 static void run_analysis(void) {
92 sysassert( tf= tmpfile() );
93 progress("running recognition...");
96 if (o_flags & ff_upload) {
98 fatal("Recognition successful, but refusing to upload partial data\n"
99 " (--single-page specified). Specify an output mode?");
102 sysassert( fseek(tf,0,SEEK_SET) == 0);
104 progress_log("processing results (--%s)...", o_outmode_str);
106 sysassert( (processor= fork()) != -1 );
109 sysassert( dup2(fileno(tf),0) ==0 );
110 EXECLP_HELPER("commod-results-processor", o_outmode_str, (char*)0);
113 waitpid_check_exitstatus(processor, "output processor/uploader", 0);
115 progress_log("all complete.");
118 static void rsync_core(const char *stem, const char *suffix,
122 progress("Updating dictionary %s...",stem);
124 sysassert( (fetcher= fork()) != -1 );
126 const char *rsync= getenv("YPPSC_PCTB_RSYNC");
127 if (!rsync) rsync= "rsync";
129 const char *src= getenv("YPPSC_PCTB_DICT_UPDATE");
130 char *remote= masprintf("%s/master-%s.txt%s", src, stem, suffix);
131 char *local= masprintf("_master-%s.txt%s", stem, suffix);
133 fprintf(stderr,"executing rsync to fetch %s to %s\n",remote,local);
134 char *opts= masprintf("-Lt%s%s",
136 DEBUGP(rsync) ? "v" : "");
137 execlp(rsync, "rsync",opts,"--",remote,local,(char*)0);
138 sysassert(!"exec rsync failed");
141 waitpid_check_exitstatus(fetcher, "rsync", 0);
144 void fetch_with_rsync_gz(const char *stem) { rsync_core(stem,".gz",""); }
145 void fetch_with_rsync(const char *stem) { rsync_core(stem,"","z"); }
147 static void set_server(const char *envname, const char *defprotocol,
148 const char *defvalue, const char *defvalue_test,
149 const char *userspecified,
153 if (!enable) { value= "0"; goto ok; }
156 value= userspecified;
157 else if ((value= getenv(envname)))
159 else if (o_flags & ff_testservers)
160 value= defvalue_test;
164 if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
165 /* absolute or relative pathname - or anyway, something with no hostname */
168 const char *colon= strchr(value, ':');
169 const char *slash= strchr(value, '/');
171 if (colon && (!slash || colon < slash))
172 /* colon before the first slash, if any */
173 /* rsync :: protocol specification - anyway, adding scheme:// won't help */
176 int vallen= strlen(value);
178 value= masprintf("%s%s%s", defprotocol, value,
179 vallen && value[vallen-1]=='/' ? "" : "/");
182 sysassert(! setenv(envname,value,1) );
185 int main(int argc, char **argv) {
188 sysassert( setlocale(LC_MESSAGES,"") );
189 sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
190 setlocale(LC_CTYPE,"en.UTF-8") );
192 #define ARGVAL ((*++argv) ? *argv : \
193 (badusage("missing value for option %s",arg),(char*)0))
195 #define IS(s) (!strcmp(arg,(s)))
197 while ((arg=*++argv)) {
198 if (IS("--find-window-only")) o_mode= mode_findwindow;
199 else if (IS("--screenshot-only")) o_mode= mode_screenshot;
200 else if (IS("--show-charset")) o_mode= mode_showcharset;
201 else if (IS("--analyse-only") ||
202 IS("--same")) o_mode= mode_analyse;
203 else if (IS("--everything")) o_mode= mode_all;
204 else if (IS("--find-island")) o_flags |= ffs_printisland;
205 else if (IS("--single-page")) o_flags |= ff_singlepage;
206 else if (IS("--quiet")) o_quiet= 1;
207 else if (IS("--edit-charset")) o_flags |= ff_charset_edit;
208 else if (IS("--no-edit-charset")) o_flags &= ~(ffm_charset);
209 else if (IS("--test-servers")) o_flags |= ff_testservers;
210 else if (IS("--dict-local-only")) o_flags &= ~ffs_dict;
211 else if (IS("--dict-read-only")) o_flags &= (~ffs_dict | ff_dict_fetch);
212 else if (IS("--dict-anon")) o_flags &= ~ff_dict_pirate;
213 else if (IS("--dict-submit")) o_flags |= ff_dict_fetch|ff_dict_submit;
214 else if (IS("--raw-tsv")) o_outmode_kind= omk_raw;
215 else if (IS("--upload")) o_outmode_kind= omk_upload;
216 else if (IS("--arbitrage") ||
218 IS("--best-prices")) o_outmode_kind=omk_str,
221 else if (IS("--screenshot-file")) o_screenshot_fn= ARGVAL;
222 else if (IS("--pctb-server")) o_serv_pctb= ARGVAL;
223 else if (IS("--dict-submit-server")) o_serv_dict_submit= ARGVAL;
224 else if (IS("--dict-update-server")) o_serv_dict_fetch= ARGVAL;
225 else if (IS("--ocean")) o_ocean= ARGVAL;
226 else if (IS("--pirate")) o_pirate= ARGVAL;
228 else if (IS("-D" #f)) \
229 debug_flags |= dbg_##f;
232 else if (IS("--window-id")) {
234 unsigned long windowid= strtoul(ARGVAL,&ep,0);
235 if (*ep) badusage("invalid window id");
236 set_yppclient_window(windowid);
238 badusage("unknown option `%s'",arg);
241 /* Consequential changes to options */
243 if (o_mode & mf_analyse) {
244 if (!o_outmode_kind) {
245 if (o_flags & ff_printisland) {
246 o_outmode_kind= omk_none;
247 o_flags |= ff_singlepage;
249 o_outmode_kind= omk_upload;
253 if (o_outmode_kind==omk_upload) {
254 o_flags |= ffs_upload;
255 o_outmode_str= "upload";
261 set_server("YPPSC_PCTB_PCTB",
262 "http://", "pctb.ilk.org" /*pctb.crabdance.com*/,
264 o_serv_pctb, o_flags & (ff_needisland|ff_upload));
266 set_server("YPPSC_PCTB_DICT_UPDATE",
267 "rsync://", "rsync.pctb.chiark.greenend.org.uk/pctb",
268 "rsync.pctb.chiark.greenend.org.uk/pctb/test",
269 o_serv_dict_fetch, o_flags & ff_dict_fetch);
271 set_server("YPPSC_PCTB_DICT_SUBMIT",
272 "http://", "dictup.pctb.chiark.greenend.org.uk",
273 "dictup.pctb.chiark.greenend.org.uk/test",
274 o_serv_dict_submit, o_flags & ff_dict_submit);
276 if (!o_screenshot_fn)
277 o_screenshot_fn= masprintf("%s/_pages.ppm",get_vardir());
279 /* Actually do the work */
281 canon_colour_prepare();
283 if (o_mode & mf_findwindow) {
284 screenshot_startup();
285 find_yppclient_window();
287 if (!ocean) ocean= o_ocean;
288 if (!pirate) pirate= o_pirate;
290 if (o_flags & ff_needisland)
292 badusage("need --ocean option when not using actual YPP client window"
293 " (consider supplying --pirate too)");
295 sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
296 if (pirate && (o_flags & ff_dict_pirate))
297 sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
299 switch (o_mode & mfm_special) {
301 case mode_showcharset: ocr_showcharsets(); exit(0);
305 if (o_mode & mf_screenshot) {
306 open_screenshot_file("w");
307 if (o_flags & ff_singlepage) take_one_screenshot();
308 else take_screenshots();
309 progress_log("OK for you to move the mouse now, and you can"
310 " use the YPP client again.");
312 if (o_mode & mf_readscreenshot) {
313 if ((o_flags & ff_upload) && !(o_flags & ff_testservers))
314 badusage("must not reuse screenshots for upload to live PCTB database");
315 open_screenshot_file("r");
316 if (o_flags & ff_singlepage) read_one_screenshot();
317 else read_screenshots();
319 if (o_mode & mf_analyse) {
320 if (o_flags & ff_needisland) {
322 if (o_flags & ff_printisland)
323 printf("%s, %s\n", archipelago, island);
324 sysassert(! setenv("YPPSC_ISLAND",island,1) );
326 switch (o_outmode_kind) {
327 case omk_upload: case omk_str: run_analysis(); break;
328 case omk_raw: analyse(stdout); break;
329 case omk_none: break;
333 progress_log("Finished.");
340 DEFINE_VWRAPPERF(, progress, )
341 DEFINE_VWRAPPERF(, progress_log, )
342 DEFINE_VWRAPPERF(, progress_spinner, )
343 DEFINE_VWRAPPERF(, warning, )
344 DEFINE_VWRAPPERF(, fatal, NORET)
346 static int last_progress_len;
348 static void vprogress_core(int spinner, const char *fmt, va_list al) {
352 if (!isatty(2)) return;
354 if (last_progress_len)
357 r= vfprintf(stderr,fmt,al);
360 putc(spinner,stderr);
364 if (r < last_progress_len) {
365 fprintf(stderr,"%*s", last_progress_len - r, "");
366 if (!r) putc('\r', stderr);
367 else while (last_progress_len-- > r) putc('\b',stderr);
369 last_progress_len= r;
371 if (ferror(stderr) || fflush(stderr)) _exit(16);
374 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
375 void vprogress_spinner(const char *fmt, va_list al) {
376 static const char spinchars[]="/-\\";
379 vprogress_core(spinchars[spinner],fmt,al);
381 spinner %= (sizeof(spinchars)-1);
384 void vprogress_log(const char *fmt, va_list al) {
388 vfprintf(stderr,fmt,al);
393 void vwarning(const char *fmt, va_list al) {
395 fputs("Warning: ",stderr);
396 vfprintf(stderr,fmt,al);
401 void vfatal(const char *fmt, va_list al) {
403 fputs("\n\nFatal error: ",stderr);
404 vfprintf(stderr,fmt,al);
406 fputs("\n\n",stderr);
410 void sysassert_fail(const char *file, int line, const char *what) {
414 "\nfatal operational error:\n"
415 " unsuccessful execution of: %s\n"
417 what, file,line, strerror(e));
421 void waitpid_check_exitstatus(pid_t pid, const char *what, int sigpipeok) {
425 got= waitpid(pid, &st, 0);
426 if (pid==-1) { sysassert(errno==EINTR); continue; }
429 sysassert( got==pid );
433 fatal("%s failed with nonzero exit status %d",
434 what, WEXITSTATUS(st));
435 } else if (WIFSIGNALED(st)) {
436 if (!sigpipeok || WTERMSIG(st) != SIGPIPE)
437 fatal("%s died due to signal %s%s", what,
438 strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
440 fatal("%s gave strange wait status %d", what, st);
444 char *masprintf(const char *fmt, ...) {
448 sysassert( vasprintf(&r,fmt,al) >= 0);