added requiring player name when uploading solution tapes via command line
[rocksndiamonds.git] / src / tape.c
index 6f424b12c161235976b20925b939794abdca9039..3d6774dd95390f6ca92f930bfbd64f8935311978 100644 (file)
@@ -312,7 +312,8 @@ static void DrawVideoDisplay_DateTime(unsigned int state, unsigned int value)
       char s[MAX_DATETIME_STRING_SIZE];
       int year2 = value / 10000;
       int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
-      int month_index = (value / 100) % 100;
+      int month_index_raw = (value / 100) % 100;
+      int month_index = month_index_raw % 12;  // prevent invalid index
       int month = month_index + 1;
       int day = value % 100;
 
@@ -512,6 +513,27 @@ static void PrintTapeReplayProgress(boolean replay_finished)
   }
 }
 
+static FILE *tape_log_file;
+
+static void OpenTapeLogfile(void)
+{
+  if (!(tape_log_file = fopen(options.tape_log_filename, MODE_WRITE)))
+    Warn("cannot write tape logfile '%s'", options.tape_log_filename);
+}
+
+static void WriteTapeLogfile(byte action[MAX_TAPE_ACTIONS])
+{
+  int i;
+
+  for (i = 0; i < MAX_TAPE_ACTIONS; i++)
+    putFile8Bit(tape_log_file, action[i]);
+}
+
+static void CloseTapeLogfile(void)
+{
+  fclose(tape_log_file);
+}
+
 
 // ============================================================================
 // tape control functions
@@ -559,6 +581,8 @@ void TapeErase(void)
   tape.game_version = GAME_VERSION_ACTUAL;
   tape.engine_version = level.game_version;
 
+  tape.property_bits = TAPE_PROPERTY_NONE;
+
   TapeSetDateFromNow();
 
   for (i = 0; i < MAX_PLAYERS; i++)
@@ -650,6 +674,8 @@ static void TapeAppendRecording(void)
   // set current delay (for last played move)
   tape.pos[tape.counter].delay = tape.delay_played;
 
+  tape.property_bits |= TAPE_PROPERTY_REPLAYED;
+
   // set current date
   TapeSetDateFromNow();
 
@@ -740,6 +766,12 @@ void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
     tape.set_centered_player = FALSE;
   }
 
+  if (GameFrameDelay != GAME_FRAME_DELAY)
+    tape.property_bits |= TAPE_PROPERTY_GAME_SPEED;
+
+  if (setup.small_game_graphics || SCR_FIELDX >= 2 * SCR_FIELDX_DEFAULT)
+    tape.property_bits |= TAPE_PROPERTY_SMALL_GRAPHICS;
+
   if (!TapeAddAction(action))
     TapeStopRecording();
 }
@@ -761,6 +793,12 @@ void TapeTogglePause(boolean toggle_mode)
   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
     tape.single_step = FALSE;
 
+  if (tape.single_step)
+    tape.property_bits |= TAPE_PROPERTY_SINGLE_STEP;
+
+  if (tape.pausing)
+    tape.property_bits |= TAPE_PROPERTY_PAUSE_MODE;
+
   DrawVideoDisplayCurrentState();
 
   if (tape.deactivate_display)
@@ -790,12 +828,14 @@ void TapeTogglePause(boolean toggle_mode)
 
   if (game_status == GAME_MODE_PLAYING)
   {
-    if (setup.show_snapshot_buttons && CheckEngineSnapshotList())
+    if (setup.show_load_save_buttons &&
+       setup.show_undo_redo_buttons &&
+       CheckEngineSnapshotList())
     {
       if (tape.pausing)
        MapUndoRedoButtons();
       else if (!tape.single_step)
-       UnmapUndoRedoButtons();
+       MapLoadSaveButtons();
     }
 
     ModifyPauseButtons();
@@ -936,6 +976,9 @@ byte *TapePlayAction(void)
   if (tape.auto_play)
     PrintTapeReplayProgress(FALSE);
 
+  if (options.tape_log_filename != NULL)
+    WriteTapeLogfile(action);
+
   return action;
 }
 
@@ -1043,6 +1086,8 @@ void TapeQuickSave(void)
     return;
   }
 
+  tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
+
   if (SaveTapeChecked(tape.level_nr))
     SaveEngineSnapshotSingle();
 }
@@ -1101,6 +1146,7 @@ void TapeQuickLoad(void)
     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
 
     tape.quick_resume = TRUE;
