udk2010.up2.shell initial release.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10874 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 564 insertions, 0 deletions

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
new file mode 100644
index 0000000000..61d48977f1
--- /dev/null
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
@@ -0,0 +1,564 @@
+/** @file

+  Main file for ls shell level 2 function.

+

+  Copyright (c) 2009 - 2010, 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

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#include "UefiShellLevel2CommandsLib.h"

+#include <Guid/FileSystemInfo.h>

+

+/**

+  print out the list of files and directories from the LS command

+

+  @param[in] Rec            TRUE to automatically recurse into each found directory

+                            FALSE to only list the specified directory.

+  @param[in] Attribs        List of required Attribute for display.

+                            If 0 then all non-system and non-hidden files will be printed.

+  @param[in] Sfo            TRUE to use Standard Format Output, FALSE otherwise

+  @param[in] Path           String with starting path.

+  @param[in] First          TRUE for the original and FALSE for any recursion spawned instances.

+  @param[in] Count          The count of bits enabled in Attribs.

+  @param[in] TimeZone       The current time zone offset.

+

+  @retval SHELL_SUCCESS     the printing was sucessful.

+**/

+SHELL_STATUS

+EFIAPI

+PrintLsOutput(

+  IN CONST BOOLEAN Rec,

+  IN CONST UINT64  Attribs,

+  IN CONST BOOLEAN Sfo,

+  IN CONST CHAR16  *Path,

+  IN CONST BOOLEAN First,

+  IN CONST UINTN   Count,

+  IN CONST INT16   TimeZone

+  )

+{

+  EFI_STATUS            Status;

+  EFI_SHELL_FILE_INFO   *ListHead;

+  EFI_SHELL_FILE_INFO   *Node;

+  SHELL_STATUS          ShellStatus;

+  UINT64                FileCount;

+  UINT64                DirCount;

+  UINT64                FileSize;

+  CHAR16                *DirectoryName;

+  UINTN                 LongestPath;

+  EFI_FILE_SYSTEM_INFO  *SysInfo;

+  UINTN                 SysInfoSize;

+  SHELL_FILE_HANDLE     ShellFileHandle;

+  CHAR16                *CorrectedPath;

+  EFI_FILE_PROTOCOL     *EfiFpHandle;

+

+  FileCount     = 0;

+  DirCount      = 0;

+  FileSize      = 0;

+  ListHead      = NULL;

+  ShellStatus   = SHELL_SUCCESS;

+  LongestPath   = 0;

+  CorrectedPath = NULL;

+

+  CorrectedPath = StrnCatGrow(&CorrectedPath, NULL, Path, 0);

+  ASSERT(CorrectedPath != NULL);

+  ShellCommandCleanPath(CorrectedPath);

+

+  Status = ShellOpenFileMetaArg((CHAR16*)CorrectedPath, EFI_FILE_MODE_READ, &ListHead);

+  if (EFI_ERROR(Status)) {

+    return (SHELL_DEVICE_ERROR);

+  }

+  if (ListHead == NULL || IsListEmpty(&ListHead->Link)) {

+    //

+    // On the first one only we expect to find something...

+    // do we find the . and .. directories otherwise?

+    //

+    if (First) {

+      return (SHELL_NOT_FOUND);

+    }

+    return (SHELL_SUCCESS);

+  }

+

+  if (Sfo && First) {

+    //

+    // Get the first valid handle (directories)

+    //

+    for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)

+        ; !IsNull(&ListHead->Link, &Node->Link) && Node->Handle == NULL

+        ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)

+       );

+

+    if (Node->Handle == NULL) {

+      DirectoryName = GetFullyQualifiedPath(((EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link))->FullName);

+

+      //

+      // We need to open something up to get system information

+      //

+      Status = gEfiShellProtocol->OpenFileByName(

+        DirectoryName,

+        &ShellFileHandle,

+        EFI_FILE_MODE_READ);

+

+      ASSERT_EFI_ERROR(Status);

+      FreePool(DirectoryName);

+

+      //

+      // Get the Volume Info from ShellFileHandle

+      //

+      SysInfo     = NULL;

+      SysInfoSize = 0;

+      EfiFpHandle = ConvertShellHandleToEfiFileProtocol(ShellFileHandle);

+      Status = EfiFpHandle->GetInfo(

+        EfiFpHandle,

+        &gEfiFileSystemInfoGuid,

+        &SysInfoSize,

+        SysInfo);

+

+      if (Status == EFI_BUFFER_TOO_SMALL) {

+        SysInfo = AllocateZeroPool(SysInfoSize);

+        Status = EfiFpHandle->GetInfo(

+          EfiFpHandle,

+          &gEfiFileSystemInfoGuid,

+          &SysInfoSize,

+          SysInfo);

+      }

+

+      ASSERT_EFI_ERROR(Status);

+

+      gEfiShellProtocol->CloseFile(ShellFileHandle);

+    } else {

+      //

+      // Get the Volume Info from Node->Handle

+      //

+      SysInfo = NULL;

+      SysInfoSize = 0;

+      EfiFpHandle = ConvertShellHandleToEfiFileProtocol(Node->Handle);

+      Status = EfiFpHandle->GetInfo(

+        EfiFpHandle,

+        &gEfiFileSystemInfoGuid,

+        &SysInfoSize,

+        SysInfo);

+

+      if (Status == EFI_BUFFER_TOO_SMALL) {

+        SysInfo = AllocateZeroPool(SysInfoSize);

+        Status = EfiFpHandle->GetInfo(

+          EfiFpHandle,

+          &gEfiFileSystemInfoGuid,

+          &SysInfoSize,

+          SysInfo);

+      }

+

+      ASSERT_EFI_ERROR(Status);

+    }

