2 * yarrg 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 "."; }
40 omk_unset, omk_raw, omk_str, omk_upload_yarrg, omk_upload_pctb
44 enum outmodekind kind; /* unset is sentinel */
45 const char *str; /* non-0 iff not unset or raw */
48 static OutputMode o_outmodes[10];
50 static char *o_screenshot_fn;
51 static const char *o_serv_pctb, *o_serv_yarrg;
52 static const char *o_serv_dict_fetch, *o_serv_dict_submit;
54 const char *o_resolver= "./dictionary-manager";
55 FILE *screenshot_file;
56 const char *o_ocean, *o_pirate;
59 static pid_t screenshot_compressor=-1;
61 enum mode o_mode= mode_all;
63 ff_charset_allowedit |
64 ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
66 static void vbadusage(const char *fmt, va_list) FMT(1,0) NORET;
67 static void vbadusage(const char *fmt, va_list al) {
68 fputs("bad usage: ",stderr);
69 vfprintf(stderr,fmt,al);
73 DEFINE_VWRAPPERF(static, badusage, NORET);
75 static void open_screenshot_file(int for_write) {
76 if (!fnmatch("*.gz",o_screenshot_fn,0)) {
77 int mode= for_write ? O_WRONLY|O_CREAT|O_TRUNC : O_RDONLY;
78 sysassert(! gzopen(o_screenshot_fn, mode, &screenshot_file,
79 &screenshot_compressor, "-1") );
81 screenshot_file= fopen(o_screenshot_fn, for_write ? "w" : "r");
83 fatal("could not open screenshots file `%s': %s",
84 o_screenshot_fn, strerror(errno));
88 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 for (om=o_outmodes; om->kind != omk_unset; om++) {
103 sysassert( fseek(tf,0,SEEK_SET) == 0);
105 progress_log("processing results (--%s)...", om->str);
107 sysassert( (processor= fork()) != -1 );
110 sysassert( dup2(fileno(tf),0) ==0 );
111 if (om->kind==omk_raw) {
112 execlp("cat","cat",(char*)0);
113 sysassert(!"execute cat");
115 EXECLP_HELPER("commod-results-processor", om->str, (char*)0);
119 waitpid_check_exitstatus(processor, "output processor/uploader", 0);
123 progress_log("all complete.");
126 static void rsync_core(const char *stem, const char *suffix,
130 progress("Updating dictionary %s...",stem);
132 sysassert( (fetcher= fork()) != -1 );
134 const char *rsync= getenv("YPPSC_YARRG_RSYNC");
135 if (!rsync) rsync= "rsync";
137 const char *src= getenv("YPPSC_YARRG_DICT_UPDATE");
138 char *remote= masprintf("%s/master-%s.txt%s", src, stem, suffix);
139 char *local= masprintf("_master-%s.txt%s", stem, suffix);
141 fprintf(stderr,"executing rsync to fetch %s to %s\n",remote,local);
142 char *opts= masprintf("-Lt%s%s",
144 DEBUGP(rsync) ? "v" : "");
145 execlp(rsync, "rsync",opts,"--",remote,local,(char*)0);
146 sysassert(!"exec rsync failed");
149 waitpid_check_exitstatus(fetcher, "rsync", 0);
152 void fetch_with_rsync_gz(const char *stem) { rsync_core(stem,".gz",""); }
153 void fetch_with_rsync(const char *stem) { rsync_core(stem,"","z"); }
155 static void get_timestamp(void) {
158 sysassert( tf= tmpfile() );
160 sysassert( (child= fork()) != -1 );
162 sysassert( dup2(fileno(tf),1)==1 );
163 EXECLP_HELPER("database-info-fetch","timestamp",(char*)0);
165 waitpid_check_exitstatus(child,"timestamp request",0);
167 sysassert( fseek(tf,0,SEEK_SET) == 0 );
168 static char lbuf[30];
169 int l= fread(lbuf,1,sizeof(lbuf),tf);
170 sysassert( !ferror(tf) );
174 assert( lbuf[l]=='\n' );
177 sysassert(! setenv("YPPSC_DATA_TIMESTAMP",lbuf,1) );
181 static void set_server(const char *envname, const char *defprotocol,
182 const char *defvalue, const char *defvalue_test,
183 const char *userspecified,
187 if (!enable) { value= "0"; goto ok; }
190 value= userspecified;
191 else if ((value= getenv(envname)))
193 else if (o_flags & ff_testservers)
194 value= defvalue_test;
198 if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
199 /* absolute or relative pathname - or anyway, something with no hostname */
202 const char *colon= strchr(value, ':');
203 const char *slash= strchr(value, '/');
205 if (colon && (!slash || colon < slash))
206 /* colon before the first slash, if any */
207 /* rsync :: protocol specification - anyway, adding scheme:// won't help */
210 int vallen= strlen(value);
212 value= masprintf("%s%s%s", defprotocol, value,
213 vallen && value[vallen-1]=='/' ? "" : "/");
216 sysassert(! setenv(envname,value,1) );
219 static void outputmode(enum outmodekind kind, const char *str) {
220 OutputMode *om= o_outmodes;
221 OutputMode *sentinel= o_outmodes + ARRAYSIZE(o_outmodes) - 1;
223 if (om==sentinel) badusage("too many output modes specified");
224 if (!om->kind) break;
231 static void outputmode_uploads(void) {
232 outputmode(omk_upload_yarrg, "upload-yarrg");
233 outputmode(omk_upload_pctb, "upload-pctb");
236 int main(int argc, char **argv) {
239 sysassert( setlocale(LC_MESSAGES,"") );
240 sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
241 setlocale(LC_CTYPE,"en.UTF-8") );
243 #define ARGVAL ((*++argv) ? *argv : \
244 (badusage("missing value for option %s",arg),(char*)0))
246 #define IS(s) (!strcmp(arg,(s)))
248 while ((arg=*++argv)) {
249 if (IS("--find-window-only")) o_mode= mode_findwindow;
250 else if (IS("--screenshot-only")) o_mode= mode_screenshot;
251 else if (IS("--show-charset")) o_mode= mode_showcharset;
252 else if (IS("--analyse-only") ||
253 IS("--same")) o_mode= mode_analyse;
254 else if (IS("--everything")) o_mode= mode_all;
255 else if (IS("--find-island")) o_flags |= ffs_printisland;
256 else if (IS("--single-page")) o_flags |= ff_singlepage;
257 else if (IS("--quiet")) o_quiet= 1;
258 else if (IS("--edit-charset")) o_flags |= ff_charset_edit;
259 else if (IS("--no-edit-charset")) o_flags &= ~(ffm_charset);
260 else if (IS("--test-servers")) o_flags |= ff_testservers;
261 else if (IS("--dict-local-only")) o_flags &= ~ffs_dict;
262 else if (IS("--dict-read-only")) o_flags &= (~ffs_dict | ff_dict_fetch);
263 else if (IS("--dict-anon")) o_flags &= ~ff_dict_pirate;
264 else if (IS("--dict-submit")) o_flags |= ff_dict_fetch|ff_dict_submit;
265 else if (IS("--dict-no-update")) o_flags &= ~ff_dict_fetch; // testing
266 else if (IS("--raw-tsv")) outputmode(omk_raw,0);
267 else if (IS("--upload")) outputmode_uploads();
268 else if (IS("--upload-yarrg")) outputmode(omk_upload_yarrg,arg+2);
269 else if (IS("--upload-pctb")) outputmode(omk_upload_pctb,arg+2);
270 else if (IS("--arbitrage") ||
272 IS("--best-prices")) outputmode(omk_str,arg+2);
273 else if (IS("--screenshot-file")||
274 IS("--screenshots-file")) o_screenshot_fn= ARGVAL;
275 else if (IS("--yarrg-server")) o_serv_yarrg= ARGVAL;
276 else if (IS("--pctb-server")) o_serv_pctb= ARGVAL;
277 else if (IS("--dict-submit-server")) o_serv_dict_submit= ARGVAL;
278 else if (IS("--dict-update-server")) o_serv_dict_fetch= ARGVAL;
279 else if (IS("--ocean")) o_ocean= ARGVAL;
280 else if (IS("--pirate")) o_pirate= ARGVAL;
282 else if (IS("-D" #f)) \
283 debug_flags |= dbg_##f;
286 else if (IS("--window-id")) {
288 unsigned long windowid= strtoul(ARGVAL,&ep,0);
289 if (*ep) badusage("invalid window id");
290 set_yppclient_window(windowid);
292 badusage("unknown option `%s'",arg);
295 /* Consequential changes to options */
297 if (o_mode & mf_analyse) {
298 if (!o_outmodes[0].kind) {
299 if (o_flags & ff_printisland) {
300 o_flags |= ff_singlepage;
302 outputmode_uploads();
306 if (o_outmodes[0].kind)
307 badusage("overall mode does not include analysis but output option(s)"
308 " (eg `--%s') specified", o_outmodes[0].str);
312 for (om=o_outmodes; om->kind; om++) {
314 case omk_upload_yarrg: o_flags |= ffs_upload | ff_use_yarrg; break;
315 case omk_upload_pctb: o_flags |= ffs_upload | ff_use_pctb; break;
320 if ((o_flags & (ff_needisland|ff_upload)) &&
321 !(o_flags & (ffm_use)))
322 o_flags |= ffm_use; /* all */
324 if (o_serv_yarrg && !o_serv_dict_submit)
325 o_serv_dict_submit= o_serv_yarrg;
329 set_server("YPPSC_YARRG_YARRG",
330 "http://", "upload.yarrg.chiark.net",
331 "upload.yarrg.chiark.net/test",
332 o_serv_yarrg, o_flags & ff_use_yarrg);
334 set_server("YPPSC_YARRG_PCTB",
335 "http://", "pctb.ilk.org" /*pctb.crabdance.com*/,
337 o_serv_pctb, o_flags & ff_use_pctb);
339 set_server("YPPSC_YARRG_DICT_UPDATE",
340 "rsync://", "rsync.yarrg.chiark.net/yarrg",
341 "rsync.yarrg.chiark.net/yarrg/test",
342 o_serv_dict_fetch, o_flags & ff_dict_fetch);
344 set_server("YPPSC_YARRG_DICT_SUBMIT",
345 "http://", "upload.yarrg.chiark.net",
346 "upload.yarrg.chiark.net/test",
347 o_serv_dict_submit, o_flags & ff_dict_submit);
349 if (!o_screenshot_fn)
350 o_screenshot_fn= masprintf("%s/_pages.ppm.gz", get_vardir());
352 /* Actually do the work */
354 if ((o_flags & ff_upload) && (o_flags & ff_use_yarrg))
357 canon_colour_prepare();
359 if (o_mode & mf_findwindow) {
360 screenshot_startup();
361 find_yppclient_window();
363 if (!ocean) ocean= o_ocean;
364 if (!pirate) pirate= o_pirate;
366 if (o_flags & ff_needisland)
368 badusage("need --ocean option when not using actual YPP client window"
369 " (consider supplying --pirate too)");
371 sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
372 if (pirate && (o_flags & ff_dict_pirate))
373 sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
375 switch (o_mode & mfm_special) {
377 case mode_showcharset: ocr_showcharsets(); exit(0);
381 if (o_mode & mf_screenshot) {
382 open_screenshot_file(1);
383 if (o_flags & ff_singlepage) take_one_screenshot();
384 else take_screenshots();
385 progress_log("OK for you to move the mouse now, and you can"
386 " use the YPP client again.");
387 progress("Finishing handling screenshots...");
388 gzclose(&screenshot_file,&screenshot_compressor,"screenshots output");
390 if (o_mode & mf_readscreenshot) {
391 if ((o_flags & ff_upload) && !(o_flags & ff_testservers))
392 badusage("must not reuse screenshots for upload to live databases");
393 open_screenshot_file(0);
394 if (o_flags & ff_singlepage) read_one_screenshot();
395 else read_screenshots();
396 gzclose(&screenshot_file,&screenshot_compressor,"screenshots input");
398 if (o_mode & mf_analyse) {
399 if (o_flags & ff_needisland) {
401 if (o_flags & ff_printisland)
402 printf("%s, %s\n", archipelago, island);
403 sysassert(! setenv("YPPSC_ISLAND",island,1) );
405 if (o_outmodes[0].kind==omk_raw && o_outmodes[1].kind==omk_unset)
410 progress_log("Finished.");
417 DEFINE_VWRAPPERF(, progress, )
418 DEFINE_VWRAPPERF(, progress_log, )
419 DEFINE_VWRAPPERF(, progress_spinner, )
420 DEFINE_VWRAPPERF(, warning, )
421 DEFINE_VWRAPPERF(, fatal, NORET)
423 static int last_progress_len;
425 static void vprogress_core(int spinner, const char *fmt, va_list al) {
429 if (!debug_flags && !isatty(2)) return;
431 if (last_progress_len)
434 r= vfprintf(stderr,fmt,al);
437 putc(spinner,stderr);
441 if (r < last_progress_len) {
442 fprintf(stderr,"%*s", last_progress_len - r, "");
443 if (!r) putc('\r', stderr);
444 else while (last_progress_len-- > r) putc('\b',stderr);
446 last_progress_len= r;
448 if (ferror(stderr) || fflush(stderr)) _exit(16);
451 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
452 void vprogress_spinner(const char *fmt, va_list al) {
453 static const char spinchars[]="/-\\";
456 vprogress_core(spinchars[spinner],fmt,al);
458 spinner %= (sizeof(spinchars)-1);
461 void vprogress_log(const char *fmt, va_list al) {
465 vfprintf(stderr,fmt,al);
470 void vwarning(const char *fmt, va_list al) {
472 fputs("Warning: ",stderr);
473 vfprintf(stderr,fmt,al);
478 void vfatal(const char *fmt, va_list al) {
480 fputs("\n\nFatal error: ",stderr);
481 vfprintf(stderr,fmt,al);
483 fputs("\n\n",stderr);
487 void sysassert_fail(const char *file, int line, const char *what) {
491 "\nfatal operational error:\n"
492 " unsuccessful execution of: %s\n"
494 what, file,line, strerror(e));
498 void waitpid_check_exitstatus(pid_t pid, const char *what, int sigpipeok) {
502 got= waitpid(pid, &st, 0);
503 if (pid==-1) { sysassert(errno==EINTR); continue; }
506 sysassert( got==pid );
510 fatal("%s failed with nonzero exit status %d",
511 what, WEXITSTATUS(st));
512 } else if (WIFSIGNALED(st)) {
513 if (!sigpipeok || WTERMSIG(st) != SIGPIPE)
514 fatal("%s died due to signal %s%s", what,
515 strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
517 fatal("%s gave strange wait status %d", what, st);
521 char *masprintf(const char *fmt, ...) {
525 sysassert( vasprintf(&r,fmt,al) >= 0);