pctb/convert.c

   1 /*
   2  * ypp-commodities main program: argument parsing etc.
   3  */
   4 /*
   5  *  This is part of ypp-sc-tools, a set of third-party tools for assisting
   6  *  players of Yohoho Puzzle Pirates.
   7  *
   8  *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  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.
  26  */
  27
  28 #include "convert.h"
  29
  30 void debug_flush(void) {
  31   sysassert(!ferror(debug));
  32   sysassert(!fflush(debug));
  33 }
  34
  35 const char *get_vardir(void) { return "."; }
  36 const char *get_libdir(void) { return "."; }
  37
  38
  39 enum mode {
  40   mf_findwindow=      00001,
  41   mf_screenshot=      00010,
  42   mf_readscreenshot=  00020,
  43   mf_analyse=         00100,
  44   mfm_special=        07000,
  45
  46   mode_findwindow=    00001,
  47   mode_screenshot=    00011,
  48   mode_analyse=       00120,
  49   mode_showcharset=   01000,
  50
  51   mode_all=           00111,
  52 };
  53
  54 enum outmodekind {
  55   omk_unset, omk_upload, omk_str, omk_raw, omk_none
  56 };
  57 static enum outmodekind o_outmode_kind;
  58 static const char *o_outmode_str= 0;
  59
  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;
  63
  64 const char *o_resolver= "./dictionary-manager";
  65 FILE *screenshot_file;
  66 const char *o_ocean, *o_pirate;
  67 int o_quiet;
  68
  69 enum flags o_flags=
  70    ff_charset_allowedit |
  71    ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
  72
  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);
  77   fputc('\n',stderr);
  78   exit(12);
  79 }
  80 DEFINE_VWRAPPERF(static, badusage, NORET);
  81
  82 static void open_screenshot_file(const char *mode) {
  83   screenshot_file= fopen(o_screenshot_fn, mode);
  84   if (!screenshot_file)
  85     fatal("could not open screenshots file `%s': %s",
  86           o_screenshot_fn, strerror(errno));
  87 }
  88
  89 static void run_analysis(void) {
  90   FILE *tf;
  91
  92   sysassert( tf= tmpfile() );
  93   progress("running recognition...");
  94   analyse(tf);
  95
  96   if (o_flags & ff_upload) {
  97     if (npages<=1)
  98       fatal("Recognition successful, but refusing to upload partial data\n"
  99             " (--single-page specified).  Specify an output mode?");
 100   }
 101
 102   sysassert( fseek(tf,0,SEEK_SET) == 0);
 103
 104   progress_log("processing results (--%s)...", o_outmode_str);
 105   pid_t processor;
 106   sysassert( (processor= fork()) != -1 );
 107
 108   if (!processor) {
 109     sysassert( dup2(fileno(tf),0) ==0 );
 110     EXECLP_HELPER("commod-results-processor", o_outmode_str, (char*)0);
 111   }
 112
 113   waitpid_check_exitstatus(processor, "output processor/uploader", 0);
 114   fclose(tf);
 115   progress_log("all complete.");
 116 }
 117
 118 static void rsync_core(const char *stem, const char *suffix,
 119                        const char *zopt) {
 120   pid_t fetcher;
 121
 122   sysassert( (fetcher= fork()) != -1 );
 123   if (!fetcher) {
 124     const char *rsync= getenv("YPPSC_PCTB_RSYNC");
 125     if (!rsync) rsync= "rsync";
 126
 127     const char *src= getenv("YPPSC_PCTB_DICT_UPDATE");
 128     char *remote= masprintf("%s/master-%s.txt%s", src, stem, suffix);
 129     char *local= masprintf("_master-%s.txt%s", stem, suffix);
 130     if (DEBUGP(rsync))
 131       fprintf(stderr,"executing rsync to fetch %s to %s\n",remote,local);
 132     char *opts= masprintf("-Lt%s%s",
 133                           zopt,
 134                           DEBUGP(rsync) ? "v" : "");
 135     execlp(rsync, "rsync",opts,"--",remote,local,(char*)0);
 136     sysassert(!"exec rsync failed");
 137   }
 138
 139   waitpid_check_exitstatus(fetcher, "rsync", 0);
 140 }
 141
 142 void fetch_with_rsync_gz(const char *stem) { rsync_core(stem,".gz",""); }
 143 void fetch_with_rsync(const char *stem) { rsync_core(stem,"","z"); }
 144
 145 static void set_server(const char *envname, const char *defprotocol,
 146                        const char *defvalue, const char *defvalue_test,
 147                        const char *userspecified,
 148                        int enable) {
 149   const char *value;
 150
 151   if (!enable) { value= "0"; goto ok; }
 152
 153   if (userspecified)
 154     value= userspecified;
 155   else if ((value= getenv(envname)))
 156     ;
 157   else if (o_flags & ff_testservers)
 158     value= defvalue_test;
 159   else
 160     value= defvalue;
 161
 162   if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
 163     /* absolute or relative pathname - or anyway, something with no hostname */
 164     goto ok;
 165
 166   const char *colon= strchr(value, ':');
 167   const char *slash= strchr(value, '/');
 168
 169   if (colon && (!slash || colon < slash))
 170     /* colon before the first slash, if any */
 171     /* rsync :: protocol specification - anyway, adding scheme:// won't help */
 172     goto ok;
 173
 174   int vallen= strlen(value);
 175
 176   value= masprintf("%s%s%s", defprotocol, value,
 177                    vallen && value[vallen-1]=='/' ? "" : "/");
 178
 179  ok:
 180   sysassert(! setenv(envname,value,1) );
 181 }
 182
 183 int main(int argc, char **argv) {
 184   const char *arg;
 185
 186   sysassert( setlocale(LC_MESSAGES,"") );
 187   sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
 188              setlocale(LC_CTYPE,"en.UTF-8") );
 189
 190 #define ARGVAL  ((*++argv) ? *argv : \
 191                  (badusage("missing value for option %s",arg),(char*)0))
 192
 193 #define IS(s) (!strcmp(arg,(s)))
 194
 195   while ((arg=*++argv)) {
 196     if (IS("--find-window-only"))      o_mode= mode_findwindow;
 197     else if (IS("--screenshot-only"))  o_mode= mode_screenshot;
 198     else if (IS("--show-charset"))     o_mode= mode_showcharset;
 199     else if (IS("--analyse-only") ||
 200              IS("--same"))             o_mode= mode_analyse;
 201     else if (IS("--everything"))       o_mode= mode_all;
 202     else if (IS("--find-island"))      o_flags |= ffs_printisland;
 203     else if (IS("--single-page"))      o_flags |= ff_singlepage;
 204     else if (IS("--quiet"))            o_quiet= 1;
 205     else if (IS("--edit-charset"))     o_flags |= ff_charset_edit;
 206     else if (IS("--no-edit-charset"))  o_flags &= ~(ffm_charset);
 207     else if (IS("--test-servers"))     o_flags |= ff_testservers;
 208     else if (IS("--dict-local-only"))  o_flags &= ~ffs_dict;
 209     else if (IS("--dict-read-only"))   o_flags &= (~ffs_dict | ff_dict_fetch);
 210     else if (IS("--dict-anon"))        o_flags &= ~ff_dict_pirate;
 211     else if (IS("--dict-submit"))      o_flags |= ff_dict_fetch|ff_dict_submit;
 212     else if (IS("--raw-tsv"))          o_outmode_kind= omk_raw;
 213     else if (IS("--upload"))           o_outmode_kind= omk_upload;
 214     else if (IS("--arbitrage") ||
 215              IS("--tsv") ||
 216              IS("--best-prices"))      o_outmode_kind=omk_str,
 217                                        o_outmode_str=arg+2;
 218
 219     else if (IS("--screenshot-file"))  o_screenshot_fn= ARGVAL;
 220     else if (IS("--pctb-server"))         o_serv_pctb=        ARGVAL;
 221     else if (IS("--dict-submit-server"))  o_serv_dict_submit= ARGVAL;
 222     else if (IS("--dict-update-server"))  o_serv_dict_fetch=  ARGVAL;
 223     else if (IS("--ocean"))            o_ocean=  ARGVAL;
 224     else if (IS("--pirate"))           o_pirate= ARGVAL;
 225 #define DF(f)                                   \
 226     else if (IS("-D" #f))                       \
 227       debug_flags |= dbg_##f;
 228     DEBUG_FLAG_LIST
 229 #undef DF
 230     else if (IS("--window-id")) {
 231       char *ep;
 232       unsigned long windowid= strtoul(ARGVAL,&ep,0);
 233       if (*ep) badusage("invalid window id");
 234       set_yppclient_window(windowid);
 235     } else
 236       badusage("unknown option `%s'",arg);
 237   }
 238
 239   /* Consequential changes to options */
 240
 241   if (o_mode & mf_analyse) {
 242     if (!o_outmode_kind) {
 243       if (o_flags & ff_printisland) {
 244         o_outmode_kind= omk_none;
 245         o_flags |= ff_singlepage;
 246       } else {
 247         o_outmode_kind= omk_upload;
 248       }
 249     }
 250
 251     if (o_outmode_kind==omk_upload) {
 252       o_flags |= ffs_upload;
 253       o_outmode_str= "upload";
 254     }
 255   }
 256
 257   /* Defaults */
 258
 259   set_server("YPPSC_PCTB_PCTB",
 260              "http://",          "pctb.ilk.org" /*pctb.crabdance.com*/,
 261                                  "pctb.ilk.org",
 262              o_serv_pctb,        o_flags & (ff_needisland|ff_upload));
 263
 264   set_server("YPPSC_PCTB_DICT_UPDATE",
 265              "rsync://",         "rsync.pctb.chiark.greenend.org.uk/pctb",
 266                                  "rsync.pctb.chiark.greenend.org.uk/pctb/test",
 267              o_serv_dict_fetch,   o_flags & ff_dict_fetch);
 268
 269   set_server("YPPSC_PCTB_DICT_SUBMIT",
 270              "http://",           "dictup.pctb.chiark.greenend.org.uk",
 271                                   "dictup.pctb.chiark.greenend.org.uk/test",
 272              o_serv_dict_submit,  o_flags & ff_dict_submit);
 273
 274   if (!o_screenshot_fn)
 275     o_screenshot_fn= masprintf("%s/_pages.ppm",get_vardir());
 276
 277   /* Actually do the work */
 278
 279   canon_colour_prepare();
 280
 281   if (o_mode & mf_findwindow) {
 282     screenshot_startup();
 283     find_yppclient_window();
 284   }
 285   if (!ocean)  ocean=  o_ocean;
 286   if (!pirate) pirate= o_pirate;
 287
 288   if (o_flags & ff_needisland)
 289     if (!ocean)
 290       badusage("need --ocean option when not using actual YPP client window"
 291                " (consider supplying --pirate too)");
 292   if (ocean)
 293     sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
 294   if (pirate && (o_flags & ff_dict_pirate))
 295     sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
 296
 297   switch (o_mode & mfm_special) {
 298   case 0:                                      break;
 299   case mode_showcharset:  ocr_showcharsets();  exit(0);
 300   default:                                     abort();
 301   }
 302
 303   if (o_mode & mf_screenshot) {
 304     open_screenshot_file("w");
 305     if (o_flags & ff_singlepage) take_one_screenshot();
 306     else take_screenshots();
 307     progress_log("OK for you to move the mouse now, and you can"
 308                  " use the YPP client again.");
 309   }
 310   if (o_mode & mf_readscreenshot) {
 311     if ((o_flags & ff_upload) && !(o_flags & ff_testservers))
 312       badusage("must not reuse screenshots for upload to live PCTB database");
 313     open_screenshot_file("r");
 314     if (o_flags & ff_singlepage) read_one_screenshot();
 315     else read_screenshots();
 316   }
 317   if (o_mode & mf_analyse) {
 318     if (o_flags & ff_needisland) {
 319       find_islandname();
 320       if (o_flags & ff_printisland)
 321         printf("%s, %s\n", archipelago, island);
 322       sysassert(! setenv("YPPSC_ISLAND",island,1) );
 323     }
 324     switch (o_outmode_kind) {
 325     case omk_upload: case omk_str:   run_analysis();        break;
 326     case omk_raw:                    analyse(stdout);       break;
 327     case omk_none:                                          break;
 328     default: abort();
 329     }
 330   }
 331   progress_log("Finished.");
 332   return 0;
 333 }
 334
 335
 336
 337
 338 DEFINE_VWRAPPERF(, progress, )
 339 DEFINE_VWRAPPERF(, progress_log, )
 340 DEFINE_VWRAPPERF(, progress_spinner, )
 341 DEFINE_VWRAPPERF(, warning, )
 342 DEFINE_VWRAPPERF(, fatal, NORET)
 343
 344 static int last_progress_len;
 345
 346 static void vprogress_core(int spinner, const char *fmt, va_list al) {
 347   int r;
 348
 349   if (o_quiet) return;
 350   if (!isatty(2)) return;
 351
 352   if (last_progress_len)
 353     putc('\r',stderr);
 354
 355   r= vfprintf(stderr,fmt,al);
 356
 357   if (spinner) {
 358     putc(spinner,stderr);
 359     r++;
 360   }
 361
 362   if (r < last_progress_len) {
 363     fprintf(stderr,"%*s", last_progress_len - r, "");
 364     if (!r) putc('\r', stderr);
 365     else while (last_progress_len-- > r) putc('\b',stderr);
 366   }
 367   last_progress_len= r;
 368
 369   if (ferror(stderr) || fflush(stderr)) _exit(16);
 370 }
 371
 372 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
 373 void vprogress_spinner(const char *fmt, va_list al) {
 374   static const char spinchars[]="/-\\";
 375   static int spinner;
 376
 377   vprogress_core(spinchars[spinner],fmt,al);
 378   spinner++;
 379   spinner %= (sizeof(spinchars)-1);
 380 }
 381
 382 void vprogress_log(const char *fmt, va_list al) {
 383   if (o_quiet) return;
 384
 385   progress("");
 386   vfprintf(stderr,fmt,al);
 387   putc('\n',stderr);
 388   fflush(stderr);
 389 }
 390
 391 void vwarning(const char *fmt, va_list al) {
 392   progress("");
 393   fputs("Warning: ",stderr);
 394   vfprintf(stderr,fmt,al);
 395   fputs("\n",stderr);
 396   fflush(stderr);
 397 }
 398
 399 void vfatal(const char *fmt, va_list al) {
 400   progress("");
 401   fputs("\n\nFatal error: ",stderr);
 402   vfprintf(stderr,fmt,al);
 403   fflush(stderr);
 404   fputs("\n\n",stderr);
 405   _exit(4);
 406 }
 407
 408 void sysassert_fail(const char *file, int line, const char *what) {
 409   int e= errno;
 410   progress("");
 411   fprintf(stderr,
 412           "\nfatal operational error:\n"
 413           " unsuccessful execution of: %s\n"
 414           " %s:%d: %s\n\n",
 415           what, file,line, strerror(e));
 416   _exit(16);
 417 }
 418
 419 void waitpid_check_exitstatus(pid_t pid, const char *what, int sigpipeok) {
 420   pid_t got;
 421   int st;
 422   for (;;) {
 423     got= waitpid(pid, &st, 0);
 424     if (pid==-1) { sysassert(errno==EINTR); continue; }
 425     break;
 426   }
 427   sysassert( got==pid );
 428
 429   if (WIFEXITED(st)) {
 430     if (WEXITSTATUS(st))
 431       fatal("%s failed with nonzero exit status %d",
 432             what, WEXITSTATUS(st));
 433   } else if (WIFSIGNALED(st)) {
 434     if (!sigpipeok || WTERMSIG(st) != SIGPIPE)
 435       fatal("%s died due to signal %s%s", what,
 436             strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
 437   } else {
 438     fatal("%s gave strange wait status %d", what, st);
 439   }
 440 }
 441
 442 char *masprintf(const char *fmt, ...) {
 443   char *r;
 444   va_list al;
 445   va_start(al,fmt);
 446   sysassert( vasprintf(&r,fmt,al) >= 0);
 447   sysassert(r);
 448   va_end(al);
 449   return r;
 450 }