Ensure Soundex difference() function handles empty input sanely.

tglsfdc · tglsfdc · commit 0966291a4ade · 2023-05-16T10:53:42.000-04:00
fuzzystrmatch's difference() function assumes that _soundex() always initializes its output buffer fully. This was not so for the case of a string containing no alphabetic characters, resulting in unstable output and Valgrind complaints. Fix by using memset() to fill the whole buffer in the early-exit case. Also make some cosmetic improvements (I didn't care for the random switches between "instr[0]" and "*instr" notation). Report and diagnosis by Alexander Lakhin (bug #17935). Back-patch to all supported branches. Discussion: https://postgr.es/m/17935-b99316aa79c18513@postgresql.org
diff --git a/contrib/fuzzystrmatch/expected/fuzzystrmatch.out b/contrib/fuzzystrmatch/expected/fuzzystrmatch.out
@@ -23,6 +23,12 @@ SELECT soundex('Anne'), soundex('Margaret'), difference('Anne', 'Margaret');
  A500    | M626    |          0
 (1 row)
 
+SELECT soundex(''), difference('', '');
+ soundex | difference 
+---------+------------
+         |          4
+(1 row)
+
 SELECT levenshtein('GUMBO', 'GAMBOL');
  levenshtein 
 -------------
diff --git a/contrib/fuzzystrmatch/fuzzystrmatch.c b/contrib/fuzzystrmatch/fuzzystrmatch.c
@@ -729,16 +729,14 @@ _soundex(const char *instr, char *outstr)
 	AssertArg(instr);
 	AssertArg(outstr);
 
-	outstr[SOUNDEX_LEN] = '\0';
-
 	/* Skip leading non-alphabetic characters */
-	while (!isalpha((unsigned char) instr[0]) && instr[0])
+	while (*instr && !isalpha((unsigned char) *instr))
 		++instr;
 
-	/* No string left */
-	if (!instr[0])
+	/* If no string left, return all-zeroes buffer */
+	if (!*instr)
 	{
-		outstr[0] = (char) 0;
+		memset(outstr, '\0', SOUNDEX_LEN + 1);
 		return;
 	}
 
@@ -751,7 +749,7 @@ _soundex(const char *instr, char *outstr)
 		if (isalpha((unsigned char) *instr) &&
 			soundex_code(*instr) != soundex_code(*(instr - 1)))
 		{
-			*outstr = soundex_code(instr[0]);
+			*outstr = soundex_code(*instr);
 			if (*outstr != '0')
 			{
 				++outstr;
@@ -768,6 +766,9 @@ _soundex(const char *instr, char *outstr)
 		++outstr;
 		++count;
 	}
+
+	/* And null-terminate */
+	*outstr = '\0';
 }
 
 PG_FUNCTION_INFO_V1(difference);
diff --git a/contrib/fuzzystrmatch/sql/fuzzystrmatch.sql b/contrib/fuzzystrmatch/sql/fuzzystrmatch.sql
@@ -6,6 +6,7 @@ SELECT soundex('hello world!');
 SELECT soundex('Anne'), soundex('Ann'), difference('Anne', 'Ann');
 SELECT soundex('Anne'), soundex('Andrew'), difference('Anne', 'Andrew');
 SELECT soundex('Anne'), soundex('Margaret'), difference('Anne', 'Margaret');
+SELECT soundex(''), difference('', '');
 
 
 SELECT levenshtein('GUMBO', 'GAMBOL');

Original file line number	Diff line number	Diff line change
`@@ -729,16 +729,14 @@ _soundex(const char instr, char outstr)`
`729`	`729`	`AssertArg(instr);`
`730`	`730`	`AssertArg(outstr);`
`731`	`731`
`732`		`- outstr[SOUNDEX_LEN] = '\0';`
`733`		`-`
`734`	`732`	`/* Skip leading non-alphabetic characters */`
`735`		`- while (!isalpha((unsigned char) instr[0]) && instr[0])`
	`733`	`+ while (instr && !isalpha((unsigned char) instr))`
`736`	`734`	`++instr;`
`737`	`735`
`738`		`- /* No string left */`
`739`		`- if (!instr[0])`
	`736`	`+ /* If no string left, return all-zeroes buffer */`
	`737`	`+ if (!*instr)`
`740`	`738`	`{`
`741`		`- outstr[0] = (char) 0;`
	`739`	`+ memset(outstr, '\0', SOUNDEX_LEN + 1);`
`742`	`740`	`return;`
`743`	`741`	`}`
`744`	`742`
`@@ -751,7 +749,7 @@ _soundex(const char instr, char outstr)`
`751`	`749`	`if (isalpha((unsigned char) *instr) &&`
`752`	`750`	`soundex_code(instr) != soundex_code((instr - 1)))`
`753`	`751`	`{`
`754`		`- *outstr = soundex_code(instr[0]);`
	`752`	`+ outstr = soundex_code(instr);`
`755`	`753`	`if (*outstr != '0')`
`756`	`754`	`{`
`757`	`755`	`++outstr;`
`@@ -768,6 +766,9 @@ _soundex(const char instr, char outstr)`
`768`	`766`	`++outstr;`
`769`	`767`	`++count;`
`770`	`768`	`}`
	`769`	`+`
	`770`	`+ /* And null-terminate */`
	`771`	`+ *outstr = '\0';`
`771`	`772`	`}`
`772`	`773`
`773`	`774`	`PG_FUNCTION_INFO_V1(difference);`