fix score file format, use of whoami and fruit buffers

Corrected use of the global `whoami[]` and `fruit[]` buffers.

Fixed how user id's are converted into usernames
when processing the rogue score file.

Fixed critical bugs in how the score file is formatted.
In some cases a `SCORE` value was improperly initialized.
Now, the function `init_score_value(SCORE *scp)` will
properly initialize a `SCORE` value.

If the rogue score file is missing, or zero length,
then the `open_score()` functional will initialize it.

Fixed cases where the code assumed that the score file was exactly
10 entries.  Now the `NUMSCORES` value (which defaults to 10), as set in
`config.h`, is used to determine the number of top scores.  The global
`numscores` value is initialized to `NUMSCORES`.  If someone defines
`NUMSCORES` to a value other than 10, the code will work.

Changed the array name `top_ten` to `top_scores` to reflect
the fact that someone can compile `NUMSCORES` value isn't 10.

The `MAXNAME` value is now `MAX_USERNAME`.

Added `MAX_OTHER_SCORE` to indicate the maximum length the score line
apart from the username.

The `MAXSCORELINE` value is now the sum of MAX_USERNAME` and `MAX_OTHER_SCORE`.

Removed use of `NUMNAME` and instead print the number of top scores.
This is because of someone defines the `NUMSCORES` value in `define.h`
to a value other than 10, we don't have to try an convert the
`NUMSCORES` value into a string that is the English name of that value.

IMPORTANT NOTE: Due to serious flaws how the score file was formatted
                in older rogue versions, you make have to remove your
		existing score file and let the code re-initialize it.

NOTE: The rogue score file is NOT portable across machines.
      For one thing, the user id and username stored in the
      score file is host dependent.  For another thing, the
      values in the rogue score file are machine and OS dependent.

NOTE: If you change the value of the `NUMSCORES` value, you
      will need to remove your existing rogue score file
      and set the rogue program re-initialize it.

NOTE: If you really want to restore your rogue scores after the
      removal and re-initialization, the use the `scedit` tool to
      to restore your score scores.

If the `rd_score()` function fails to properly parse the rogue score file,
then code will print a ERROR indicating that rogue score file format is too
old and/or has been corrupted, and suggest that you should remove the rogue
score file which will allow the rogue program to properly initialize it.

To determine if you need to re-initialize your rogue score file,
run the command:

> ./rogue -s

If the above command issues the above mentioned ERROR/WARNING,
and exits non-zero, then you need to remove the rogue score file
and let the rogue program to re-initialize your rogue score file.

Author: lcn2

README.md

@@ -181,8 +181,10 @@ This repo improves on the above mentioned repo in several important aspects:
 * Added extensive SPOILER section notes in the lower part of this `README.md` file
 * Fixed several buffer overflow bugs and memory leak conditions
 * Fixed bugs related to the reading and writing of the score file
-* Detects if the rogue score file is old and/or corrept and issues warnings along with a removal recommendation
+* Detects if the rogue score file is an old incompible format and/or corrept
+* If the rogue score file is empty or missing, the code will automatically re-initialize it
 * The top scores are recorded in the rogue score file, regardless of if the game was won or not
+* You may change the `NUMSCORES` value in `config.h` to a value other than 10
 * etc.
 
 

config.h

@@ -204,7 +204,18 @@
 /* word for the number of scores to store in scoreboard */
 #define NUMNAME "Ten"
 
-/* number of scores to store in scoreboard */
+/*
+ * number of scores to store in scoreboard
+ *
+ * IMPORTANT NOTE: If you change NUMSCORES, then a existing rogue score file
+ *                 will appear to be corrupted.  If that happens, simply remove
+ *                 your existing rogue score file, and run "rogue -s" to
+ *                 re-initialize it.
+ *
+ *                 If you really want to restore your rogue scores after the
+ *                 removal and re-initialization, the use the `scedit` tool
+ *                 to restore your score scores.
+ */
 #define NUMSCORES 10
 
 /* Define to the address where bug reports for this package should be sent. */

extern.c

@@ -57,16 +57,16 @@ char file_name[MAXSTR+1] = {'\0'};	/* Save file path */
 char score_path[MAXSTR+1] = {'\0'};	/* score file path */
 char huh[MAXSTR];			/* The last message printed */
 const char *p_colors[MAXPOTIONS];		/* Colors of the potions */
-char prbuf[PFBUF_LEN+1];		/* buffer for snprintfs, +1 for paranoia */
+char prbuf[PFBUF_LEN+1] = {'\0'};	/* buffer for snprintfs, +1 for paranoia */
 const char *r_stones[MAXRINGS];		/* Stone settings of the rings */
 int  runch;				/* Direction player is running */
 char *s_names[MAXSCROLLS];		/* Names of the scrolls */
 int  take;				/* Thing she is taking */
-char whoami[MAXSTR];			/* Name of player */
+char whoami[MAXSTR+1] = {'\0'};		/* Name of player, +1 for paranoia */
 const char *ws_made[MAXSTICKS];		/* What sticks are made of */
 char *ws_type[MAXSTICKS];		/* Is it a wand or a staff */
 int  orig_dsusp;			/* Original dsusp char */
-char fruit[MAXSTR] =			/* Favorite fruit */
+char fruit[MAXSTR+1] =			/* Favorite fruit, +1 for paranoia */
 		{ 's', 'l', 'i', 'm', 'e', '-', 'm', 'o', 'l', 'd', '\0' };
 char home[MAXSTR+1] = { '\0' };		/* User's home directory */
 const char *inv_t_name[] = {
@@ -394,7 +394,7 @@ const struct h_list helpstr[] = {
     {'v',	"	print version number",			TRUE},
     {0,		NULL }
 };
-int numscores;
+int numscores = NUMSCORES;
 char *Numname;
 int allscore;
 int between;

extern.h

@@ -125,7 +125,7 @@ typedef unsigned int pid_t;
 #define PFBUF_LEN (2*MAXSTR)
 extern int got_ltc, in_shell;
 extern int	wizard;
-extern char	fruit[], prbuf[PFBUF_LEN+1], whoami[];
+extern char	fruit[MAXSTR+1], prbuf[PFBUF_LEN+1], whoami[MAXSTR+1];
 extern int orig_dsusp;
 extern FILE	*scoreboard;
 extern int numscores;

mach_dep.c

@@ -20,8 +20,6 @@
  *			people will be playing; otherwise the score file
  *			gets hogged by just a few people.
  *	NUMSCORES	Number of scores in the score file (default 10).
- *	NUMNAME		String version of NUMSCORES (first character
- *			should be capitalized) (default "Ten").
  *	MAXLOAD		What (if any) the maximum load average should be
  *			when people are playing.  Since it is divided
  *			by 10, to specify a load limit of 4.0, MAXLOAD
@@ -48,15 +46,11 @@
 #include <errno.h>
 #include <time.h>
 #include <ncurses.h>
+#include "score.h"
 #include "extern.h"
 
 #define NOOP(x) (x += 0)
 
-# ifndef NUMSCORES
-#	define	NUMSCORES	10
-#	define	NUMNAME		"Ten"
-# endif
-
 #ifdef CHECKTIME
 static int num_checks = 0;		/* times we've gone over in checkout() */
 #endif /* CHECKTIME */
@@ -91,8 +85,8 @@ init_check(void)
 void
 open_score(void)
 {
+    struct stat buf;	    /* score file status */
     numscores = NUMSCORES;
-    Numname = NUMNAME;
 
 #ifdef ALLSCORES
     allscore = TRUE;
@@ -112,16 +106,64 @@ open_score(void)
 
     scoreboard = fopen(score_path, "r+");
 
-    if ((scoreboard == NULL) && (errno == ENOENT))
-    {
-	scoreboard = fopen(score_path, "w+");
-        md_chmod(score_path, 0664);
+    /*
+     * If we opened a score file, verify that the score file size is correct
+     *
+     * If the score file as empty, close the score file and let the next section
+     * initialize the score file.
+     */
+    if (scoreboard != NULL) {
+
+	/*
+	 * determine size of the opened score file
+	 */
+	if (fstat(fileno(scoreboard), &buf) < 0) {
+	    /* stat filed, close down and treat as if the previous open failed */
+	    fclose(scoreboard);
+	    scoreboard = NULL;
+
+	/*
+	 * if score file is empty
+	 */
+	} else if (buf.st_size == 0) {
+	    /* close score file, and let the next section initialize the score file */
+	    fclose(scoreboard);
+	    scoreboard = NULL;
+	}
     }
 
+    /*
+     * initialize the score file if the score file is not open
+     */
     if (scoreboard == NULL) {
-         fprintf(stderr, "Could not open %s for writing: %s\n", score_path, strerror(errno));
-         fflush(stderr);
+	SCORE top_scores[NUMSCORES+1];        /* scores from the score file, +1 for paranoia */
+	int i;
+
+	/*
+	 * create and truncate a writable score file
+	 */
+	scoreboard = fopen(score_path, "w+");
+	if (scoreboard == NULL) {
+	     fprintf(stderr, "Could not open %s for writing: %s\n", score_path, strerror(errno));
+	     fflush(stderr);
+	     exit(1);
+	}
+        md_chmod(score_path, 0664);
+
+	/*
+	 * initialize all scores
+	 */
+	memset(top_scores, 0, sizeof(top_scores)); /* paranoia */
+	for (i=0; i < NUMSCORES; ++i) {
+	    init_score_value(&top_scores[i]);
+	}
+
+	/*
+	 * write the score file with initialized scores, and then rewind it
+	 */
+	wr_score(top_scores);
     }
+
 }
 
 /*

main.c

@@ -76,6 +76,7 @@ main(int argc, char **argv)
     memset(score_path, 0, sizeof(score_path)); /* paranoia */
     snprintf(score_path, MAXSTR, "%s%s", home, SCORENAME);
 
+    memset(whoami, 0, sizeof(whoami)); /* paranoia */
     if ((env = getenv("ROGUEOPTS")) != NULL)
 	parse_opts(env);
     if (env == NULL || whoami[0] == '\0')
@@ -106,6 +107,11 @@ main(int argc, char **argv)
 #endif
     seed = dnum;
 
+    /*
+     * we use the random(3) facility, seeded, to generate random data for init_score()
+     */
+    srandom((unsigned)seed);
+
     open_score();
 
     /*

mdport.c

@@ -99,6 +99,7 @@
 #include <sys/stat.h>
 #include <signal.h>
 #include "extern.h"
+#include "score.h"
 
 #if !defined(PATH_MAX) && defined(_MAX_PATH)
 #define PATH_MAX _MAX_PATH
@@ -115,8 +116,6 @@
 #undef HAVE_SETRESUID
 #endif
 
-#define MAX_USERNAME 32	/* MAX_USERNAME */
-
 void
 md_init(void)
 {
@@ -627,7 +626,7 @@ directory_exists(char *dirname)
 char *
 md_getrealname(uid_t uid)
 {
-    static char uidstr[MAX_USERNAME+1];	/* +1 for paranoia */
+    static char uidstr[MAX_USERNAME+1]; /* +1 for paranoia */
 
     memset(uidstr, 0, sizeof(uidstr)); /* paranoia */
 #if !defined(_WIN32) && !defined(DJGPP)
@@ -641,8 +640,8 @@ md_getrealname(uid_t uid)
 	else
 	    return(pp->pw_name);
 #else
-   snprintf(uidstr, MAX_USERNAME, "%ld", uid);
-   return(uidstr);
+    snprintf(uidstr, MAX_USERNAME, "%ld", uid);
+    return(uidstr);
 #endif
 }