added sending flag for locally saved tape to score server
[rocksndiamonds.git] / src / tape.c
index daa90c8def387190e32605581b1e07f2fcd562f4..793bf0cec0145eb04ddaea56a01f898092558626 100644 (file)
@@ -471,8 +471,44 @@ void TapeDeactivateDisplayOff(boolean redraw_display)
 // tape logging functions
 // ============================================================================
 
+struct AutoPlayInfo
+{
+  LevelDirTree *leveldir;
+  boolean all_levelsets;
+  int last_level_nr;
+  int level_nr;
+  int num_levels_played;
+  int num_levels_solved;
+  int num_tapes_patched;
+  int num_tape_missing;
+  boolean level_failed[MAX_TAPES_PER_SET];
+  char *tape_filename;
+};
+
 static char tape_patch_info[MAX_OUTPUT_LINESIZE];
 
+static void PrintTapeReplayHeader(struct AutoPlayInfo *autoplay)
+{
+  PrintLine("=", 79);
+
+  if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+    Print("Automatically fixing level tapes\n");
+  else if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+    Print("Automatically uploading level tapes\n");
+  else
+    Print("Automatically playing level tapes\n");
+
+  PrintLine("-", 79);
+  Print("Level series identifier: '%s'\n", autoplay->leveldir->identifier);
+  Print("Level series name:       '%s'\n", autoplay->leveldir->name);
+  Print("Level series author:     '%s'\n", autoplay->leveldir->author);
+  Print("Number of levels:        %d\n",   autoplay->leveldir->levels);
+  PrintLine("=", 79);
+  Print("\n");
+
+  DrawInitTextItem(autoplay->leveldir->name);
+}
+
 static void PrintTapeReplayProgress(boolean replay_finished)
 {
   static unsigned int counter_last = -1;
@@ -513,6 +549,58 @@ static void PrintTapeReplayProgress(boolean replay_finished)
   }
 }
 
+static void PrintTapeReplaySummary(struct AutoPlayInfo *autoplay)
+{
+  char *autoplay_status =
+    (autoplay->num_levels_played == autoplay->num_levels_solved &&
+     autoplay->num_levels_played > 0 ? " OK " : "WARN");
+  int autoplay_percent =
+    (autoplay->num_levels_played ?
+     autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0);
+  int i;
+
+  Print("\n");
+  PrintLine("=", 79);
+  Print("Number of levels played: %d\n", autoplay->num_levels_played);
+  Print("Number of levels solved: %d (%d%%)\n", autoplay->num_levels_solved,
+       (autoplay->num_levels_played ?
+        autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0));
+  if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
+    Print("Number of tapes fixed: %d\n", autoplay->num_tapes_patched);
+  PrintLine("-", 79);
+  Print("Summary (for automatic parsing by scripts):\n");
+
+  if (autoplay->tape_filename)
+  {
+    Print("TAPEFILE [%s] '%s', %d, %d, %d",
+         autoplay_status,
+         autoplay->leveldir->identifier,
+         autoplay->last_level_nr,
+         game.score_final,
+         game.score_time_final);
+  }
+  else
+  {
+    Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
+         autoplay_status,
+         autoplay->leveldir->identifier,
+         autoplay->num_levels_solved,
+         autoplay->num_levels_played,
+         autoplay_percent);
+
+    if (autoplay->num_levels_played != autoplay->num_levels_solved)
+    {
+      Print(", FAILED:");
+      for (i = 0; i < MAX_TAPES_PER_SET; i++)
+       if (autoplay->level_failed[i])
+         Print(" %03d", i);
+    }
+  }
+
+  Print("\n");
+  PrintLine("=", 79);
+}
+
 static FILE *tape_log_file;
 
 static void OpenTapeLogfile(void)
@@ -1271,6 +1359,26 @@ void FixTape_ForceSinglePlayer(void)
 // tape autoplay functions
 // ----------------------------------------------------------------------------
 
