chiark / gitweb /
Rename yppsc-* helpers
[ypp-sc-tools.web-live.git] / pctb / convert.c
index f38abf5a0d2dc6b0c91eaa4fd3e78a271e581bda..bb1073f4bf6ac20a391dbfc5bddadc4fef2f43f9 100644 (file)
+/*
+ * ypp-commodities main program: argument parsing etc.
+ */
+/*
+ *  This is part of ypp-sc-tools, a set of third-party tools for assisting
+ *  players of Yohoho Puzzle Pirates.
+ * 
+ *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ * 
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ * 
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ * 
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ *  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+ *  are used without permission.  This program is not endorsed or
+ *  sponsored by Three Rings.
+ */
 
 #include "convert.h"
 
-
 void debug_flush(void) {
-  eassert(!fflush(debug));
-  eassert(!ferror(debug));
+  sysassert(!ferror(debug));
+  sysassert(!fflush(debug));
 }
 
-
 const char *get_vardir(void) { return "."; }
+const char *get_libdir(void) { return "."; }
+
+
+enum mode {
+  mf_findwindow=      0001,
+  mf_screenshot=      0010,
+  mf_readscreenshot=  0020,
+  mf_analyse=         0100,
+  
+  mode_findwindow=    0001,
+  mode_screenshot=    0011,
+  mode_analyse=       0120,
+
+  mode_all=           0111,
+};
+
+static enum mode o_mode= mode_all;
+static char *o_screenshot_fn;
+static int o_quiet;
+static const char *o_outputmode= "upload";
+static const char *o_serv_pctb, *o_serv_dict_fetch, *o_serv_dict_submit;
+
+const char *o_resolver= "./dictionary-manager";
+FILE *screenshot_file;
+
+enum flags o_flags= ff_dict_fetch|ff_dict_submit|ff_dict_pirate;
+
+static void vbadusage(const char *fmt, va_list) FMT(1,0) NORET;
+static void vbadusage(const char *fmt, va_list al) {
+  fputs("bad usage: ",stderr);
+  vfprintf(stderr,fmt,al);
+  fputc('\n',stderr);
+  exit(12);
+}
+DEFINE_VWRAPPERF(static, badusage, NORET);
+
+static void open_screenshot_file(const char *mode) {
+  screenshot_file= fopen(o_screenshot_fn, mode);
+  if (!screenshot_file)
+    fatal("could not open screenshots file `%s': %s",
+         o_screenshot_fn, strerror(errno));
+}
+
+static void run_analysis(void) {
+  FILE *tf;
+
+  sysassert( tf= tmpfile() );
+  progress("running recognition...");
+  analyse(tf);
+
+  if (o_flags & ff_upload) {
+    if (o_flags & ff_singlepage)
+      fatal("Recognition successful, but refusing to upload partial data\n"
+           " (--single-page specified).  Specify an output mode?");
+  }
+
+  sysassert( fseek(tf,0,SEEK_SET) == 0);
+
+  progress_log("processing results (--%s)...", o_outputmode);
+  pid_t processor;
+  sysassert( (processor= fork()) != -1 );
+
+  if (!processor) {
+    sysassert( dup2(fileno(tf),0) ==0 );
+    EXECLP_HELPER("commod-results-processor", o_outputmode, (char*)0);
+  }
 
+  waitpid_check_exitstatus(processor, "output processor/uploader");
+  fclose(tf);
+  progress_log("all complete.");
+}
+
+void fetch_with_rsync(const char *stem) {
+  pid_t fetcher;
+
+  sysassert( (fetcher= fork()) != -1 );
+  if (!fetcher) {
+    const char *rsync= getenv("YPPSC_PCTB_RSYNC");
+    if (!rsync) rsync= "rsync";
+  
+    const char *src= getenv("YPPSC_PCTB_DICT_UPDATE");
+    char *remote= masprintf("%s/master-%s.txt", src, stem);
+    char *local= masprintf("#master-%s#.txt", stem);
+    execlp(rsync, "rsync",
+          DEBUGP(rsync) ? "-vLt" : "-Lt",
+          "--",remote,local,(char*)0);
+    sysassert(!"exec rsync failed");
+  }
+
+  waitpid_check_exitstatus(fetcher, "dictionary-manager --update");
+}
+
+static void set_server(const char *envname, const char *defprotocol,
+                      const char *defvalue, const char *userspecified,
+                      int enable) {
+  const char *value;
+  
+  if (!enable) { value= "0"; goto ok; }
+
+  if (userspecified)
+    value= userspecified;
+  else if ((value= getenv(envname)))
+    ;
+  else
+    value= defvalue;
+
+  if (value[0]=='/' || (value[0]=='.' && value[1]=='/'))
+    /* absolute or relative pathname - or anyway, something with no hostname */
+    goto ok;
 
-static enum { mode_all=03, mode_screenshot=01, mode_analyse=02 }
-    o_mode= mode_all;
-static char *o_screenshots_fn;
-static int o_single_page;
+  const char *colon= strchr(value, ':');
+  const char *slash= strchr(value, '/');
 
-FILE *screenshots_file;
+  if (colon && (!slash || colon < slash))
+    /* colon before the first slash, if any */
+    /* rsync :: protocol specification - anyway, adding scheme:// won't help */
+    goto ok;
+
+  value= masprintf("%s%s", defprotocol, value);
+
+ ok:
+  sysassert(! setenv(envname,value,1) );
+}
 
 int main(int argc, char **argv) {
   const char *arg;
-  int r;
+
+  sysassert( setlocale(LC_MESSAGES,"") );
+  sysassert( setlocale(LC_CTYPE,"en_GB.UTF-8") ||
+            setlocale(LC_CTYPE,"en.UTF-8") );
+
+#define ARGVAL  ((*++argv) ? *argv : \
+                (badusage("missing value for option %s",arg),(char*)0))
+
+#define IS(s) (!strcmp(arg,(s)))
 
   while ((arg=*++argv)) {
-    if (!strcmp(arg,"--screenshots-only"))
-      o_mode= mode_screenshot;
-    else if (!strcmp(arg,"--analyse-only"))
-      o_mode= mode_analyse;
-    else if (!strcmp(arg,"--single-page"))
-      o_single_page= 1;
-    else if (!strcmp(arg,"--screenshots-file"))
-      eassert( o_screenshots_fn= *++argv );
-    else if (!strcmp(arg,"--window-id")) {
+    if (IS("--find-window-only"))      o_mode= mode_findwindow;
+    else if (IS("--screenshot-only"))  o_mode= mode_screenshot;
+    else if (IS("--analyse-only") ||
+            IS("--same"))             o_mode= mode_analyse;
+    else if (IS("--everything"))       o_mode= mode_all;
+    else if (IS("--single-page"))      o_flags |= ff_singlepage;
+    else if (IS("--quiet"))            o_quiet= 1;
+    else if (IS("--edit-charset"))     o_flags |= ff_editcharset;
+    else if (IS("--dict-local-only"))  o_flags &= ~ffs_dict;
+    else if (IS("--dict-read-only"))   o_flags &= (~ffs_dict | ff_dict_fetch);
+    else if (IS("--dict-anon"))        o_flags &= ~ff_dict_pirate;
+    else if (IS("--dict-submit"))      o_flags |= ff_dict_fetch|ff_dict_submit;
+    else if (IS("--upload") ||
+            IS("--arbitrage") ||
+            IS("--tsv") ||
+            IS("--best-prices"))      o_outputmode= arg+2;
+    else if (IS("--raw-tsv"))          o_outputmode= 0;
+    else if (IS("--screenshot-file"))  o_screenshot_fn= ARGVAL;
+    else if (IS("--pctb-server"))         o_serv_pctb=        ARGVAL;
+    else if (IS("--dict-submit-server"))  o_serv_dict_submit= ARGVAL;
+    else if (IS("--dict-update-server"))  o_serv_dict_fetch=  ARGVAL;
+#define DF(f)                                  \
+    else if (IS("-D" #f))                      \
+      debug_flags |= dbg_##f;
+    DEBUG_FLAG_LIST
+#undef DF
+    else if (IS("--window-id")) {
       char *ep;
-      eassert((arg=*++argv));
-      unsigned long windowid= strtoul(arg,&ep,0);
-      eassert(!*ep);
+      unsigned long windowid= strtoul(ARGVAL,&ep,0);
+      if (*ep) badusage("invalid window id");
       set_yppclient_window(windowid);
     } else
-      eassert(!"bad option");
+      badusage("unknown option `%s'",arg);
   }
+
+  /* Consequential changes to options */
   
-  if (!o_screenshots_fn) {
-    r= asprintf(&o_screenshots_fn,"%s/#pages#.ppm",get_vardir());
-    eassert(r>=0);  eassert(o_screenshots_fn);
-  }
+  if (!strcmp("upload",o_outputmode))
+    o_flags |= ffs_upload;
+
+  /* Defaults */
+  
+  set_server("YPPSC_PCTB_PCTB",
+            "http://",           "pctb.ilk.org",
+            o_serv_pctb,         o_flags & (ff_needisland|ff_upload));
+            
+  set_server("YPPSC_PCTB_DICT_UPDATE",
+            "rsync://",          "rsync.pctb.chiark.greenend.org.uk/pctb",
+            o_serv_dict_fetch,   o_flags & ff_dict_fetch);
+
+  set_server("YPPSC_PCTB_DICT_SUBMIT",
+            "http://",           "dictup.pctb.chiark.greenend.org.uk",
+            o_serv_dict_submit,  o_flags & ff_dict_submit);
+
+  if (!o_screenshot_fn)
+    o_screenshot_fn= masprintf("%s/#pages#.ppm",get_vardir());
 
-  if (o_mode & mode_screenshot) {
+  /* Actually do the work */
+            
+  if (o_mode & mf_findwindow) {
     screenshot_startup();
     find_yppclient_window();
-    screenshots_file= fopen(o_screenshots_fn, "w"); eassert(screenshots_file);
-    if (o_single_page)
-      take_one_screenshot();
-    else
-      take_screenshots();
-  } else {
-    screenshots_file= fopen(o_screenshots_fn, "r"); eassert(screenshots_file);
-    read_screenshots();
   }
-  if (o_mode & mode_analyse) {
-    analyse();
-    //output_tsv();
+  if (o_mode & mf_screenshot) {
+    open_screenshot_file("w");
+    if (o_flags & ff_singlepage) take_one_screenshot();
+    else take_screenshots();
+  }
+  if (o_mode & mf_readscreenshot) {
+    open_screenshot_file("r");
+    if (o_flags & ff_singlepage) read_one_screenshot();
+    else read_screenshots();
+  }
+  if (o_mode & mf_analyse) {
+    find_islandname();
+    if (o_outputmode)
+      run_analysis();
+    else
+      analyse(stdout);
   }
   return 0;
 }
+
+
+
+
+DEFINE_VWRAPPERF(, progress, )
+DEFINE_VWRAPPERF(, progress_log, )
+DEFINE_VWRAPPERF(, progress_spinner, )
+DEFINE_VWRAPPERF(, warning, )
+DEFINE_VWRAPPERF(, fatal, NORET)
+
+static int last_progress_len;
+     
+static void vprogress_core(int spinner, const char *fmt, va_list al) {
+  int r;
+  
+  if (o_quiet) return;
+  if (!isatty(2)) return;
+  
+  if (last_progress_len)
+    putc('\r',stderr);
+
+  r= vfprintf(stderr,fmt,al);
+
+  if (spinner) {
+    putc(spinner,stderr);
+    r++;
+  }
+
+  if (r < last_progress_len) {
+    fprintf(stderr,"%*s", last_progress_len - r, "");
+    if (!r) putc('\r', stderr);
+    else while (last_progress_len-- > r) putc('\b',stderr);
+  }
+  last_progress_len= r;
+
+  if (ferror(stderr) || fflush(stderr)) _exit(16);
+}
+   
+void vprogress(const char *fmt, va_list al) { vprogress_core(0,fmt,al); }
+void vprogress_spinner(const char *fmt, va_list al) {
+  static const char spinchars[]="/-\\";
+  static int spinner;
+
+  vprogress_core(spinchars[spinner],fmt,al);
+  spinner++;
+  spinner %= (sizeof(spinchars)-1);
+}
+
+void vprogress_log(const char *fmt, va_list al) {
+  if (o_quiet) return;
+  
+  progress("");
+  vfprintf(stderr,fmt,al);
+  putc('\n',stderr);
+  fflush(stderr);
+}
+
+void vwarning(const char *fmt, va_list al) {
+  progress("");
+  fputs("Warning: ",stderr);
+  vfprintf(stderr,fmt,al);
+  fputs("\n",stderr);
+  fflush(stderr);
+}
+
+void vfatal(const char *fmt, va_list al) {
+  progress("");
+  fputs("\n\nFatal error: ",stderr);
+  vfprintf(stderr,fmt,al);
+  fflush(stderr);
+  fputs("\n\n",stderr);
+  _exit(4);
+}
+
+void sysassert_fail(const char *file, int line, const char *what) {
+  int e= errno;
+  progress("");
+  fprintf(stderr,
+         "\nfatal operational error:\n"
+         " unsuccessful execution of: %s\n"
+         " %s:%d: %s\n\n",
+         what, file,line, strerror(e));
+  _exit(16);
+}
+
+void waitpid_check_exitstatus(pid_t pid, const char *what) { 
+  pid_t got;
+  int st;
+  for (;;) {
+    got= waitpid(pid, &st, 0);
+    if (pid==-1) { sysassert(errno==EINTR); continue; }
+    break;
+  }
+  sysassert( got==pid );
+
+  if (WIFEXITED(st)) {
+    if (WEXITSTATUS(st))
+      fatal("%s failed with nonzero exit status %d",
+           what, WEXITSTATUS(st));
+  } else if (WIFSIGNALED(st)) {
+    fatal("%s died due to signal %s%s", what,
+         strsignal(WTERMSIG(st)), WCOREDUMP(st)?" (core dumped)":"");
+  } else {
+    fatal("%s gave strange wait status %d", what, st);
+  }
+}
+
+char *masprintf(const char *fmt, ...) {
+  char *r;
+  va_list al;
+  va_start(al,fmt);
+  sysassert( vasprintf(&r,fmt,al) >= 0);
+  sysassert(r);
+  va_end(al);
+  return r;
+}