+

+    ShellPrintHiiEx (

+      -1,

+      -1,

+      NULL,

+      STRING_TOKEN (STR_GEN_SFO_HEADER),

+      gShellLevel2HiiHandle,

+      L"ls");

+    //

+    // print VolumeInfo table

+    //

+    ASSERT(SysInfo != NULL);

+    ShellPrintHiiEx (

+      0,

+      gST->ConOut->Mode->CursorRow,

+      NULL,

+      STRING_TOKEN (STR_LS_SFO_VOLINFO),

+      gShellLevel2HiiHandle,

+      SysInfo->VolumeLabel,

+      SysInfo->VolumeSize,

+      SysInfo->ReadOnly?L"TRUE":L"FALSE",

+      SysInfo->FreeSpace,

+      SysInfo->BlockSize

+     );

+    if (SysInfo != NULL) {

+      FreePool(SysInfo);

+    }

+  }

+

+  if (!Sfo) {

+    //

+    // get directory name from path...

+    //

+    DirectoryName = GetFullyQualifiedPath(CorrectedPath);

+

+    //

+    // print header

+    //

+    ShellPrintHiiEx (

+      0,

+      gST->ConOut->Mode->CursorRow,

+      NULL,

+      STRING_TOKEN (STR_LS_HEADER_LINE1),

+      gShellLevel2HiiHandle,

+      DirectoryName

+     );

+    FreePool(DirectoryName);

+  }

+  for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)

+      ; !IsNull(&ListHead->Link, &Node->Link)

+      ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)

