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;
69 static pid_t screenshot_compressor=-1;
72 ff_charset_allowedit |
73 ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
75 static void vbadusage(const char *fmt, va_list) FMT(1,0) NORET;
76 static void vbadusage(const char *fmt, va_list al) {
77 fputs("bad usage: ",stderr);
78 vfprintf(stderr,fmt,al);
82 DEFINE_VWRAPPERF(static, badusage, NORET);
84 static void open_screenshot_file(int for_write) {
85 if (!fnmatch("*.gz",o_screenshot_fn,0)) {
86 int mode= for_write ? O_WRONLY|O_CREAT|O_TRUNC : O_RDONLY;
87 sysassert(! gzopen(o_screenshot_fn, mode, &screenshot_file,
88 &screenshot_compressor, "-1") );
90 screenshot_file= fopen(o_screenshot_fn, for_write ? "w" : "r");
92 fatal("could not open screenshots file `%s': %s",
93 o_screenshot_fn, strerror(errno));
97 static void run_analysis(void) {
100 sysassert( tf= tmpfile() );
101 progress("running recognition...");
104 if (o_flags & ff_upload) {
106 fatal("Recognition successful, but refusing to upload partial data\n"
107 " (--single-page specified). Specify an output mode?");
110 sysassert( fseek(tf,0,SEEK_SET) == 0);
112 progress_log("processing results (--%s)...", o_outmode_str);
114 sysassert( (processor= fork()) != -1 );
117 sysassert( dup2(fileno(tf),0) ==0 );
118 EXECLP_HELPER("commod-results-processor", o_outmode_str, (char*)0);
121 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_PCTB_RSYNC");
135 if (!rsync) rsync= "rsync";
137 const char *src= getenv("YPPSC_PCTB_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 set_server(const char *envname, const char *defprotocol,
156 const char *defvalue, const char *defvalue_test,
157 const char *userspecified,
161 if (!enable) { value= "0"; goto ok; }
164 value= userspecified;
165 else if ((value= getenv(envname)))
167 else if (o_flags & ff_testservers)
168 value= defvalue_test;
172 if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
173 /* absolute or relative pathname - or anyway, something with no hostname */
176 const char *colon= strchr(value, ':');
177 const char *slash= strchr(value, '/');
179 if (colon && (!slash || colon < slash))
180 /* colon before the first slash, if any */
181 /* rsync :: protocol specification - anyway, adding scheme:// won't help */
184 int vallen= strlen(value);
186 value= masprintf("%s%s%s", defprotocol, value,
187 vallen && value[vallen-1]=='/' ? "" : "/");
190 sysassert(! setenv(envname,value,1) );
193 int main(int argc, char **argv) {
196 sysassert( setlocale(LC_MESSAGES,"") );
197 sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
198 setlocale(LC_CTYPE,"en.UTF-8") );
200 #define ARGVAL ((*++argv) ? *argv : \
201 (badusage("missing value for option %s",arg),(char*)0))
203 #define IS(s) (!strcmp(arg,(s)))
205 while ((arg=*++argv)) {
206 if (IS("--find-window-only")) o_mode= mode_findwindow;
207 else if (IS("--screenshot-only")) o_mode= mode_screenshot;
208 else if (IS("--show-charset")) o_mode= mode_showcharset;
209 else if (IS("--analyse-only") ||
210 IS("--same")) o_mode= mode_analyse;
211 else if (IS("--everything")) o_mode= mode_all;
212 else if (IS("--find-island")) o_flags |= ffs_printisland;
213 else if (IS("--single-page")) o_flags |= ff_singlepage;
214 else if (IS("--quiet")) o_quiet= 1;
215 else if (IS("--edit-charset")) o_flags |= ff_charset_edit;
216 else if (IS("--no-edit-charset")) o_flags &= ~(ffm_charset);
217 else if (IS("--test-servers")) o_flags |= ff_testservers;
218 else if (IS("--dict-local-only")) o_flags &= ~ffs_dict;
219 else if (IS("--dict-read-only")) o_flags &= (~ffs_dict | ff_dict_fetch);
220 else if (IS("--dict-anon")) o_flags &= ~ff_dict_pirate;
221 else if (IS("--dict-submit")) o_flags |= ff_dict_fetch|ff_dict_submit;
222 else if (IS("--raw-tsv")) o_outmode_kind= omk_raw;
223 else if (IS("--upload")) o_outmode_kind= omk_upload;
224 else if (IS("--arbitrage") ||
226 IS("--best-prices")) o_outmode_kind=omk_str,
229 else if (IS("--screenshot-file")||
230 IS("--screenshots-file")) o_screenshot_fn= ARGVAL;
231 else if (IS("--pctb-server")) o_serv_pctb= ARGVAL;
232 else if (IS("--dict-submit-server")) o_serv_dict_submit= ARGVAL;
233 else if (IS("--dict-update-server")) o_serv_dict_fetch= ARGVAL;
234 else if (IS("--ocean")) o_ocean= ARGVAL;
235 else if (IS("--pirate")) o_pirate= ARGVAL;
237 else if (IS("-D" #f)) \
238 debug_flags |= dbg_##f;
241 else if (IS("--window-id")) {
243 unsigned long windowid= strtoul(ARGVAL,&ep,0);
244 if (*ep) badusage("invalid window id");
245 set_yppclient_window(windowid);
247 badusage("unknown option `%s'",arg);
250 /* Consequential changes to options */
252 if (o_mode & mf_analyse) {
253 if (!o_outmode_kind) {
254 if (o_flags & ff_printisland) {
255 o_outmode_kind= omk_none;
256 o_flags |= ff_singlepage;
258 o_outmode_kind= omk_upload;
262 if (o_outmode_kind==omk_upload) {
263 o_flags |= ffs_upload;
264 o_outmode_str= "upload";
270 set_server("YPPSC_PCTB_PCTB",
271 "http://", "pctb.ilk.org" /*pctb.crabdance.com*/,
273 o_serv_pctb, o_flags & (ff_needisland|ff_upload));
275 set_server("YPPSC_PCTB_DICT_UPDATE",
276 "rsync://", "rsync.pctb.chiark.greenend.org.uk/pctb",
277 "rsync.pctb.chiark.greenend.org.uk/pctb/test",
278 o_serv_dict_fetch, o_flags & ff_dict_fetch);
280 set_server("YPPSC_PCTB_DICT_SUBMIT",
281 "http://", "dictup.pctb.chiark.greenend.org.uk",
282 "dictup.pctb.chiark.greenend.org.uk/test",
283 o_serv_dict_submit, o_flags & ff_dict_submit);
285 if (!o_screenshot_fn)
286 o_screenshot_fn= masprintf("%s/_pages.ppm.gz", get_vardir());
288 /* Actually do the work */
290 canon_colour_prepare();
292 if (o_mode & mf_findwindow) {
293 screenshot_startup();
294 find_yppclient_window();
296 if (!ocean) ocean= o_ocean;
297 if (!pirate) pirate= o_pirate;
299 if (o_flags & ff_needisland)
301 badusage("need --ocean option when not using actual YPP client window"
302 " (consider supplying --pirate too)");
304 sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
305 if (pirate && (o_flags & ff_dict_pirate))
306 sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
308 switch (o_mode & mfm_special) {
310 case mode_showcharset: ocr_showcharsets(); exit(0);
314 if (o_mode & mf_screenshot) {
315 open_screenshot_file(1);
316 if (o_flags & ff_singlepage) take_one_screenshot();
317 else take_screenshots();
318 progress_log("OK for you to move the mouse now, and you can"
319 " use the YPP client again.");
320 progress("Finishing handling screenshots...");
321 gzclose(&screenshot_file,&screenshot_compressor,"screenshots output");
323 if (o_mode & mf_readscreenshot) {
324 if ((o_flags & ff_upload) && !(o_flags & ff_testservers))
325 badusage("must not reuse screenshots for upload to live PCTB database");
326 open_screenshot_file(0);
327 if (o_flags & ff_singlepage) read_one_screenshot();
328 else read_screenshots();
329 gzclose(&screenshot_file,&screenshot_compressor,"screenshots input");
331 if (o_mode & mf_analyse) {
332 if (o_flags & ff_needisland) {
334 if (o_flags & ff_printisland)
335 printf("%s, %s\n", archipelago, island);
336 sysassert(! setenv("YPPSC_ISLAND",island,1) );
338 switch (o_outmode_kind) {
339 case omk_upload: case omk_str: run_analysis(); break;
340 case omk_raw: analyse(stdout); break;
341 case omk_none: break;
345 progress_log("Finished.");
352 DEFINE_VWRAPPERF(, progress, )
353 DEFINE_VWRAPPERF(, progress_log, )
354 DEFINE_VWRAPPERF(, progress_spinner, )
355 DEFINE_VWRAPPERF(, warning, )
356 DEFINE_VWRAPPERF(, fatal, NORET)
358 static int last_progress_len;
360 static void vprogress_core(int spinner, const char *fmt, va_list al) {
364 if (!debug_flags && !isatty(2)) return;
366 if (last_progress_len)
369 r= vfprintf(stderr,fmt,al);
372 putc(spinner,stderr);
376 if (r < last_progress_len) {
377 fprintf(stderr,"%*s", last_progress_len - r, "");
378 if (!r) putc('\r', stderr);
379 else while (last_progress_len-- > r) putc('\b',stderr);
381 last_progress_len= r;
383 if (ferror(stderr) || fflush(stderr)) _exit(16);
386 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
387 void vprogress_spinner(const char *fmt, va_list al) {
388 static const char spinchars[]="/-\\";
391 vprogress_core(spinchars[spinner],fmt,al);
393 spinner %= (sizeof(spinchars)-1);
396 void vprogress_log(const char *fmt, va_list al) {
400 vfprintf(stderr,fmt,al);
405 void vwarning(const char *fmt, va_list al) {
407 fputs("Warning: ",stderr);
408 vfprintf(stderr,fmt,al);
413 void vfatal(const char *fmt, va_list al) {
415 fputs("\n\nFatal error: ",stderr);
416 vfprintf(stderr,fmt,al);
418 fputs("\n\n",stderr);
422 void sysassert_fail(const char *file, int line, const char *what) {
426 "\nfatal operational error:\n"
427 " unsuccessful execution of: %s\n"
429 what, file,line, strerror(e));
433 void waitpid_check_exitstatus(pid_t pid, const char *what, int sigpipeok) {
437 got= waitpid(pid, &st, 0);
438 if (pid==-1) { sysassert(errno==EINTR); continue; }
441 sysassert( got==pid );
445 fatal("%s failed with nonzero exit status %d",
446 what, WEXITSTATUS(st));
447 } else if (WIFSIGNALED(st)) {
448 if (!sigpipeok || WTERMSIG(st) != SIGPIPE)
449 fatal("%s died due to signal %s%s", what,
450 strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
452 fatal("%s gave strange wait status %d", what, st);
456 char *masprintf(const char *fmt, ...) {
460 sysassert( vasprintf(&r,fmt,al) >= 0);