ShellPkg: Standardized HP Copyright Message String

[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / Attrib.c

/** @file\r
  Main file for attrib shell level 2 function.\r
\r
  (C) Copyright 2014-2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "UefiShellLevel2CommandsLib.h"\r
\r
STATIC CONST CHAR16 AllFiles[] = L"*";\r
\r
STATIC CONST SHELL_PARAM_ITEM AttribParamList[] = {\r
  {L"-a", TypeFlag},\r
  {L"+a", TypeFlag},\r
  {L"-s", TypeFlag},\r
  {L"+s", TypeFlag},\r
  {L"-h", TypeFlag},\r
  {L"+h", TypeFlag},\r
  {L"-r", TypeFlag},\r
  {L"+r", TypeFlag},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'attrib' 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
ShellCommandRunAttrib (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  UINT64              FileAttributesToAdd;\r
  UINT64              FileAttributesToRemove;\r
  EFI_STATUS          Status;\r
  LIST_ENTRY          *Package;\r
  CHAR16              *ProblemParam;\r
  SHELL_STATUS        ShellStatus;\r
  UINTN               ParamNumberCount;\r
  CONST CHAR16        *FileName;\r
  EFI_SHELL_FILE_INFO *ListOfFiles;\r
  EFI_SHELL_FILE_INFO *FileNode;\r
  EFI_FILE_INFO       *FileInfo;\r
\r
  ListOfFiles   = NULL;\r
  ShellStatus   = SHELL_SUCCESS;\r
  ProblemParam  = 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
  //\r
  // parse the command line\r
  //\r
  Status = ShellCommandLineParse (AttribParamList, &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), gShellLevel2HiiHandle, L"attrib", ProblemParam);  \r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
\r
    //\r
    // check for "-?"\r
    //\r
    if (ShellCommandLineGetFlag(Package, L"-?")) {\r
      ASSERT(FALSE);\r
    } else {\r
      FileAttributesToAdd = 0;\r
      FileAttributesToRemove = 0;\r
\r
      //\r
      // apply or remove each flag\r
      //\r
      if (ShellCommandLineGetFlag(Package, L"+a")) {\r
        FileAttributesToAdd |= EFI_FILE_ARCHIVE;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"-a")) {\r
        FileAttributesToRemove |= EFI_FILE_ARCHIVE;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"+s")) {\r
        FileAttributesToAdd |= EFI_FILE_SYSTEM;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"-s")) {\r
        FileAttributesToRemove |= EFI_FILE_SYSTEM;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"+h")) {\r
        FileAttributesToAdd |= EFI_FILE_HIDDEN;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"-h")) {\r
        FileAttributesToRemove |= EFI_FILE_HIDDEN;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"+r")) {\r
        FileAttributesToAdd |= EFI_FILE_READ_ONLY;\r
      }\r
      if (ShellCommandLineGetFlag(Package, L"-r")) {\r
        FileAttributesToRemove |= EFI_FILE_READ_ONLY;\r
      }\r
\r
      if (FileAttributesToRemove == 0 && FileAttributesToAdd == 0) {\r
        //\r
        // Do display as we have no attributes to change\r
        //\r
        for ( ParamNumberCount = 1\r
            ;\r
            ; ParamNumberCount++\r
           ){\r
          FileName = ShellCommandLineGetRawValue(Package, ParamNumberCount);\r
          // if we dont have anything left, move on...\r
          if (FileName == NULL && ParamNumberCount == 1) {\r
            FileName = (CHAR16*)AllFiles;\r
          } else if (FileName == NULL) {\r
            break;\r
          }\r
          ASSERT(ListOfFiles == NULL);\r
          Status = ShellOpenFileMetaArg((CHAR16*)FileName, EFI_FILE_MODE_READ, &ListOfFiles);\r
          if (EFI_ERROR(Status)) {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel2HiiHandle, L"attrib", ShellCommandLineGetRawValue(Package, ParamNumberCount));  \r
            ShellStatus = SHELL_NOT_FOUND;\r
          } else {\r
            for (FileNode = (EFI_SHELL_FILE_INFO*)GetFirstNode(&ListOfFiles->Link)\r
              ;  !IsNull(&ListOfFiles->Link, &FileNode->Link)\r
              ;  FileNode = (EFI_SHELL_FILE_INFO*)GetNextNode(&ListOfFiles->Link, &FileNode->Link)\r
             ){\r
              ShellPrintHiiEx(\r
                -1,\r
                -1,\r
                NULL,\r
                STRING_TOKEN (STR_ATTRIB_OUTPUT_LINE),\r
                gShellLevel2HiiHandle,\r
                FileNode->Info->Attribute&EFI_FILE_DIRECTORY? L'D':L' ',\r
                FileNode->Info->Attribute&EFI_FILE_ARCHIVE?   L'A':L' ',\r
                FileNode->Info->Attribute&EFI_FILE_SYSTEM?    L'S':L' ',\r
                FileNode->Info->Attribute&EFI_FILE_HIDDEN?    L'H':L' ',\r
                FileNode->Info->Attribute&EFI_FILE_READ_ONLY? L'R':L' ',\r
                FileNode->FileName\r
               );\r
               \r
              if (ShellGetExecutionBreakFlag()) {\r
                  ShellStatus = SHELL_ABORTED;\r
                  break;\r
              }\r
            }\r
            Status = ShellCloseFileMetaArg(&ListOfFiles);\r
            ListOfFiles = NULL;\r
            if (EFI_ERROR(Status)) {\r
              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_CLOSE_FAIL), gShellLevel2HiiHandle, L"attrib", ShellCommandLineGetRawValue(Package, ParamNumberCount));  \r
              ShellStatus = SHELL_NOT_FOUND;\r
            }\r
          } // for loop for handling wildcard filenames\r
        } // for loop for printing out the info\r
      } else if ((FileAttributesToRemove & FileAttributesToAdd) != 0) {\r
        //\r
        // fail as we have conflcting params.\r
        //\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellLevel2HiiHandle, L"attrib");  \r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
      } else {\r
        //\r
        // enumerate through all the files/directories and apply the attributes\r
        //\r
        for ( ParamNumberCount = 1\r
            ;\r
            ; ParamNumberCount++\r
           ){\r
          FileName = ShellCommandLineGetRawValue(Package, ParamNumberCount);\r
          // if we dont have anything left, move on...\r
          if (FileName == NULL) {\r
            //\r
            // make sure we are not failing on the first one we do... if yes that's an error...\r
            //\r
            if (ParamNumberCount == 1) {\r
              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel2HiiHandle, L"attrib");  \r
              ShellStatus = SHELL_INVALID_PARAMETER;\r
            }\r
            break;\r
          }\r
\r
          //\r
          // OpenFileByName / GetFileInfo / Change attributes / SetFileInfo / CloseFile / free memory\r
          // for each file or directory on the line.\r
          //\r
\r
          //\r
          // Open the file(s)\r
          //\r
          ASSERT(ListOfFiles == NULL);\r
          Status = ShellOpenFileMetaArg((CHAR16*)FileName, EFI_FILE_MODE_READ, &ListOfFiles);\r
          if (EFI_ERROR(Status)) {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel2HiiHandle, L"attrib", ShellCommandLineGetRawValue(Package, ParamNumberCount));  \r
            ShellStatus = SHELL_NOT_FOUND;\r
          } else {\r
            for (FileNode = (EFI_SHELL_FILE_INFO*)GetFirstNode(&ListOfFiles->Link)\r
              ;  !IsNull(&ListOfFiles->Link, &FileNode->Link)\r
              ;  FileNode = (EFI_SHELL_FILE_INFO*)GetNextNode(&ListOfFiles->Link, &FileNode->Link)\r
             ){\r
              //\r
              // skip the directory traversing stuff...\r
              //\r
              if (StrCmp(FileNode->FileName, L".") == 0 || StrCmp(FileNode->FileName, L"..") == 0) {\r
                continue;\r
              }\r
\r
              FileInfo = gEfiShellProtocol->GetFileInfo(FileNode->Handle);\r
\r
              //\r
              // if we are removing Read-Only we need to do that alone\r
              //\r
              if ((FileAttributesToRemove & EFI_FILE_READ_ONLY) == EFI_FILE_READ_ONLY) {\r
                FileInfo->Attribute &= ~EFI_FILE_READ_ONLY;\r
                //\r
                // SetFileInfo\r
                //\r
                Status = ShellSetFileInfo(FileNode->Handle, FileInfo);\r
                if (EFI_ERROR(Status)) {\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_AD), gShellLevel2HiiHandle, L"attrib", ShellCommandLineGetRawValue(Package, ParamNumberCount));  \r
                  ShellStatus = SHELL_ACCESS_DENIED;\r
                }\r
              }\r
\r
              //\r
              // change the attribute\r
              //\r
              FileInfo->Attribute &= ~FileAttributesToRemove;\r
              FileInfo->Attribute |= FileAttributesToAdd;\r
\r
              //\r
              // SetFileInfo\r
              //\r
              Status = ShellSetFileInfo(FileNode->Handle, FileInfo);\r
              if (EFI_ERROR(Status)) {;\r
                ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_AD), gShellLevel2HiiHandle, L"attrib", ShellCommandLineGetRawValue(Package, ParamNumberCount));  \r
                ShellStatus = SHELL_ACCESS_DENIED;\r
              }\r
\r
              SHELL_FREE_NON_NULL(FileInfo);\r
            }\r
            Status = ShellCloseFileMetaArg(&ListOfFiles);\r
            ListOfFiles = NULL;\r
            if (EFI_ERROR(Status)) {\r
              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_CLOSE_FAIL), gShellLevel2HiiHandle, L"attrib", ShellCommandLineGetRawValue(Package, ParamNumberCount));  \r
              ShellStatus = SHELL_NOT_FOUND;\r
            }\r
          } // for loop for handling wildcard filenames\r
        }\r
      }\r
    }\r
  }\r
\r
  //\r
  // free the command line package\r
  //\r
  ShellCommandLineFreeVarList (Package);\r
\r
  //\r
  // return the status\r
  //\r
  return (ShellStatus);\r
}\r