diff mbox series

[v2] parser: Fix handling of empty aliases

Message ID 20200427151526.GA26444@gondor.apana.org.au (mailing list archive)
State Accepted
Delegated to: Herbert Xu
Headers show
Series [v2] parser: Fix handling of empty aliases | expand

Commit Message

Herbert Xu April 27, 2020, 3:15 p.m. UTC
On Thu, May 09, 2019 at 03:46:43PM +0000, Michael Greenberg wrote:
> Dash was incorrectly handling empty aliases. When attempting to use an
> empty alias with nothing else, I'm (incorrectly) prompted for more
> input:
> 
> ```
> $ alias empty=''
> $ empty
> >
> ```
> 
> Other shells (e.g., bash, yash) correctly handle the lone, empty alias as an
> empty command:
> 
> ```
> $ alias empty=''
> $ empty
> $
> ```
> 
> This patch fixes the parser to handle the case where an alias is empty,
> i.e., produces no token.
> 
> Signed-off-by: Michael Greenberg <michael.greenberg@pomona.edu>

Thanks for the patch! I think your patch doesn't fix all the cases
though as it's also possible to encounter the problem if the alias
consists entirely of space characters.  Here is my attempt at the
problem.

---8<---
Dash was incorrectly handling empty aliases. When attempting to use an
empty alias with nothing else, I'm (incorrectly) prompted for more
input:

```
$ alias empty=''
$ empty
>
```

Other shells (e.g., bash, yash) correctly handle the lone, empty alias as an
empty command:

```
$ alias empty=''
$ empty
$
```

The problem here is that we incorrectly enter the loop eating TNLs
in readtoken().  This patch fixes it by setting checkkwd correctly.

Reported-by: Michael Greenberg <michael.greenberg@pomona.edu>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

Comments

Michael Greenberg April 27, 2020, 5:07 p.m. UTC | #1
On 2020-04-28 01:15:26, Herbert Xu <herbert@gondor.apana.org.au> wrote:

> On Thu, May 09, 2019 at 03:46:43PM +0000, Michael Greenberg wrote:
>> Dash was incorrectly handling empty aliases. When attempting to use an
>> empty alias with nothing else, I'm (incorrectly) prompted for more
>> input:
>>
>> ```
>> $ alias empty=''
>> $ empty
>> >
>> ```
>>
>> Other shells (e.g., bash, yash) correctly handle the lone, empty alias as an
>> empty command:
>>
>> ```
>> $ alias empty=''
>> $ empty
>> $
>> ```
>>
>> This patch fixes the parser to handle the case where an alias is empty,
>> i.e., produces no token.
>>
>> Signed-off-by: Michael Greenberg <michael.greenberg@pomona.edu>
>
> Thanks for the patch! I think your patch doesn't fix all the cases
> though as it's also possible to encounter the problem if the alias
> consists entirely of space characters.  Here is my attempt at the
> problem.

Yiiikes, that's subtle. Good catch, thanks! :)

I don't think the current documentation is enough for me to have
implemented your fix even if I had thought of the issue with spaces. If
someone who understands the parser well wants to spend some time
documenting it better, I'm sure it would come in handy for other folks.

Cheers,
Michael