+     ){

+    ASSERT(Node != NULL);

+    if (LongestPath < StrSize(Node->FullName)) {

+      LongestPath = StrSize(Node->FullName);

+    }

+    ASSERT(Node->Info != NULL);

+    ASSERT((Node->Info->Attribute & EFI_FILE_VALID_ATTR) == Node->Info->Attribute);

+    if (Attribs == 0) {

+      //

+      // NOT system & NOT hidden

+      //

+      if ( (Node->Info->Attribute & EFI_FILE_SYSTEM)

+        || (Node->Info->Attribute & EFI_FILE_HIDDEN)

+       ){

+        continue;

+      }

+    } else if (Attribs != EFI_FILE_VALID_ATTR) {

+      if (Count == 1) {

+        //

+        // the bit must match

+        //

+        if ( (Node->Info->Attribute & Attribs) != Attribs) {

+          continue;

+        }

+      } else {

+        //

+        // exact match on all bits

+        //

+        if ( Node->Info->Attribute != Attribs) {

+          continue;

+        }

+      }

+    }

+

+    if (Sfo) {

+      //

+      // Print the FileInfo Table

+      //

+    ShellPrintHiiEx (

+      0,

+      gST->ConOut->Mode->CursorRow,

+      NULL,

+      STRING_TOKEN (STR_LS_SFO_FILEINFO),

+      gShellLevel2HiiHandle,

+      Node->FullName,

+      Node->Info->FileSize,

+      Node->Info->PhysicalSize,

+      (Node->Info->Attribute & EFI_FILE_ARCHIVE)   != 0?L"a":L"",

+      (Node->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"d":L"",

+      (Node->Info->Attribute & EFI_FILE_HIDDEN)    != 0?L"h":L"",

+      (Node->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L"r":L"",

+      (Node->Info->Attribute & EFI_FILE_SYSTEM)    != 0?L"s":L"",

+      Node->Info->CreateTime.Hour,

+      Node->Info->CreateTime.Minute,

+      Node->Info->CreateTime.Second,

+      Node->Info->CreateTime.Day,

+      Node->Info->CreateTime.Month,

+      Node->Info->CreateTime.Year,

+      Node->Info->LastAccessTime.Hour,

+      Node->Info->LastAccessTime.Minute,

+      Node->Info->LastAccessTime.Second,

+      Node->Info->LastAccessTime.Day,

+      Node->Info->LastAccessTime.Month,

+      Node->Info->LastAccessTime.Year,

+      Node->Info->ModificationTime.Hour,

+      Node->Info->ModificationTime.Minute,

+      Node->Info->ModificationTime.Second,

+      Node->Info->ModificationTime.Day,

+      Node->Info->ModificationTime.Month,

+      Node->Info->ModificationTime.Year

+     );

+    } else {

+      //

+      // print this one out...

+      // first print the universal start, next print the type specific name format, last print the CRLF

+      //

+      ShellPrintHiiEx (

+        -1,

+        -1,

+        NULL,

+        STRING_TOKEN (STR_LS_LINE_START_ALL),

+        gShellLevel2HiiHandle,

+        &Node->Info->ModificationTime,

+        (Node->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"<DIR>":L"",

+        (Node->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L'r':L' ',

+        Node->Info->FileSize

+       );

+      if (Node->Info->Attribute & EFI_FILE_DIRECTORY) {

+        DirCount++;

+        ShellPrintHiiEx (

+          -1,

+          -1,

+          NULL,

+          STRING_TOKEN (STR_LS_LINE_END_DIR),

+          gShellLevel2HiiHandle,

+          Node->FileName

+         );

+      } else {

+        FileCount++;

+        FileSize += Node->Info->FileSize;

+        if ( (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".nsh", (CHAR16*)&(Node->FileName[StrLen (Node->FileName) - 4])) == 0)

+          || (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".efi", (CHAR16*)&(Node->FileName[StrLen (Node->FileName) - 4])) == 0)

+         ){

+          ShellPrintHiiEx (

+            -1,

+            -1,

+            NULL,

+            STRING_TOKEN (STR_LS_LINE_END_EXE),

+            gShellLevel2HiiHandle,

+            Node->FileName

+           );

+        } else {

+          ShellPrintHiiEx (

+            -1,

+            -1,

+            NULL,

+            STRING_TOKEN (STR_LS_LINE_END_FILE),

+            gShellLevel2HiiHandle,

+            Node->FileName

+           );

+        }

+      }

+    }

+  }

+

+  if (!Sfo) {

+    //

+    // print footer

+    //

+    ShellPrintHiiEx (

+      -1,

+      -1,

+      NULL,

+      STRING_TOKEN (STR_LS_FOOTER_LINE),

+      gShellLevel2HiiHandle,

+      FileCount,

+      FileSize,

+      DirCount

+     );

+  }

+

+  if (Rec){

+    DirectoryName = AllocatePool(LongestPath + 2*sizeof(CHAR16));

+    for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)

+        ; !IsNull(&ListHead->Link, &Node->Link)

+        ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)

+       ){

+      //

+      // recurse on any directory except the traversing ones...

+      //

+      if (((Node->Info->Attribute & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY)

+        && StrCmp(Node->FileName, L".") != 0

+        && StrCmp(Node->FileName, L"..") != 0

+       ){

+        StrCpy(DirectoryName, Node->FullName);

+        StrCat(DirectoryName, L"\\*");

+        PrintLsOutput(

+          Rec,

+          Attribs,

+          Sfo,

+          DirectoryName,

+          FALSE,

+          Count,

+          TimeZone);

+      }

+    }

+    FreePool(DirectoryName);

+  }

+

+  FreePool(CorrectedPath);

+  ShellCloseFileMetaArg(&ListHead);

+  FreePool(ListHead);

+  return (ShellStatus);

+}

+

+STATIC CONST SHELL_PARAM_ITEM LsParamList[] = {

+  {L"-r", TypeFlag},

+  {L"-a", TypeStart},

+  {L"-sfo", TypeFlag},

+  {NULL, TypeMax}

+  };

+

+/**

+  Function for 'ls' command.

+

+  @param[in] ImageHandle  Handle to the Image (NULL if Internal).

+  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).

+**/

+SHELL_STATUS

+EFIAPI

