ShellPkg: Fix echo to support displaying special characters

Run 'echo -t' without the patch will get the result:
  echo: Unknown flag - '-t'
  The expected result is to display '-t' literally.
  This patch adds special handle for 'echo'. 'echo' will not use the
  general parameter parsing library.

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

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 - 2012, Intel Corporation. All rights reserved. <BR>
+  Copyright (c) 2009 - 2016, 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,12 +17,6 @@
 
 #include <Library/ShellLib.h>
 
-STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
-  {L"-on", TypeFlag},
-  {L"-off", TypeFlag},
-  {NULL, TypeMax}
-  };
-
 /**
   Function for 'echo' command.
 
@@ -36,86 +30,73 @@ ShellCommandRunEcho (
   IN EFI_SYSTEM_TABLE  *SystemTable
   )
 {
-  EFI_STATUS          Status;
+  CHAR16              *RawCmdLine;
-  LIST_ENTRY          *Package;
+  SHELL_STATUS        Status;
-  SHELL_STATUS        ShellStatus;
-  UINTN               ParamCount;
-  CHAR16              *ProblemParam;
   UINTN               Size;
-  CHAR16              *PrintString;
+  CHAR16              *Walker;
+  CHAR16              *TempParameter;
+  BOOLEAN             OnFlag;
+  BOOLEAN             OffFlag;
+  UINTN               Count;
 
-  Size                = 0;
+  RawCmdLine = ShellGetRawCmdLine ();
-  ProblemParam        = NULL;
+  if (RawCmdLine == NULL) {
-  PrintString         = NULL;
+    return SHELL_OUT_OF_RESOURCES;
-  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);
-    }
-  } 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);
-      }
-    } 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);
-        } 
-      }
-      ShellPrintEx(-1, -1, L"%s\r\n", PrintString);
-      SHELL_FREE_NON_NULL(PrintString);
-    }
-
-    //
-    // free the command line package
-    //
-    ShellCommandLineFreeVarList (Package);
   }
 
-  return (ShellStatus);
+  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;
+    }
+
+    if (Count == 1) {
+      if (gUnicodeCollation->StriColl(gUnicodeCollation, TempParameter, L"-on") == 0 ) {
+        OnFlag = TRUE;
+      }
+      if (gUnicodeCollation->StriColl(gUnicodeCollation, TempParameter, L"-off") == 0 ) {
+        OffFlag = TRUE;
+      }
+    }
+  }
+
+  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;
+    }
+
+    ShellCommandSetEchoState(OnFlag);
+    Status = SHELL_SUCCESS;
+    goto Done;
+  }
+
+  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;
+
 }
 

ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni

@@ -1,7 +1,7 @@
 // /**
 //
 // (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
-// Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved. <BR>
+// Copyright (c) 2009 - 2016, 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,6 +55,7 @@
 
 #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"