+static TreeInfo *getNextValidAutoPlayEntry(TreeInfo *node)
+{
+  node = getNextValidTreeInfoEntry(node);
+
+  while (node && node->is_copy)
+    node = getNextValidTreeInfoEntry(node);
+
+  return node;
+}
+
+static TreeInfo *getFirstValidAutoPlayEntry(TreeInfo *node)
+{
+  node = getFirstValidTreeInfoEntry(node);
+
+  if (node && node->is_copy)
+    return getNextValidAutoPlayEntry(node);
+
+  return node;
+}
+
 static void AutoPlayTapes_SetScoreEntry(int score, int time)
 {
   // set unique basename for score tape (for uploading to score server)
@@ -1292,7 +1400,7 @@ static void AutoPlayTapes_SetScoreEntry(int score, int time)
   server_scores.uploaded = FALSE;
 }
 
-static void AutoPlayTapes_WaitForUpload(void)
+static boolean AutoPlayTapes_WaitForUpload(void)
 {
   unsigned int upload_delay = 0;
   unsigned int upload_delay_value = 10000;
@@ -1307,28 +1415,27 @@ static void AutoPlayTapes_WaitForUpload(void)
       PrintNoLog("\r");
       Print("- uploading score tape to score server - TIMEOUT.\n");
 
-      Fail("cannot upload score tape to score server");
+      if (program.headless)
+       Fail("cannot upload score tape to score server");
+
+      return FALSE;
     }
 
+    UPDATE_BUSY_STATE();
+
     Delay(20);
   }
 
   PrintNoLog("\r");
   Print("- uploading score tape to score server - uploaded.\n");
+
+  return TRUE;
 }
 
-void AutoPlayTapes(void)
+static int AutoPlayTapesExt(boolean initialize)
 {
-  static LevelDirTree *autoplay_leveldir = NULL;
-  static boolean autoplay_initialized = FALSE;
-  static int autoplay_last_level_nr = -1;
-  static int autoplay_level_nr = -1;
-  static int num_levels_played = 0;
-  static int num_levels_solved = 0;
-  static int num_tapes_patched = 0;
-  static int num_tape_missing = 0;
-  static boolean level_failed[MAX_TAPES_PER_SET];
-  static char *tape_filename = NULL;
+  static struct AutoPlayInfo autoplay;
+  static int num_tapes = 0;
   static int patch_nr = 0;
   static char *patch_name[] =
   {
@@ -1362,9 +1469,12 @@ void AutoPlayTapes(void)
 
     -1
   };
+  LevelDirTree *leveldir_current_last = leveldir_current;
+  boolean init_level_set = FALSE;
+  int level_nr_last = level_nr;
   int i;
 
-  if (autoplay_initialized)
+  if (!initialize)
   {
     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
     {
@@ -1383,7 +1493,7 @@ void AutoPlayTapes(void)
          SaveTapeToFilename(filename);
 
          tape.auto_play_level_fixed = TRUE;
-         num_tapes_patched++;
+         autoplay.num_tapes_patched++;
        }
 
        // continue with next tape
@@ -1426,99 +1536,161 @@ void AutoPlayTapes(void)
 
       // save score tape to upload to server; may be required for some reasons:
       // * level set identifier in solution tapes may differ from level set
+      // * level set identifier is missing (old-style tape without INFO chunk)
       // * solution tape may have native format (like Supaplex solution files)
 
       SaveScoreTape(level_nr);
-      SaveServerScore(level_nr);
+      SaveServerScore(level_nr, TRUE);
 
       AutoPlayTapes_WaitForUpload();
     }
 
     if (patch_nr == 0)
-      num_levels_played++;
+      autoplay.num_levels_played++;
 
     if (tape.auto_play_level_solved)
-      num_levels_solved++;
+      autoplay.num_levels_solved++;
 
     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
-      level_failed[level_nr] = !tape.auto_play_level_solved;
+      autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
   }
   else
   {
-    DrawCompleteVideoDisplay();
+    if (strEqual(global.autoplay_leveldir, "ALL"))
+    {
+      autoplay.all_levelsets = TRUE;
+
+      // tape mass-uploading only allowed for private tapes
+      if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+       options.mytapes = TRUE;
+    }
+
+    if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
+        global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
+       !options.mytapes &&
+       options.player_name == NULL)
+    {
+      Fail("specify player name when uploading solution tapes");
+    }
 
