ShellPkg: Apply uncrustify changes

[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel3CommandsLib / Touch.c

/** @file\r
  Main file for Touch shell level 3 function.\r
\r
  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved. <BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UefiShellLevel3CommandsLib.h"\r
\r
#include <Library/ShellLib.h>\r
\r
/**\r
  Do the touch operation on a single handle.\r
\r
  @param[in] Handle   The handle to update the date/time on.\r
\r
  @retval EFI_ACCESS_DENIED The file referenced by Handle is read only.\r
  @retval EFI_SUCCESS       The operation was successful.\r
**/\r
EFI_STATUS\r
TouchFileByHandle (\r
  IN SHELL_FILE_HANDLE  Handle\r
  )\r
{\r
  EFI_STATUS     Status;\r
  EFI_FILE_INFO  *FileInfo;\r
\r
  FileInfo = gEfiShellProtocol->GetFileInfo (Handle);\r
  if ((FileInfo->Attribute & EFI_FILE_READ_ONLY) != 0) {\r
    return (EFI_ACCESS_DENIED);\r
  }\r
\r
  Status = gRT->GetTime (&FileInfo->ModificationTime, NULL);\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, L"gRT->GetTime", Status);\r
    return (SHELL_DEVICE_ERROR);\r
  }\r
\r
  CopyMem (&FileInfo->LastAccessTime, &FileInfo->ModificationTime, sizeof (EFI_TIME));\r
\r
  Status = gEfiShellProtocol->SetFileInfo (Handle, FileInfo);\r
\r
  FreePool (FileInfo);\r