> ---8<---
> Dash was incorrectly handling empty aliases. When attempting to use an
> empty alias with nothing else, I'm (incorrectly) prompted for more
> input:
>
> ```
> $ alias empty=''
> $ empty
>>
> ```
>
> Other shells (e.g., bash, yash) correctly handle the lone, empty alias as an
> empty command:
>
> ```
> $ alias empty=''
> $ empty
> $
> ```
>
> The problem here is that we incorrectly enter the loop eating TNLs
> in readtoken().  This patch fixes it by setting checkkwd correctly.
>
> Reported-by: Michael Greenberg <michael.greenberg@pomona.edu>
> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
>
> diff --git a/src/parser.c b/src/parser.c
> index b318b08..5c9e9a0 100644
> --- a/src/parser.c
> +++ b/src/parser.c
> @@ -115,7 +115,6 @@ STATIC union node *simplecmd(void);
>  STATIC union node *makename(void);
>  STATIC void parsefname(void);
>  STATIC void parseheredoc(void);
> -STATIC int peektoken(void);
>  STATIC int readtoken(void);
>  STATIC int xxreadtoken(void);
>  STATIC int pgetc_eatbnl();
> @@ -161,21 +160,23 @@ parsecmd(int interact)
>  STATIC union node *
>  list(int nlflag)
>  {
> +       int chknl = nlflag & 1 ? 0 : CHKNL;
>         union node *n1, *n2, *n3;
>         int tok;
>
>         n1 = NULL;
>         for (;;) {
> -               switch (readtoken()) {
> +               checkkwd = chknl | CHKKWD | CHKALIAS;
> +               tok = readtoken();
> +               switch (tok) {
>                 case TNL:
> -                       if (!(nlflag & 1))
> -                               break;
>                         parseheredoc();
>                         return n1;
>
>                 case TEOF:
> -                       if (!n1 && (nlflag & 1))
> +                       if (!n1 && !chknl)
>                                 n1 = NEOF;
> +out_eof:
>                         parseheredoc();
>                         tokpushback++;
>                         lasttoken = TEOF;
> @@ -183,8 +184,7 @@ list(int nlflag)
>                 }
>
>                 tokpushback++;
> -               checkkwd = CHKNL | CHKKWD | CHKALIAS;
> -               if (nlflag == 2 && tokendlist[peektoken()])
> +               if (nlflag == 2 && tokendlist[tok])
>                         return n1;
>                 nlflag |= 2;
>
> @@ -214,15 +214,16 @@ list(int nlflag)
>                         n1 = n3;
>                 }
>                 switch (tok) {
> -               case TNL:
>                 case TEOF:
> +                       goto out_eof;
> +               case TNL:
>                         tokpushback++;
>                         /* fall through */
>                 case TBACKGND:
>                 case TSEMI:
>                         break;
>                 default:
> -                       if ((nlflag & 1))
> +                       if (!chknl)
>                                 synexpect(-1);
>                         tokpushback++;
>                         return n1;
> @@ -685,16 +686,6 @@ parseheredoc(void)
>         }
>  }
>
> -STATIC int
> -peektoken(void)
> -{
> -       int t;
> -
> -       t = readtoken();
> -       tokpushback++;
> -       return (t);
> -}
> -
>  STATIC int
>  readtoken(void)
>  {
> --
> Email: Herbert Xu <herbert@gondor.apana.org.au>
> Home Page: https://nam01.safelinks.protection.outlook.com/?url=http:%2F%2Fgondor.apana.org.au%2F~herbert%2F&amp;data=02%7C01%7CMichael.Greenberg%40pomona.edu%7C5d04fbe7205242dfede408d7eabdd3b2%7C817f590439044ee8b3a5a65d4746ff70%7C0%7C0%7C637235973354290743&amp;sdata=yhd8GJ2xr4Pemyl3NWaN10vwYSWjI35bBWIBZlv0eis%3D&amp;reserved=0
> PGP Key: https://nam01.safelinks.protection.outlook.com/?url=http:%2F%2Fgondor.apana.org.au%2F~herbert%2Fpubkey.txt&amp;data=02%7C01%7CMichael.Greenberg%40pomona.edu%7C5d04fbe7205242dfede408d7eabdd3b2%7C817f590439044ee8b3a5a65d4746ff70%7C0%7C0%7C637235973354290743&amp;sdata=MK3ePSn71XHOmhfYIHr8lnKBnVQ%2BwEvEdZb%2BcLxGH%2F4%3D&amp;reserved=0
> ________________________________
>
> [EXTERNAL EMAIL] Exercise caution before clicking on links or opening attachments.
diff mbox series

Patch

diff --git a/src/parser.c b/src/parser.c
index b318b08..5c9e9a0 100644
--- a/src/parser.c
+++ b/src/parser.c
@@ -115,7 +115,6 @@  STATIC union node *simplecmd(void);
 STATIC union node *makename(void);
 STATIC void parsefname(void);
 STATIC void parseheredoc(void);
-STATIC int peektoken(void);
 STATIC int readtoken(void);
 STATIC int xxreadtoken(void);
 STATIC int pgetc_eatbnl();
@@ -161,21 +160,23 @@  parsecmd(int interact)
 STATIC union node *
 list(int nlflag)
 {
+	int chknl = nlflag & 1 ? 0 : CHKNL;
 	union node *n1, *n2, *n3;
 	int tok;
 
 	n1 = NULL;
 	for (;;) {
-		switch (readtoken()) {
+		checkkwd = chknl | CHKKWD | CHKALIAS;
+		tok = readtoken();
+		switch (tok) {
 		case TNL:
-			if (!(nlflag & 1))
-				break;
 			parseheredoc();
 			return n1;
 
 		case TEOF:
-			if (!n1 && (nlflag & 1))
+			if (!n1 && !chknl)
 				n1 = NEOF;
+out_eof:
 			parseheredoc();
 			tokpushback++;
 			lasttoken = TEOF;
@@ -183,8 +184,7 @@  list(int nlflag)
 		}
 
 		tokpushback++;
-		checkkwd = CHKNL | CHKKWD | CHKALIAS;
-		if (nlflag == 2 && tokendlist[peektoken()])
+		if (nlflag == 2 && tokendlist[tok])
 			return n1;
 		nlflag |= 2;
 
@@ -214,15 +214,16 @@  list(int nlflag)
 			n1 = n3;
 		}
 		switch (tok) {
-		case TNL:
 		case TEOF:
+			goto out_eof;
+		case TNL:
 			tokpushback++;
 			/* fall through */
 		case TBACKGND:
 		case TSEMI:
 			break;
 		default:
-			if ((nlflag & 1))
+			if (!chknl)
 				synexpect(-1);
 			tokpushback++;
 			return n1;
@@ -685,16 +686,6 @@  parseheredoc(void)
 	}
 }
 
-STATIC int
-peektoken(void)
-{
-	int t;
-
-	t = readtoken();
-	tokpushback++;
-	return (t);
-}
-
 STATIC int
 readtoken(void)
 {