-    audio.sound_enabled = FALSE;
-    setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
+    if (global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
+      DrawCompleteVideoDisplay();
+
+    if (program.headless)
+    {
+      audio.sound_enabled = FALSE;
+      setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
+    }
 
     if (strSuffix(global.autoplay_leveldir, ".tape"))
     {
-      tape_filename = global.autoplay_leveldir;
+      autoplay.tape_filename = global.autoplay_leveldir;
+
+      if (!fileExists(autoplay.tape_filename))
+       Fail("tape file '%s' does not exist", autoplay.tape_filename);
 
-      LoadTapeFromFilename(tape_filename);
+      LoadTapeFromFilename(autoplay.tape_filename);
 
       if (tape.no_valid_file)
-      {
-       if (!fileExists(tape_filename))
-         Fail("tape file '%s' does not exist", tape_filename);
-       else
-         Fail("cannot load tape file '%s'", tape_filename);
-      }
+       Fail("cannot load tape file '%s'", autoplay.tape_filename);
+
+      if (tape.no_info_chunk && !options.identifier)
+       Fail("cannot get levelset from tape file '%s'", autoplay.tape_filename);
+
+      if (tape.no_info_chunk && !options.level_nr)
+       Fail("cannot get level nr from tape file '%s'", autoplay.tape_filename);
 
       global.autoplay_leveldir = tape.level_identifier;
 
+      if (options.identifier != NULL)
+       global.autoplay_leveldir = options.identifier;
+
+      if (options.level_nr != NULL)
+       tape.level_nr = atoi(options.level_nr);
+
       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
         global.autoplay_level[tape.level_nr] = TRUE;
 
       global.autoplay_all = FALSE;
     }
 
-    autoplay_leveldir = getTreeInfoFromIdentifier(leveldir_first,
-                                                 global.autoplay_leveldir);
-
-    if (autoplay_leveldir == NULL)
-      Fail("no such level identifier: '%s'", global.autoplay_leveldir);
-
-    leveldir_current = autoplay_leveldir;
-
-    if (autoplay_leveldir->first_level < 0)
-      autoplay_leveldir->first_level = 0;
-    if (autoplay_leveldir->last_level >= MAX_TAPES_PER_SET)
-      autoplay_leveldir->last_level = MAX_TAPES_PER_SET - 1;
-
-    autoplay_level_nr = autoplay_leveldir->first_level;
-
-    PrintLine("=", 79);
-    if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
-      Print("Automatically fixing level tapes\n");
-    else if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
-      Print("Automatically uploading level tapes\n");
+    if (autoplay.all_levelsets)
+    {
+      // start auto-playing first level set
+      autoplay.leveldir = getFirstValidAutoPlayEntry(leveldir_first);
+    }
     else
-      Print("Automatically playing level tapes\n");
-    PrintLine("-", 79);
-    Print("Level series identifier: '%s'\n", autoplay_leveldir->identifier);
-    Print("Level series name:       '%s'\n", autoplay_leveldir->name);
-    Print("Level series author:     '%s'\n", autoplay_leveldir->author);
-    Print("Number of levels:        %d\n",   autoplay_leveldir->levels);
-    PrintLine("=", 79);
-    Print("\n");
+    {
+      // auto-play selected level set
+      autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
+                                                   global.autoplay_leveldir);
+    }
 
