Revert "ShellPkg: Fix echo to support displaying special characters"

This reverts commit 95fc5a877502a6e6324300eed0136243d359fa96.
The above commit causes several regression of "echo" command:
1. Double quotes are not being stripped from the final text. UEFI Shell 2.2 section 3.4.5 chops out the quotes.
2. Output redirection is not working as expected. Text is being redirected, but the ‘> …’ text should not be.
3. Inconsistent special character handling.  For example, comments with # seem to be parsed out correctly, but handing of ^ is incorrect.
In summary, ‘echo “You are ^#1” > t.txt’ results in the below content in t.txt:
 “You are ^#1” > t.txt

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Tapan Shah <tapandshah@hpe.com>

2 files changed, 81 insertions, 63 deletions

diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/Echo.c b/ShellPkg/Library/UefiShellLevel3CommandsLib/Echo.c
index c98ee8500b..a638de8ce2 100644
--- a/ShellPkg/Library/UefiShellLevel3CommandsLib/Echo.c
+++ b/ShellPkg/Library/UefiShellLevel3CommandsLib/Echo.c
@@ -2,7 +2,7 @@
   Main file for Echo shell level 3 function.

 

   (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>

-  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved. <BR>

+  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved. <BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -17,6 +17,12 @@
 

 #include <Library/ShellLib.h>

 

+STATIC CONST SHELL_PARAM_ITEM ParamList[] = {

+  {L"-on", TypeFlag},

+  {L"-off", TypeFlag},

+  {NULL, TypeMax}

+  };

+

 /**

   Function for 'echo' command.

 

@@ -30,73 +36,86 @@ ShellCommandRunEcho (
   IN EFI_SYSTEM_TABLE  *SystemTable

   )

 {

-  CHAR16              *RawCmdLine;

-  SHELL_STATUS        Status;

+  EFI_STATUS          Status;

+  LIST_ENTRY          *Package;

+  SHELL_STATUS        ShellStatus;

+  UINTN               ParamCount;

+  CHAR16              *ProblemParam;

   UINTN               Size;

-  CHAR16              *Walker;

-  CHAR16              *TempParameter;

-  BOOLEAN             OnFlag;

-  BOOLEAN             OffFlag;

-  UINTN               Count;

-

-  RawCmdLine = ShellGetRawCmdLine ();

-  if (RawCmdLine == NULL) {

-    return SHELL_OUT_OF_RESOURCES;

-  }

-

-  OnFlag  = FALSE;

-  OffFlag = FALSE;

-

-  Size = StrSize (RawCmdLine);

-  TempParameter  = AllocateZeroPool(Size);

-  if (TempParameter == NULL) {

-    Status = SHELL_OUT_OF_RESOURCES;

-    goto Done;

-  }

-

-  for ( Count = 0

-      , Walker = RawCmdLine

-      ; Walker != NULL && *Walker != CHAR_NULL

-      ; Count++

-      ) {

-    if (EFI_ERROR (ShellGetNextParameter (&Walker, TempParameter, Size, FALSE))) {

-      break;

+  CHAR16              *PrintString;

+

+  Size                = 0;

+  ProblemParam        = NULL;

+  PrintString         = NULL;

+  ShellStatus         = SHELL_SUCCESS;

+

+  //

+  // initialize the shell lib (we must be in non-auto-init...)

+  //

+  Status = ShellInitialize();

+  ASSERT_EFI_ERROR(Status);

+

+  //

+  // parse the command line

+  //

+  Status = ShellCommandLineParseEx (ParamList, &Package, &ProblemParam, TRUE, TRUE);

+  if (EFI_ERROR(Status)) {

+    if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {

+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, L"echo", ProblemParam);  

+      FreePool(ProblemParam);

+      ShellStatus = SHELL_INVALID_PARAMETER;

+    } else {

+      ASSERT(FALSE);

     }

-

-    if (Count == 1) {

-      if (gUnicodeCollation->StriColl(gUnicodeCollation, TempParameter, L"-on") == 0 ) {

-        OnFlag = TRUE;

+  } else {

+    //

+    // check for "-?"

+    //

+    if (ShellCommandLineGetFlag(Package, L"-?")) {

+      ASSERT(FALSE);

+    }

+    if (ShellCommandLineGetFlag(Package, L"-on")) {

+      //

+      // Turn it on

+      //

+      ShellCommandSetEchoState(TRUE);

+    } else if (ShellCommandLineGetFlag(Package, L"-off")) {

+      //

+      // turn it off

+      //

+      ShellCommandSetEchoState(FALSE);

+    } else if (ShellCommandLineGetRawValue(Package, 1) == NULL) {

+      //

+      // output its current state

+      //

+      if (ShellCommandGetEchoState()) {

+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_ECHO_ON), gShellLevel3HiiHandle);

+      } else {

+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_ECHO_OFF), gShellLevel3HiiHandle);

       }

-      if (gUnicodeCollation->StriColl(gUnicodeCollation, TempParameter, L"-off") == 0 ) {

-        OffFlag = TRUE;

+    } else {

+      //

+      // print the line

+      //

+      for ( ParamCount = 1

+          ; ShellCommandLineGetRawValue(Package, ParamCount) != NULL

+          ; ParamCount++

+         ) {

+        StrnCatGrow(&PrintString, &Size, ShellCommandLineGetRawValue(Package, ParamCount), 0);

+        if (ShellCommandLineGetRawValue(Package, ParamCount+1) != NULL) {

+          StrnCatGrow(&PrintString, &Size, L" ", 0);

+        } 

       }

-    }

-  }

-

-  if (OnFlag || OffFlag) {

-    if (Count != 2) {

-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_ECHO_INVALID_PARAM), gShellLevel3HiiHandle, L"echo", L"-on/-off");

-      Status = SHELL_INVALID_PARAMETER;

-      goto Done;

+      ShellPrintEx(-1, -1, L"%s\r\n", PrintString);

+      SHELL_FREE_NON_NULL(PrintString);

     }

 

-    ShellCommandSetEchoState(OnFlag);

-    Status = SHELL_SUCCESS;

-    goto Done;

+    //

+    // free the command line package

+    //

+    ShellCommandLineFreeVarList (Package);

   }

 

-  Walker = RawCmdLine + StrLen (L"echo");

-  if  (*Walker != CHAR_NULL) {

-    Walker++;

-    ShellPrintEx (-1, -1, L"%s\r\n", Walker);

-  }

-

-  Status = SHELL_SUCCESS;

-

-Done:

-  SHELL_FREE_NON_NULL (TempParameter);

-  SHELL_FREE_NON_NULL (RawCmdLine);

-  return Status;

-

+  return (ShellStatus);

 }

 

diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
index eeb870a395..fc9c5d447c 100644
--- a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
@@ -1,7 +1,7 @@
 // /**

 //

 // (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>

-// Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved. <BR>

+// Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved. <BR>

 // This program and the accompanying materials

 // are licensed and made available under the terms and conditions of the BSD License

 // which accompanies this distribution. The full text of the license may be found at

@@ -55,7 +55,6 @@
 

 #string STR_ECHO_ON               #language en-US "Echo is on.\r\n"

 #string STR_ECHO_OFF              #language en-US "Echo is off.\r\n"

-#string STR_ECHO_INVALID_PARAM    #language en-US "%H%s%N: Invalid  - too many parameters after '%s'\r\n"

 

 #string STR_PAUSE_PROMPT          #language en-US "Enter 'q' to quit, any other key to continue:\r\n"