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");
 114   fclose(tf);
 115   progress_log("all complete.");
 116 }
 117
 118 void fetch_with_rsync(const char *stem) {
 119   pid_t fetcher;
 120
 121   sysassert( (fetcher= fork()) != -1 );
 122   if (!fetcher) {
 123     const char *rsync= getenv("YPPSC_PCTB_RSYNC");
 124     if (!rsync) rsync= "rsync";
 125
 126     const char *src= getenv("YPPSC_PCTB_DICT_UPDATE");
 127     char *remote= masprintf("%s/master-%s.txt", src, stem);
 128     char *local= masprintf("_master-%s.txt", stem);
 129     if (DEBUGP(rsync))
 130       fprintf(stderr,"executing rsync to fetch %s to %s\n",remote,local);
 131     execlp(rsync, "rsync",
 132            DEBUGP(rsync) ? "-zvLt" : "-zLt",
 133            "--",remote,local,(char*)0);
 134     sysassert(!"exec rsync failed");
 135   }
 136
 137   waitpid_check_exitstatus(fetcher, "rsync");
 138 }
 139
 140 static void set_server(const char *envname, const char *defprotocol,
 141                        const char *defvalue, const char *defvalue_test,
 142                        const char *userspecified,
 143                        int enable) {
 144   const char *value;
 145
 146   if (!enable) { value= "0"; goto ok; }
 147
 148   if (userspecified)
 149     value= userspecified;
 150   else if ((value= getenv(envname)))
 151     ;
 152   else if (o_flags & ff_testservers)
 153     value= defvalue_test;
 154   else
 155     value= defvalue;
 156
 157   if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
 158     /* absolute or relative pathname - or anyway, something with no hostname */
 159     goto ok;
 160
 161   const char *colon= strchr(value, ':');
 162   const char *slash= strchr(value, '/');
 163
 164   if (colon && (!slash || colon < slash))
 165     /* colon before the first slash, if any */
 166     /* rsync :: protocol specification - anyway, adding scheme:// won't help */
 167     goto ok;
 168
 169   int vallen= strlen(value);
 170
 171   value= masprintf("%s%s%s", defprotocol, value,
 172                    vallen && value[vallen-1]=='/' ? "" : "/");
 173
 174  ok:
 175   sysassert(! setenv(envname,value,1) );
 176 }
 177
 178 int main(int argc, char **argv) {
 179   const char *arg;
 180
 181   sysassert( setlocale(LC_MESSAGES,"") );
 182   sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
 183              setlocale(LC_CTYPE,"en.UTF-8") );
 184
 185 #define ARGVAL  ((*++argv) ? *argv : \
 186                  (badusage("missing value for option %s",arg),(char*)0))
 187
 188 #define IS(s) (!strcmp(arg,(s)))
 189
 190   while ((arg=*++argv)) {
 191     if (IS("--find-window-only"))      o_mode= mode_findwindow;
 192     else if (IS("--screenshot-only"))  o_mode= mode_screenshot;
 193     else if (IS("--show-charset"))     o_mode= mode_showcharset;
 194     else if (IS("--analyse-only") ||
 195              IS("--same"))             o_mode= mode_analyse;
 196     else if (IS("--everything"))       o_mode= mode_all;
 197     else if (IS("--find-island"))      o_flags |= ffs_printisland;
 198     else if (IS("--single-page"))      o_flags |= ff_singlepage;
 199     else if (IS("--quiet"))            o_quiet= 1;
 200     else if (IS("--edit-charset"))     o_flags |= ff_charset_edit;
 201     else if (IS("--no-edit-charset"))  o_flags &= ~(ffm_charset);
 202     else if (IS("--test-servers"))     o_flags |= ff_testservers;
 203     else if (IS("--dict-local-only"))  o_flags &= ~ffs_dict;
 204     else if (IS("--dict-read-only"))   o_flags &= (~ffs_dict | ff_dict_fetch);
 205     else if (IS("--dict-anon"))        o_flags &= ~ff_dict_pirate;
 206     else if (IS("--dict-submit"))      o_flags |= ff_dict_fetch|ff_dict_submit;
 207     else if (IS("--raw-tsv"))          o_outmode_kind= omk_raw;
 208     else if (IS("--upload"))           o_outmode_kind= omk_upload;
 209     else if (IS("--arbitrage") ||
 210              IS("--tsv") ||
 211              IS("--best-prices"))      o_outmode_kind=omk_str,
 212                                        o_outmode_str=arg+2;
 213
 214     else if (IS("--screenshot-file"))  o_screenshot_fn= ARGVAL;
 215     else if (IS("--pctb-server"))         o_serv_pctb=        ARGVAL;
 216     else if (IS("--dict-submit-server"))  o_serv_dict_submit= ARGVAL;
 217     else if (IS("--dict-update-server"))  o_serv_dict_fetch=  ARGVAL;
 218     else if (IS("--ocean"))            o_ocean=  ARGVAL;
 219     else if (IS("--pirate"))           o_pirate= ARGVAL;
 220 #define DF(f)                                   \
 221     else if (IS("-D" #f))                       \
 222       debug_flags |= dbg_##f;
 223     DEBUG_FLAG_LIST
 224 #undef DF
 225     else if (IS("--window-id")) {
 226       char *ep;
 227       unsigned long windowid= strtoul(ARGVAL,&ep,0);
 228       if (*ep) badusage("invalid window id");
 229       set_yppclient_window(windowid);
 230     } else
 231       badusage("unknown option `%s'",arg);
 232   }
 233
 234   /* Consequential changes to options */
 235
 236   if (o_mode & mf_analyse) {
 237     if (!o_outmode_kind) {
 238       if (o_flags & ff_printisland) {
 239         o_outmode_kind= omk_none;
 240         o_flags |= ff_singlepage;
 241       } else {
 242         o_outmode_kind= omk_upload;
 243       }
 244     }
 245
 246     if (o_outmode_kind==omk_upload) {
 247       o_flags |= ffs_upload;
 248       o_outmode_str= "upload";
 249     }
 250   }
 251
 252   /* Defaults */
 253
 254   set_server("YPPSC_PCTB_PCTB",
 255              "http://",          "pctb.ilk.org" /*pctb.crabdance.com*/,
 256                                  "pctb.ilk.org",
 257              o_serv_pctb,        o_flags & (ff_needisland|ff_upload));
 258
 259   set_server("YPPSC_PCTB_DICT_UPDATE",
 260              "rsync://",         "rsync.pctb.chiark.greenend.org.uk/pctb",
 261                                  "rsync.pctb.chiark.greenend.org.uk/pctb/test",
 262              o_serv_dict_fetch,   o_flags & ff_dict_fetch);
 263
 264   set_server("YPPSC_PCTB_DICT_SUBMIT",
 265              "http://",           "dictup.pctb.chiark.greenend.org.uk",
 266                                   "dictup.pctb.chiark.greenend.org.uk/test",
 267              o_serv_dict_submit,  o_flags & ff_dict_submit);
 268
 269   if (!o_screenshot_fn)
 270     o_screenshot_fn= masprintf("%s/_pages.ppm",get_vardir());
 271
 272   /* Actually do the work */
 273
 274   canon_colour_prepare();
 275
 276   if (o_mode & mf_findwindow) {
 277     screenshot_startup();
 278     find_yppclient_window();
 279   }
 280   if (!ocean)  ocean=  o_ocean;
 281   if (!pirate) pirate= o_pirate;
 282
 283   if (o_flags & ff_needisland)
 284     if (!ocean)
 285       badusage("need --ocean option when not using actual YPP client window"
 286                " (consider supplying --pirate too)");
 287   if (ocean)
 288     sysassert(! setenv("YPPSC_OCEAN",ocean,1) );
 289   if (pirate && (o_flags & ff_dict_pirate))
 290     sysassert(! setenv("YPPSC_PIRATE",pirate,1) );
 291
 292   switch (o_mode & mfm_special) {
 293   case 0:                                      break;
 294   case mode_showcharset:  ocr_showcharsets();  exit(0);
 295   default:                                     abort();
 296   }
 297
 298   if (o_mode & mf_screenshot) {
 299     open_screenshot_file("w");
 300     if (o_flags & ff_singlepage) take_one_screenshot();
 301     else take_screenshots();
 302     progress_log("OK for you to move the mouse now.");
 303   }
 304   if (o_mode & mf_readscreenshot) {
 305     if ((o_flags & ff_upload) && !(o_flags & ff_testservers))
 306       badusage("must not reuse screenshots for upload to live PCTB database");
 307     open_screenshot_file("r");
 308     if (o_flags & ff_singlepage) read_one_screenshot();
 309     else read_screenshots();
 310   }
 311   if (o_mode & mf_analyse) {
 312     if (o_flags & ff_needisland) {
 313       find_islandname(page_images[0]->rgb);
 314       if (o_flags & ff_printisland)
 315         printf("%s, %s\n", archipelago, island);
 316       sysassert(! setenv("YPPSC_ISLAND",island,1) );
 317     }
 318     switch (o_outmode_kind) {
 319     case omk_upload: case omk_str:   run_analysis();        break;
 320     case omk_raw:                    analyse(stdout);       break;
 321     case omk_none:                                          break;
 322     default: abort();
 323     }
 324   }
 325   progress_log("Finished.");
 326   return 0;
 327 }
 328
 329
 330
 331
 332 DEFINE_VWRAPPERF(, progress, )
 333 DEFINE_VWRAPPERF(, progress_log, )
 334 DEFINE_VWRAPPERF(, progress_spinner, )
 335 DEFINE_VWRAPPERF(, warning, )
 336 DEFINE_VWRAPPERF(, fatal, NORET)
 337
 338 static int last_progress_len;
 339
 340 static void vprogress_core(int spinner, const char *fmt, va_list al) {
 341   int r;
 342
 343   if (o_quiet) return;
 344   if (!isatty(2)) return;
 345
 346   if (last_progress_len)
 347     putc('\r',stderr);
 348
 349   r= vfprintf(stderr,fmt,al);
 350
 351   if (spinner) {
 352     putc(spinner,stderr);
 353     r++;
 354   }
 355
 356   if (r < last_progress_len) {
 357     fprintf(stderr,"%*s", last_progress_len - r, "");
 358     if (!r) putc('\r', stderr);
 359     else while (last_progress_len-- > r) putc('\b',stderr);
 360   }
 361   last_progress_len= r;
 362
 363   if (ferror(stderr) || fflush(stderr)) _exit(16);
 364 }
 365
 366 void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
 367 void vprogress_spinner(const char *fmt, va_list al) {
 368   static const char spinchars[]="/-\\";
 369   static int spinner;
 370
 371   vprogress_core(spinchars[spinner],fmt,al);
 372   spinner++;
 373   spinner %= (sizeof(spinchars)-1);
 374 }
 375
 376 void vprogress_log(const char *fmt, va_list al) {
 377   if (o_quiet) return;
 378
 379   progress("");
 380   vfprintf(stderr,fmt,al);
 381   putc('\n',stderr);
 382   fflush(stderr);
 383 }
 384
 385 void vwarning(const char *fmt, va_list al) {
 386   progress("");
 387   fputs("Warning: ",stderr);
 388   vfprintf(stderr,fmt,al);
 389   fputs("\n",stderr);
 390   fflush(stderr);
 391 }
 392
 393 void vfatal(const char *fmt, va_list al) {
 394   progress("");
 395   fputs("\n\nFatal error: ",stderr);
 396   vfprintf(stderr,fmt,al);
 397   fflush(stderr);
 398   fputs("\n\n",stderr);
 399   _exit(4);
 400 }
 401
 402 void sysassert_fail(const char *file, int line, const char *what) {
 403   int e= errno;
 404   progress("");
 405   fprintf(stderr,
 406           "\nfatal operational error:\n"
 407           " unsuccessful execution of: %s\n"
 408           " %s:%d: %s\n\n",
 409           what, file,line, strerror(e));
 410   _exit(16);
 411 }
 412
 413 void waitpid_check_exitstatus(pid_t pid, const char *what) {
 414   pid_t got;
 415   int st;
 416   for (;;) {
 417     got= waitpid(pid, &st, 0);
 418     if (pid==-1) { sysassert(errno==EINTR); continue; }
 419     break;
 420   }
 421   sysassert( got==pid );
 422
 423   if (WIFEXITED(st)) {
 424     if (WEXITSTATUS(st))
 425       fatal("%s failed with nonzero exit status %d",
 426             what, WEXITSTATUS(st));
 427   } else if (WIFSIGNALED(st)) {
 428     fatal("%s died due to signal %s%s", what,
 429           strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
 430   } else {
 431     fatal("%s gave strange wait status %d", what, st);
 432   }
 433 }
 434
 435 char *masprintf(const char *fmt, ...) {
 436   char *r;
 437   va_list al;
 438   va_start(al,fmt);
 439   sysassert( vasprintf(&r,fmt,al) >= 0);
 440   sysassert(r);
 441   va_end(al);
 442   return r;
 443 }