-    for (i = 0; i < MAX_TAPES_PER_SET; i++)
-      level_failed[i] = FALSE;
+    if (autoplay.leveldir == NULL)
+      Fail("no such level identifier: '%s'", global.autoplay_leveldir);
 
     // only private tapes may be modified
     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
       options.mytapes = TRUE;
 
-    autoplay_initialized = TRUE;
+    // set timestamp for batch tape upload
+    global.autoplay_time = time(NULL);
+
+    num_tapes = 0;
+
+    init_level_set = TRUE;
   }
 
   while (1)
   {
+    if (init_level_set)
+    {
+      leveldir_current = autoplay.leveldir;
+
+      if (autoplay.leveldir->first_level < 0)
+       autoplay.leveldir->first_level = 0;
+      if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
+       autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
+
+      autoplay.level_nr = autoplay.leveldir->first_level;
+
+      autoplay.num_levels_played = 0;
+      autoplay.num_levels_solved = 0;
+      autoplay.num_tapes_patched = 0;
+      autoplay.num_tape_missing = 0;
+
+      for (i = 0; i < MAX_TAPES_PER_SET; i++)
+       autoplay.level_failed[i] = FALSE;
+
+      PrintTapeReplayHeader(&autoplay);
+
+      init_level_set = FALSE;
+    }
+
     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
-      level_nr = autoplay_level_nr++;
+      level_nr = autoplay.level_nr++;
 
-    if (level_nr > autoplay_leveldir->last_level)
-      break;
+    UPDATE_BUSY_STATE();
+
+    // check if all tapes for this level set have been processed
+    if (level_nr > autoplay.leveldir->last_level)
+    {
+      PrintTapeReplaySummary(&autoplay);
+
+      if (!autoplay.all_levelsets)
+       break;
+
+      // continue with next level set
+      autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
+
+      // all level sets processed
+      if (autoplay.leveldir == NULL)
+       break;
+
+      init_level_set = TRUE;
+
+      continue;
+    }
 
     // set patch info (required for progress output)
     strcpy(tape_patch_info, "");
@@ -1529,7 +1701,22 @@ void AutoPlayTapes(void)
     if (!global.autoplay_all && !global.autoplay_level[level_nr])
       continue;
 
+    char *tape_filename = (autoplay.tape_filename ? autoplay.tape_filename :
+                           options.mytapes ? getTapeFilename(level_nr) :
+                           getSolutionTapeFilename(level_nr));
+
+    // speed things up in case of missing tapes (by skipping loading level)
+    if (!fileExists(tape_filename))
+    {
+      autoplay.num_tape_missing++;
+
+      Print("Tape %03d: (no tape found)\n", level_nr);
+
+      continue;
+    }
+
     TapeErase();
+    TapeRewind();      // needed to reset "tape.auto_play_level_solved"
 
     LoadLevel(level_nr);
 
@@ -1546,8 +1733,8 @@ void AutoPlayTapes(void)
     continue;
 #endif
 
-    if (tape_filename)
-      LoadTapeFromFilename(tape_filename);
+    if (autoplay.tape_filename)
+      LoadTapeFromFilename(autoplay.tape_filename);
     else if (options.mytapes)
       LoadTape(level_nr);
     else
@@ -1555,9 +1742,9 @@ void AutoPlayTapes(void)
 
     if (tape.no_valid_file)
     {
-      num_tape_missing++;
+      autoplay.num_tape_missing++;
 
-      Print("Tape %03d: (no tape found)\n", level_nr);
+      Print("Tape %03d: (invalid tape)\n", level_nr);
 
       continue;
     }
@@ -1619,22 +1806,48 @@ void AutoPlayTapes(void)
       }
     }
 
+    num_tapes++;
+
     if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
     {
+      boolean use_temporary_tape_file = FALSE;
+
       Print("Tape %03d:\n", level_nr);
 
       AutoPlayTapes_SetScoreEntry(0, 0);
 
-      if (tape_filename == NULL)
-       tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
-                        getSolutionTapeFilename(level_nr));
+      if (autoplay.tape_filename == NULL)
+      {
+       autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
+                                 getDefaultSolutionTapeFilename(level_nr));
 
