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= 0020,
45 mode_findwindow= 0001,
46 mode_screenshot= 0011,
53 omk_unset, omk_upload, omk_str, omk_raw, omk_none
55 static enum outmodekind o_outmode_kind;
56 static const char *o_outmode_str= 0;
58 static enum mode o_mode= mode_all;
59 static char *o_screenshot_fn;
60 static const char *o_serv_pctb, *o_serv_dict_fetch, *o_serv_dict_submit;
62 const char *o_resolver= "./dictionary-manager";
63 FILE *screenshot_file;
64 const char *o_ocean, *o_pirate;
67 enum flags o_flags= ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
69 static void vbadusage(const char *fmt, va_list) FMT(1,0) NORET;
70 static void vbadusage(const char *fmt, va_list al) {
71 fputs("bad usage: ",stderr);
72 vfprintf(stderr,fmt,al);
76 DEFINE_VWRAPPERF(static, badusage, NORET);
78 static void open_screenshot_file(const char *mode) {
79 screenshot_file= fopen(o_screenshot_fn, mode);
81 fatal("could not open screenshots file `%s': %s",
82 o_screenshot_fn, strerror(errno));
85 static void run_analysis(void) {
88 sysassert( tf= tmpfile() );
89 progress("running recognition...");
92 if (o_flags & ff_upload) {
93 if (o_flags & ff_singlepage)
94 fatal("Recognition successful, but refusing to upload partial data\n"
95 " (--single-page specified). Specify an output mode?");
98 sysassert( fseek(tf,0,SEEK_SET) == 0);
100 progress_log("processing results (--%s)...", o_outmode_str);
102 sysassert( (processor= fork()) != -1 );
105 sysassert( dup2(fileno(tf),0) ==0 );
106 EXECLP_HELPER("commod-results-processor", o_outmode_str, (char*)0);
109 waitpid_check_exitstatus(processor, "output processor/uploader");
111 progress_log("all complete.");
114 void fetch_with_rsync(const char *stem) {
117 sysassert( (fetcher= fork()) != -1 );
119 const char *rsync= getenv("YPPSC_PCTB_RSYNC");
120 if (!rsync) rsync= "rsync";
122 const char *src= getenv("YPPSC_PCTB_DICT_UPDATE");
123 char *remote= masprintf("%s/master-%s.txt", src, stem);
124 char *local= masprintf("#master-%s#.txt", stem);
125 execlp(rsync, "rsync",
126 DEBUGP(rsync) ? "-vLt" : "-Lt",
127 "--",remote,local,(char*)0);
128 sysassert(!"exec rsync failed");
131 waitpid_check_exitstatus(fetcher, "rsync");
134 static void set_server(const char *envname, const char *defprotocol,
135 const char *defvalue, const char *defvalue_test,
136 const char *userspecified,
140 if (!enable) { value= "0"; goto ok; }
143 value= userspecified;
144 else if ((value= getenv(envname)))
146 else if (o_flags & ff_testservers)
147 value= defvalue_test;
151 if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
152 /* absolute or relative pathname - or anyway, something with no hostname */
155 const char *colon= strchr(value, ':');
156 const char *slash= strchr(value, '/');
158 if (colon && (!slash || colon < slash))
159 /* colon before the first slash, if any */
160 /* rsync :: protocol specification - anyway, adding scheme:// won't help */
163 int vallen= strlen(value);
165 value= masprintf("%s%s%s", defprotocol, value,
166 vallen && value[vallen-1]=='/' ? "" : "/");
169 sysassert(! setenv(envname,value,1) );
172 int main(int argc, char **argv) {
175 sysassert( setlocale(LC_MESSAGES,"") );
176 sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
177 setlocale(LC_CTYPE,"en.UTF-8") );
179 #define ARGVAL ((*++argv) ? *argv : \
180 (badusage("missing value for option %s",arg),(char*)0))
182 #define IS(s) (!strcmp(arg,(s)))
184 while ((arg=*++argv)) {
185 if (IS("--find-window-only")) o_mode= mode_findwindow;
186 else if (IS("--screenshot-only")) o_mode= mode_screenshot;
187 else if (IS("--analyse-only") ||
188 IS("--same")) o_mode= mode_analyse;
189 else if (IS("--everything")) o_mode= mode_all;
190 else if (IS("--find-island")) o_flags |= ffs_printisland;
191 else if (IS("--single-page")) o_flags |= ff_singlepage;
192 else if (IS("--quiet")) o_quiet= 1;
193 else if (IS("--edit-charset")) o_flags |= ff_editcharset;
194 else if (IS("--test-servers")) o_flags |= ff_testservers;
195 else if (IS("--dict-local-only")) o_flags &= ~ffs_dict;
196 else if (IS("--dict-read-only")) o_flags &= (~ffs_dict | ff_dict_fetch);
197 else if (IS("--dict-anon")) o_flags &= ~ff_dict_pirate;
198 else if (IS("--dict-submit")) o_flags |= ff_dict_fetch|ff_dict_submit;
199 else if (IS("--raw-tsv")) o_outmode_kind= omk_raw;
200 else if (IS("--upload")) o_outmode_kind= omk_upload;
201 else if (IS("--arbitrage") ||
203 IS("--best-prices")) o_outmode_kind=omk_str,
206 else if (IS("--screenshot-file")) o_screenshot_fn= ARGVAL;
207 else if (IS("--pctb-server")) o_serv_pctb= ARGVAL;
208 else if (IS("--dict-submit-server")) o_serv_dict_submit= ARGVAL;
209 else if (IS("--dict-update-server")) o_serv_dict_fetch= ARGVAL;
210 else if (IS("--ocean")) o_ocean= ARGVAL;
211 else if (IS("--pirate")) o_pirate= ARGVAL;
213 else if (IS("-D" #f)) \
214 debug_flags |= dbg_##f;
217 else if (IS("--window-id")) {
219 unsigned long windowid= strtoul(ARGVAL,&ep,0);
220 if (*ep) badusage("invalid window id");
221 set_yppclient_window(windowid);
223 badusage("unknown option `%s'",arg);
226 /* Consequential changes to options */
228 if (o_mode & mf_analyse) {
230 o_outmode_kind= (o_flags & ff_printisland) ? omk_none : omk_str;
232 if (o_outmode_kind==omk_upload) {
233 o_flags |= ffs_upload;
234 o_outmode_str= "upload";
240 set_server("YPPSC_PCTB_PCTB",
241 "http://", "pctb.ilk.org" /*pctb.crabdance.com*/,
243 o_serv_pctb, o_flags & (ff_needisland|ff_upload));
245 set_server("YPPSC_PCTB_DICT_UPDATE",
246 "rsync://", "rsync.pctb.chiark.greenend.org.uk/pctb",
247 "rsync.pctb.chiark.greenend.org.uk/pctb/test",
248 o_serv_dict_fetch, o_flags & ff_dict_fetch);
250 set_server("YPPSC_PCTB_DICT_SUBMIT",
251 "http://", "dictup.pctb.chiark.greenend.org.uk",
252 "dictup.pctb.chiark.greenend.org.uk/test",
253 o_serv_dict_submit, o_flags & ff_dict_submit);
255 if (!o_screenshot_fn)
256 o_screenshot_fn= masprintf("%s/#pages#.ppm",get_vardir());
258 /* Actually do the work */
260 if (o_mode & mf_findwindow) {
261 screenshot_startup();
262 find_yppclient_window();
264 if (!ocean) ocean= o_ocean;
265 if (!pirate) pirate= o_pirate;
267 if (o_flags & ff_needisland) {
269 badusage("need --ocean option when replaying images"
270 " (consider supplying --pirate too)");
271 sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
273 if (pirate && (o_flags & ff_dict_pirate))
274 sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
276 if (o_mode & mf_screenshot) {
277 open_screenshot_file("w");
278 if (o_flags & ff_singlepage) take_one_screenshot();
279 else take_screenshots();
281 if (o_mode & mf_readscreenshot) {
282 open_screenshot_file("r");
283 if (o_flags & ff_singlepage) read_one_screenshot();
284 else read_screenshots();
286 if (o_mode & mf_analyse) {
287 if (o_flags & ff_needisland) {
289 if (o_flags & ff_printisland)
290 printf("%s, %s\n", archipelago, island);
292 switch (o_outmode_kind) {
293 case omk_upload: case omk_str: run_analysis(); break;
294 case omk_raw: analyse(stdout); break;
295 case omk_none: break;
299 progress_log("Finished.");
306 DEFINE_VWRAPPERF(, progress, )
307 DEFINE_VWRAPPERF(, progress_log, )
308 DEFINE_VWRAPPERF(, progress_spinner, )
309 DEFINE_VWRAPPERF(, warning, )
310 DEFINE_VWRAPPERF(, fatal, NORET)
312 static int last_progress_len;
314 static void vprogress_core(int spinner, const char *fmt, va_list al) {
318 if (!isatty(2)) return;
320 if (last_progress_len)
323 r= vfprintf(stderr,fmt,al);
326 putc(spinner,stderr);
330 if (r < last_progress_len) {
331 fprintf(stderr,"%*s", last_progress_len - r, "");
332 if (!r) putc('\r', stderr);
333 else while (last_progress_len-- > r) putc('\b',stderr);
335 last_progress_len= r;
337 if (ferror(stderr) || fflush(stderr)) _exit(16);
340 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
341 void vprogress_spinner(const char *fmt, va_list al) {
342 static const char spinchars[]="/-\\";
345 vprogress_core(spinchars[spinner],fmt,al);
347 spinner %= (sizeof(spinchars)-1);
350 void vprogress_log(const char *fmt, va_list al) {
354 vfprintf(stderr,fmt,al);
359 void vwarning(const char *fmt, va_list al) {
361 fputs("Warning: ",stderr);
362 vfprintf(stderr,fmt,al);
367 void vfatal(const char *fmt, va_list al) {
369 fputs("\n\nFatal error: ",stderr);
370 vfprintf(stderr,fmt,al);
372 fputs("\n\n",stderr);
376 void sysassert_fail(const char *file, int line, const char *what) {
380 "\nfatal operational error:\n"
381 " unsuccessful execution of: %s\n"
383 what, file,line, strerror(e));
387 void waitpid_check_exitstatus(pid_t pid, const char *what) {
391 got= waitpid(pid, &st, 0);
392 if (pid==-1) { sysassert(errno==EINTR); continue; }
395 sysassert( got==pid );
399 fatal("%s failed with nonzero exit status %d",
400 what, WEXITSTATUS(st));
401 } else if (WIFSIGNALED(st)) {
402 fatal("%s died due to signal %s%s", what,
403 strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
405 fatal("%s gave strange wait status %d", what, st);
409 char *masprintf(const char *fmt, ...) {
413 sysassert( vasprintf(&r,fmt,al) >= 0);