+ShellCommandRunLs (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+{

+  EFI_STATUS    Status;

+  LIST_ENTRY    *Package;

+  CHAR16        *ProblemParam;

+  CONST CHAR16  *Attribs;

+  SHELL_STATUS  ShellStatus;

+  UINT64        RequiredAttributes;

+  CONST CHAR16  *PathName;

+  CONST CHAR16  *CurDir;

+  UINTN         Count;

+  CHAR16        *FullPath;

+  UINTN         Size;

+  EFI_TIME      theTime;

+  BOOLEAN       SfoMode;

+

+  Size                = 0;

+  FullPath            = NULL;

+  ProblemParam        = NULL;

+  Attribs             = NULL;

+  ShellStatus         = SHELL_SUCCESS;

+  RequiredAttributes  = 0;

+  PathName            = NULL;

+  CurDir              = NULL;

+  Count               = 0;

+

+  //

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

+  //

+  Status = ShellInitialize();

+  ASSERT_EFI_ERROR(Status);

+

+  //

+  // Fix local copies of the protocol pointers

+  //

+  Status = CommandInit();

+  ASSERT_EFI_ERROR(Status);

+

+  //

+  // parse the command line

+  //

+  Status = ShellCommandLineParse (LsParamList, &Package, &ProblemParam, TRUE);

+  if (EFI_ERROR(Status)) {

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

+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);

+      FreePool(ProblemParam);

+      ShellStatus = SHELL_INVALID_PARAMETER;

+    } else {

+      ASSERT(FALSE);

+    }

+  } else {

+    //

+    // check for "-?"

+    //

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

+      ASSERT(FALSE);

+    }

+

+    if (ShellCommandLineGetCount(Package) > 2) {

+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel2HiiHandle);

+      ShellStatus = SHELL_INVALID_PARAMETER;

+    } else {

+      //

+      // check for -a

+      //

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

+        for ( Attribs = ShellCommandLineGetValue(Package, L"-a")

+            ; Attribs != NULL && *Attribs != CHAR_NULL && ShellStatus == SHELL_SUCCESS

+            ; Attribs++

+           ){

+          switch (*Attribs) {

+            case L'a':

+            case L'A':

+              RequiredAttributes |= EFI_FILE_ARCHIVE;

+              Count++;

+              continue;

+            case L's':

+            case L'S':

+              RequiredAttributes |= EFI_FILE_SYSTEM;

+              Count++;

+              continue;

+            case L'h':

+            case L'H':

+              RequiredAttributes |= EFI_FILE_HIDDEN;

+              Count++;

+              continue;

+            case L'r':

+            case L'R':

+              RequiredAttributes |= EFI_FILE_READ_ONLY;

+              Count++;

+              continue;

+            case L'd':

+            case L'D':

+              RequiredAttributes |= EFI_FILE_DIRECTORY;

+              Count++;

+              continue;

+            default:

+              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ATTRIBUTE), gShellLevel2HiiHandle, ShellCommandLineGetValue(Package, L"-a"));

+              ShellStatus = SHELL_INVALID_PARAMETER;

+              break;

+          } // switch

+        } // for loop

+        //

+        // if nothing is specified all are specified

+        //

+        if (RequiredAttributes == 0) {

+          RequiredAttributes = EFI_FILE_VALID_ATTR;

+        }

+      } // if -a present

+      if (ShellStatus == SHELL_SUCCESS) {

+        PathName = ShellCommandLineGetRawValue(Package, 1);

+        if (PathName == NULL) {

+          CurDir = gEfiShellProtocol->GetCurDir(NULL);

+          if (CurDir == NULL) {

+            ShellStatus = SHELL_NOT_FOUND;

+            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_CWD), gShellLevel2HiiHandle);

+          }

+        }

+        if (PathName != NULL) {

+          ASSERT((FullPath == NULL && Size == 0) || (FullPath != NULL));

+          StrnCatGrow(&FullPath, &Size, PathName, 0);

+          if  (ShellIsDirectory(PathName) == EFI_SUCCESS) {

+            StrnCatGrow(&FullPath, &Size, L"\\*", 0);

+          }

+        } else {

+          ASSERT(FullPath == NULL);

+          StrnCatGrow(&FullPath, NULL, L"*", 0);

+        }

+        Status = gRT->GetTime(&theTime, NULL);

+        ASSERT_EFI_ERROR(Status);

+        SfoMode = ShellCommandLineGetFlag(Package, L"-sfo");

+        if (ShellStatus == SHELL_SUCCESS) {

+          ShellStatus = PrintLsOutput(

+            ShellCommandLineGetFlag(Package, L"-r"),

+            RequiredAttributes,

+            SfoMode,

+            FullPath,

+            TRUE,

+            Count,

+            (INT16)(theTime.TimeZone==2047?0:theTime.TimeZone)

+           );

+          if (ShellStatus == SHELL_NOT_FOUND) {

+            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_FILES), gShellLevel2HiiHandle);

+          } else if (ShellStatus == SHELL_INVALID_PARAMETER) {

+            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel2HiiHandle);

+          } else if (ShellStatus != SHELL_SUCCESS) {

+            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel2HiiHandle);

+          }

+        }

+      }

+    }

+  }

+

+  if (FullPath != NULL) {

+    FreePool(FullPath);

+  }

+  //

+  // free the command line package

+  //

+  ShellCommandLineFreeVarList (Package);

+

+  return (ShellStatus);

+}