-      SaveServerScoreFromFile(level_nr, tape_filename);
+       if (!fileExists(autoplay.tape_filename))
+       {
+         // non-standard or incorrect solution tape -- save to temporary file
+         autoplay.tape_filename = getTemporaryTapeFilename();
 
-      AutoPlayTapes_WaitForUpload();
+         SaveTapeToFilename(autoplay.tape_filename);
+
+         use_temporary_tape_file = TRUE;
+       }
+      }
+
+      SaveServerScoreFromFile(level_nr, TRUE, autoplay.tape_filename);
+
+      boolean success = AutoPlayTapes_WaitForUpload();
+
+      if (use_temporary_tape_file)
+        unlink(autoplay.tape_filename);
 
       // required for uploading multiple tapes
-      tape_filename = NULL;
+      autoplay.tape_filename = NULL;
+
+      if (!success)
+      {
+       num_tapes = -1;
+
+       break;
+      }
 
       continue;
     }
@@ -1647,57 +1860,46 @@ void AutoPlayTapes(void)
     TapeStartGamePlaying();
     TapeStartWarpForward(global.autoplay_mode);
 
-    autoplay_last_level_nr = level_nr;
+    autoplay.last_level_nr = level_nr;
 
-    return;
+    return num_tapes;
   }
 
-  char *autoplay_status = (num_levels_played == num_levels_solved &&
-                          num_levels_played > 0 ? " OK " : "WARN");
-  int autoplay_percent = (num_levels_played ?
-                         num_levels_solved * 100 / num_levels_played : 0);
+  if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+  {
+    Print("\n");
+    PrintLine("=", 79);
 
-  Print("\n");
-  PrintLine("=", 79);
-  Print("Number of levels played: %d\n", num_levels_played);
-  Print("Number of levels solved: %d (%d%%)\n", num_levels_solved,
-       (num_levels_played ? num_levels_solved * 100 / num_levels_played : 0));
-  if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
-    Print("Number of tapes fixed: %d\n", num_tapes_patched);
-  PrintLine("-", 79);
-  Print("Summary (for automatic parsing by scripts):\n");
+    if (num_tapes >= 0)
+      Print("SUMMARY: %d tapes uploaded.\n", num_tapes);
+    else
+      Print("SUMMARY: Uploading tapes failed.\n");
 
-  if (tape_filename)
-  {
-    Print("TAPEFILE [%s] '%s', %d, %d, %d",
-         autoplay_status,
-         autoplay_leveldir->identifier,
-         autoplay_last_level_nr,
-         game.score_final,
-         game.score_time_final);
+    PrintLine("=", 79);
   }
-  else
-  {
-    Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
-         autoplay_status,
-         autoplay_leveldir->identifier,
-         num_levels_solved,
-         num_levels_played,
-         autoplay_percent);
 
-    if (num_levels_played != num_levels_solved)
-    {
-      Print(", FAILED:");
-      for (i = 0; i < MAX_TAPES_PER_SET; i++)
-       if (level_failed[i])
-         Print(" %03d", i);
-    }
-  }
+  // clear timestamp for batch tape upload (required after interactive upload)
+  global.autoplay_time = 0;
 
-  Print("\n");
-  PrintLine("=", 79);
+  // exit if running headless or if visually auto-playing tapes
+  if (program.headless || global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
+    CloseAllAndExit(0);
 
-  CloseAllAndExit(0);
+  // when running interactively, restore last selected level set and number
+  leveldir_current = leveldir_current_last;
+  level_nr = level_nr_last;
+
+  return num_tapes;
+}
+
+int AutoPlayTapes(void)
+{
+  return AutoPlayTapesExt(TRUE);
+}
+
+int AutoPlayTapesContinue(void)
+{
+  return AutoPlayTapesExt(FALSE);
 }