+    tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
   }
   else // this should not happen (basically checked above)
   {
@@ -1225,10 +1271,57 @@ void FixTape_ForceSinglePlayer(void)
 // tape autoplay functions
 // ----------------------------------------------------------------------------
 
+static void AutoPlayTapes_SetScoreEntry(int score, int time)
+{
+  // set unique basename for score tape (for uploading to score server)
+  strcpy(tape.score_tape_basename, getScoreTapeBasename(setup.player_name));
+
+  // store score in first score entry
+  scores.last_added = 0;
+
+  struct ScoreEntry *entry = &scores.entry[scores.last_added];
+
+  strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
+  strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
+
+  entry->score = score;
+  entry->time = time;
+
+  PrintNoLog("- uploading score tape to score server ... ");
+
+  server_scores.uploaded = FALSE;
+}
+
+static void AutoPlayTapes_WaitForUpload(void)
+{
+  unsigned int upload_delay = 0;
+  unsigned int upload_delay_value = 10000;
+
+  ResetDelayCounter(&upload_delay);
+
+  // wait for score tape to be successfully uploaded (and fail on timeout)
+  while (!server_scores.uploaded)
+  {
+    if (DelayReached(&upload_delay, upload_delay_value))
+    {
+      PrintNoLog("\r");
+      Print("- uploading score tape to score server - TIMEOUT.\n");
+
+      Fail("cannot upload score tape to score server");
+    }
+
+    Delay(20);
+  }
+
+  PrintNoLog("\r");
+  Print("- uploading score tape to score server - uploaded.\n");
+}
+
 void AutoPlayTapes(void)
 {
   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;
@@ -1312,6 +1405,35 @@ void AutoPlayTapes(void)
     // just finished auto-playing tape
     PrintTapeReplayProgress(TRUE);
 
+    if (options.tape_log_filename != NULL)
+      CloseTapeLogfile();
+
+    if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
+       tape.auto_play_level_solved)
+    {
+      AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
+
+      if (leveldir_current)
+      {
+       // the tape's level set identifier may differ from current level set
+       strncpy(tape.level_identifier, leveldir_current->identifier,
+               MAX_FILENAME_LEN);
+       tape.level_identifier[MAX_FILENAME_LEN] = '\0';
+
+       // the tape's level number may differ from current level number
+       tape.level_nr = level_nr;
+      }
+
+      // save score tape to upload to server; may be required for some reasons:
+      // * level set identifier in solution tapes may differ from level set
+      // * solution tape may have native format (like Supaplex solution files)
+
+      SaveScoreTape(level_nr);
+      SaveServerScore(level_nr);
+
+      AutoPlayTapes_WaitForUpload();
+    }
+
     if (patch_nr == 0)
       num_levels_played++;
 
@@ -1323,6 +1445,14 @@ void AutoPlayTapes(void)
   }
   else
   {
+    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");
+    }
+
     DrawCompleteVideoDisplay();
 
     audio.sound_enabled = FALSE;
@@ -1334,6 +1464,14 @@ void AutoPlayTapes(void)
 
       LoadTapeFromFilename(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);
+      }
+
       global.autoplay_leveldir = tape.level_identifier;
 
       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
@@ -1360,6 +1498,8 @@ void AutoPlayTapes(void)
     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);
@@ -1487,14 +1627,44 @@ void AutoPlayTapes(void)
       }
     }
 
+    if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
+    {
+      Print("Tape %03d:\n", level_nr);
+
+      AutoPlayTapes_SetScoreEntry(0, 0);
+
+      if (tape_filename == NULL)
+       tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
+                        getSolutionTapeFilename(level_nr));
+
+      SaveServerScoreFromFile(level_nr, tape_filename);
+
+      AutoPlayTapes_WaitForUpload();
+
+      // required for uploading multiple tapes
+      tape_filename = NULL;
+
+      continue;
+    }
+
     InitCounter();
 
+    if (options.tape_log_filename != NULL)
+      OpenTapeLogfile();
+
     TapeStartGamePlaying();
     TapeStartWarpForward(global.autoplay_mode);
 
+    autoplay_last_level_nr = level_nr;
+
     return;
   }
 
+  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);
+
   Print("\n");
   PrintLine("=", 79);
   Print("Number of levels played: %d\n", num_levels_played);
@@ -1504,18 +1674,32 @@ void AutoPlayTapes(void)
     Print("Number of tapes fixed: %d\n", num_tapes_patched);
   PrintLine("-", 79);
   Print("Summary (for automatic parsing by scripts):\n");
-  Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
-       (num_levels_played == num_levels_solved &&
-        num_levels_played > 0 ? " OK " : "WARN"),
-       autoplay_leveldir->identifier, num_levels_solved, num_levels_played,
-       (num_levels_played ? num_levels_solved * 100 / num_levels_played : 0));
 
-  if (num_levels_played != num_levels_solved)
+  if (tape_filename)
   {
-    Print(", FAILED:");
-    for (i = 0; i < MAX_TAPES_PER_SET; i++)
-      if (level_failed[i])
-       Print(" %03d", i);
+    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,
+         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);
+    }
   }
 
   Print("\n");