\r
  return (Status);\r
}\r
\r
/**\r
  Touch a given file and potantially recurse down if it was a directory.\r
\r
  @param[in] Name   The name of this file.\r
  @param[in] FS     The name of the file system this file is on.\r
  @param[in] Handle The handle of this file already opened.\r
  @param[in] Rec    TRUE to recurse if possible.\r
\r
  @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
DoTouchByHandle (\r
  IN CONST CHAR16       *Name,\r
  IN       CHAR16       *FS,\r
  IN SHELL_FILE_HANDLE  Handle,\r
  IN BOOLEAN            Rec\r
  )\r
{\r
  EFI_STATUS           Status;\r
  EFI_SHELL_FILE_INFO  *FileList;\r
  EFI_SHELL_FILE_INFO  *Walker;\r
  CHAR16               *TempSpot;\r
\r
  Status   = EFI_SUCCESS;\r
  FileList = NULL;\r
  Walker   = NULL;\r
\r
  if (FS == NULL) {\r
    FS = StrnCatGrow (&FS, NULL, Name, 0);\r
    if (FS != NULL) {\r
      TempSpot = StrStr (FS, L"\\");\r
      if (TempSpot != NULL) {\r
        *TempSpot = CHAR_NULL;\r
      }\r
    }\r
  }\r
\r
  if (FS == NULL) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  //\r
  // do it\r
  //\r
  Status = TouchFileByHandle (Handle);\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel3HiiHandle, L"touch", Name);\r
    return (Status);\r
  }\r
\r
  //\r
  // if it's a directory recurse...\r
  //\r
  if ((FileHandleIsDirectory (Handle) == EFI_SUCCESS) && Rec) {\r
    //\r
    // get each file under this directory\r
    //\r
    if (EFI_ERROR (gEfiShellProtocol->FindFilesInDir (Handle, &FileList))) {\r
      Status = EFI_INVALID_PARAMETER;\r
    }\r
\r
    //\r
    // recurse on each\r
    //\r
    for (Walker = (EFI_SHELL_FILE_INFO *)GetFirstNode (&FileList->Link)\r
         ; FileList != NULL && !IsNull (&FileList->Link, &Walker->Link) && !EFI_ERROR (Status)\r
         ; Walker = (EFI_SHELL_FILE_INFO *)GetNextNode (&FileList->Link, &Walker->Link)\r
         )\r
    {\r
      if (  (StrCmp (Walker->FileName, L".") != 0)\r
         && (StrCmp (Walker->FileName, L"..") != 0)\r
            )\r
      {\r
        //\r
        // Open the file since we need that handle.\r
        //\r
        Status = gEfiShellProtocol->OpenFileByName (Walker->FullName, &Walker->Handle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE);\r
        if (EFI_ERROR (Status)) {\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel3HiiHandle, L"touch", Walker->FullName);\r
          Status = EFI_ACCESS_DENIED;\r
        } else {\r
          Status = DoTouchByHandle (Walker->FullName, FS, Walker->Handle, TRUE);\r
          gEfiShellProtocol->CloseFile (Walker->Handle);\r
          Walker->Handle = NULL;\r
        }\r
      }\r
    }\r
\r
    //\r
    // free stuff\r
    //\r
    if ((FileList != NULL) && EFI_ERROR (gEfiShellProtocol->FreeFileList (&FileList))) {\r
      Status = EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  return (Status);\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM  ParamList[] = {\r
  { L"-r", TypeFlag },\r
  { NULL,  TypeMax  }\r
};\r
\r
/**\r
  Function for 'touch' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunTouch (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS           Status;\r
  LIST_ENTRY           *Package;\r
  CHAR16               *ProblemParam;\r
  CONST CHAR16         *Param;\r
  SHELL_STATUS         ShellStatus;\r
  UINTN                ParamCount;\r
  EFI_SHELL_FILE_INFO  *FileList;\r
  EFI_SHELL_FILE_INFO  *Node;\r
\r
  ProblemParam = NULL;\r
  ShellStatus  = SHELL_SUCCESS;\r
  ParamCount   = 0;\r
  FileList     = NULL;\r
\r
  //\r
  // initialize the shell lib (we must be in non-auto-init...)\r
  //\r
  Status = ShellInitialize ();\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = CommandInit ();\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // parse the command line\r
  //\r
  Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
  if (EFI_ERROR (Status)) {\r
    if ((Status == EFI_VOLUME_CORRUPTED) && (ProblemParam != NULL)) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, L"touch", ProblemParam);\r
      FreePool (ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT (FALSE);\r
    }\r
  } else {\r
    //\r
    // check for "-?"\r
    //\r
    if (ShellCommandLineGetFlag (Package, L"-?")) {\r
      ASSERT (FALSE);\r
    }\r
\r
    if (ShellCommandLineGetRawValue (Package, 1) == NULL) {\r
      //\r
      // we insufficient parameters\r
      //\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel3HiiHandle, L"touch");\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      //\r
      // get a list with each file specified by parameters\r
      // if parameter is a directory then add all the files below it to the list\r
      //\r
      for ( ParamCount = 1, Param = ShellCommandLineGetRawValue (Package, ParamCount)\r
            ; Param != NULL\r
            ; ParamCount++, Param = ShellCommandLineGetRawValue (Package, ParamCount)\r
            )\r
      {\r
        Status = ShellOpenFileMetaArg ((CHAR16 *)Param, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE, &FileList);\r
        if (EFI_ERROR (Status)) {\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel3HiiHandle, L"touch", (CHAR16 *)Param);\r
          ShellStatus = SHELL_NOT_FOUND;\r
          break;\r
        }\r
\r
        //\r
        // make sure we completed the param parsing sucessfully...\r
        // Also make sure that any previous action was sucessful\r
        //\r
        if (ShellStatus == SHELL_SUCCESS) {\r
          //\r
          // check that we have at least 1 file\r
          //\r
          if ((FileList == NULL) || IsListEmpty (&FileList->Link)) {\r
            ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NF), gShellLevel3HiiHandle, L"touch", Param);\r
            continue;\r
          } else {\r
            //\r
            // loop through the list and make sure we are not aborting...\r
            //\r
            for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode (&FileList->Link)\r
                  ; !IsNull (&FileList->Link, &Node->Link) && !ShellGetExecutionBreakFlag ()\r
                  ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode (&FileList->Link, &Node->Link)\r
                  )\r
            {\r
              //\r
              // make sure the file opened ok\r
              //\r
              if (EFI_ERROR (Node->Status)) {\r
                ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel3HiiHandle, L"touch", Node->FileName);\r
                ShellStatus = SHELL_NOT_FOUND;\r
                continue;\r
              }\r
\r
              Status = DoTouchByHandle (Node->FullName, NULL, Node->Handle, ShellCommandLineGetFlag (Package, L"-r"));\r
              if (EFI_ERROR (Status) && (Status != EFI_ACCESS_DENIED)) {\r
                ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel3HiiHandle, L"touch", Node->FileName);\r
                ShellStatus = SHELL_NOT_FOUND;\r
              }\r
            }\r
          }\r
        }\r
\r
        //\r
        // Free the fileList\r
        //\r
        if ((FileList != NULL) && !IsListEmpty (&FileList->Link)) {\r
          Status = ShellCloseFileMetaArg (&FileList);\r
          ASSERT_EFI_ERROR (Status);\r
        }\r
\r
        FileList = NULL;\r
      }\r
    }\r
\r
    //\r
    // free the command line package\r
    //\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
\r
  if (ShellGetExecutionBreakFlag ()) {\r
    return (SHELL_ABORTED);\r
  }\r
\r
  return (ShellStatus);\r
}\r