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 enum flags o_flags= ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
71 static void vbadusage(const char *fmt, va_list) FMT(1,0) NORET;
72 static void vbadusage(const char *fmt, va_list al) {
73 fputs("bad usage: ",stderr);
74 vfprintf(stderr,fmt,al);
78 DEFINE_VWRAPPERF(static, badusage, NORET);
80 static void open_screenshot_file(const char *mode) {
81 screenshot_file= fopen(o_screenshot_fn, mode);
83 fatal("could not open screenshots file `%s': %s",
84 o_screenshot_fn, strerror(errno));
87 static void run_analysis(void) {
90 sysassert( tf= tmpfile() );
91 progress("running recognition...");
94 if (o_flags & ff_upload) {
96 fatal("Recognition successful, but refusing to upload partial data\n"
97 " (--single-page specified). Specify an output mode?");
100 sysassert( fseek(tf,0,SEEK_SET) == 0);
102 progress_log("processing results (--%s)...", o_outmode_str);
104 sysassert( (processor= fork()) != -1 );
107 sysassert( dup2(fileno(tf),0) ==0 );
108 EXECLP_HELPER("commod-results-processor", o_outmode_str, (char*)0);
111 waitpid_check_exitstatus(processor, "output processor/uploader");
113 progress_log("all complete.");
116 void fetch_with_rsync(const char *stem) {
119 sysassert( (fetcher= fork()) != -1 );
121 const char *rsync= getenv("YPPSC_PCTB_RSYNC");
122 if (!rsync) rsync= "rsync";
124 const char *src= getenv("YPPSC_PCTB_DICT_UPDATE");
125 char *remote= masprintf("%s/master-%s.txt", src, stem);
126 char *local= masprintf("#master-%s#.txt", stem);
128 fprintf(stderr,"executing rsync to fetch %s to %s\n",remote,local);
129 execlp(rsync, "rsync",
130 DEBUGP(rsync) ? "-zvLt" : "-zLt",
131 "--",remote,local,(char*)0);
132 sysassert(!"exec rsync failed");
135 waitpid_check_exitstatus(fetcher, "rsync");
138 static void set_server(const char *envname, const char *defprotocol,
139 const char *defvalue, const char *defvalue_test,
140 const char *userspecified,
144 if (!enable) { value= "0"; goto ok; }
147 value= userspecified;
148 else if ((value= getenv(envname)))
150 else if (o_flags & ff_testservers)
151 value= defvalue_test;
155 if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
156 /* absolute or relative pathname - or anyway, something with no hostname */
159 const char *colon= strchr(value, ':');
160 const char *slash= strchr(value, '/');
162 if (colon && (!slash || colon < slash))
163 /* colon before the first slash, if any */
164 /* rsync :: protocol specification - anyway, adding scheme:// won't help */
167 int vallen= strlen(value);
169 value= masprintf("%s%s%s", defprotocol, value,
170 vallen && value[vallen-1]=='/' ? "" : "/");
173 sysassert(! setenv(envname,value,1) );
176 int main(int argc, char **argv) {
179 sysassert( setlocale(LC_MESSAGES,"") );
180 sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
181 setlocale(LC_CTYPE,"en.UTF-8") );
183 #define ARGVAL ((*++argv) ? *argv : \
184 (badusage("missing value for option %s",arg),(char*)0))
186 #define IS(s) (!strcmp(arg,(s)))
188 while ((arg=*++argv)) {
189 if (IS("--find-window-only")) o_mode= mode_findwindow;
190 else if (IS("--screenshot-only")) o_mode= mode_screenshot;
191 else if (IS("--show-charset")) o_mode= mode_showcharset;
192 else if (IS("--analyse-only") ||
193 IS("--same")) o_mode= mode_analyse;
194 else if (IS("--everything")) o_mode= mode_all;
195 else if (IS("--find-island")) o_flags |= ffs_printisland;
196 else if (IS("--single-page")) o_flags |= ff_singlepage;
197 else if (IS("--quiet")) o_quiet= 1;
198 else if (IS("--edit-charset")) o_flags |= ff_charset_edit;
199 else if (IS("--no-edit-charset")) o_flags &= ~(ffm_charset);
200 else if (IS("--test-servers")) o_flags |= ff_testservers;
201 else if (IS("--dict-local-only")) o_flags &= ~ffs_dict;
202 else if (IS("--dict-read-only")) o_flags &= (~ffs_dict | ff_dict_fetch);
203 else if (IS("--dict-anon")) o_flags &= ~ff_dict_pirate;
204 else if (IS("--dict-submit")) o_flags |= ff_dict_fetch|ff_dict_submit;
205 else if (IS("--raw-tsv")) o_outmode_kind= omk_raw;
206 else if (IS("--upload")) o_outmode_kind= omk_upload;
207 else if (IS("--arbitrage") ||
209 IS("--best-prices")) o_outmode_kind=omk_str,
212 else if (IS("--screenshot-file")) o_screenshot_fn= ARGVAL;
213 else if (IS("--pctb-server")) o_serv_pctb= ARGVAL;
214 else if (IS("--dict-submit-server")) o_serv_dict_submit= ARGVAL;
215 else if (IS("--dict-update-server")) o_serv_dict_fetch= ARGVAL;
216 else if (IS("--ocean")) o_ocean= ARGVAL;
217 else if (IS("--pirate")) o_pirate= ARGVAL;
219 else if (IS("-D" #f)) \
220 debug_flags |= dbg_##f;
223 else if (IS("--window-id")) {
225 unsigned long windowid= strtoul(ARGVAL,&ep,0);
226 if (*ep) badusage("invalid window id");
227 set_yppclient_window(windowid);
229 badusage("unknown option `%s'",arg);
232 /* Consequential changes to options */
234 if (o_mode & mf_analyse) {
235 if (!o_outmode_kind) {
236 if (o_flags & ff_printisland) {
237 o_outmode_kind= omk_none;
238 o_flags |= ff_singlepage;
240 o_outmode_kind= omk_upload;
244 if (o_outmode_kind==omk_upload) {
245 o_flags |= ffs_upload;
246 o_outmode_str= "upload";
252 set_server("YPPSC_PCTB_PCTB",
253 "http://", "pctb.ilk.org" /*pctb.crabdance.com*/,
255 o_serv_pctb, o_flags & (ff_needisland|ff_upload));
257 set_server("YPPSC_PCTB_DICT_UPDATE",
258 "rsync://", "rsync.pctb.chiark.greenend.org.uk/pctb",
259 "rsync.pctb.chiark.greenend.org.uk/pctb/test",
260 o_serv_dict_fetch, o_flags & ff_dict_fetch);
262 set_server("YPPSC_PCTB_DICT_SUBMIT",
263 "http://", "dictup.pctb.chiark.greenend.org.uk",
264 "dictup.pctb.chiark.greenend.org.uk/test",
265 o_serv_dict_submit, o_flags & ff_dict_submit);
267 if (!o_screenshot_fn)
268 o_screenshot_fn= masprintf("%s/#pages#.ppm",get_vardir());
270 /* Actually do the work */
272 if (o_mode & mf_findwindow) {
273 screenshot_startup();
274 find_yppclient_window();
276 if (!ocean) ocean= o_ocean;
277 if (!pirate) pirate= o_pirate;
279 if (o_flags & ff_needisland)
281 badusage("need --ocean option when not using actual YPP client window"
282 " (consider supplying --pirate too)");
284 sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
285 if (pirate && (o_flags & ff_dict_pirate))
286 sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
288 switch (o_mode & mfm_special) {
290 case mode_showcharset: ocr_showcharsets(); exit(0);
294 if (o_mode & mf_screenshot) {
295 open_screenshot_file("w");
296 if (o_flags & ff_singlepage) take_one_screenshot();
297 else take_screenshots();
298 progress_log("OK for you to move the mouse now.");
300 if (o_mode & mf_readscreenshot) {
301 if ((o_flags & ff_upload) && !(o_flags & ff_testservers))
302 badusage("must not reuse screenshots for upload to live PCTB database");
303 open_screenshot_file("r");
304 if (o_flags & ff_singlepage) read_one_screenshot();
305 else read_screenshots();
307 if (o_mode & mf_analyse) {
308 if (o_flags & ff_needisland) {
309 find_islandname(page_images[0]->rgb);
310 if (o_flags & ff_printisland)
311 printf("%s, %s\n", archipelago, island);
312 sysassert(! setenv("YPPSC_ISLAND",island,1) );
314 switch (o_outmode_kind) {
315 case omk_upload: case omk_str: run_analysis(); break;
316 case omk_raw: analyse(stdout); break;
317 case omk_none: break;
321 progress_log("Finished.");
328 DEFINE_VWRAPPERF(, progress, )
329 DEFINE_VWRAPPERF(, progress_log, )
330 DEFINE_VWRAPPERF(, progress_spinner, )
331 DEFINE_VWRAPPERF(, warning, )
332 DEFINE_VWRAPPERF(, fatal, NORET)
334 static int last_progress_len;
336 static void vprogress_core(int spinner, const char *fmt, va_list al) {
340 if (!isatty(2)) return;
342 if (last_progress_len)
345 r= vfprintf(stderr,fmt,al);
348 putc(spinner,stderr);
352 if (r < last_progress_len) {
353 fprintf(stderr,"%*s", last_progress_len - r, "");
354 if (!r) putc('\r', stderr);
355 else while (last_progress_len-- > r) putc('\b',stderr);
357 last_progress_len= r;
359 if (ferror(stderr) || fflush(stderr)) _exit(16);
362 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
363 void vprogress_spinner(const char *fmt, va_list al) {
364 static const char spinchars[]="/-\\";
367 vprogress_core(spinchars[spinner],fmt,al);
369 spinner %= (sizeof(spinchars)-1);
372 void vprogress_log(const char *fmt, va_list al) {
376 vfprintf(stderr,fmt,al);
381 void vwarning(const char *fmt, va_list al) {
383 fputs("Warning: ",stderr);
384 vfprintf(stderr,fmt,al);
389 void vfatal(const char *fmt, va_list al) {
391 fputs("\n\nFatal error: ",stderr);
392 vfprintf(stderr,fmt,al);
394 fputs("\n\n",stderr);
398 void sysassert_fail(const char *file, int line, const char *what) {
402 "\nfatal operational error:\n"
403 " unsuccessful execution of: %s\n"
405 what, file,line, strerror(e));
409 void waitpid_check_exitstatus(pid_t pid, const char *what) {
413 got= waitpid(pid, &st, 0);
414 if (pid==-1) { sysassert(errno==EINTR); continue; }
417 sysassert( got==pid );
421 fatal("%s failed with nonzero exit status %d",
422 what, WEXITSTATUS(st));
423 } else if (WIFSIGNALED(st)) {
424 fatal("%s died due to signal %s%s", what,
425 strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
427 fatal("%s gave strange wait status %d", what, st);
431 char *masprintf(const char *fmt, ...) {
435 sysassert( vasprintf(&r,fmt,al) >= 0);