ShellPkg/Library/UefiShellLevel2CommandsLib/Vol.c

   1 /** @file
   2   Main file for vol shell level 2 function.
   3
   4   (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
   5   Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include "UefiShellLevel2CommandsLib.h"
  17 #include <Guid/FileSystemInfo.h>
  18 #include <Guid/FileSystemVolumeLabelInfo.h>
  19
  20 /**
  21   Print the info or change the volume info.
  22
  23   @param[in] Path           String with starting path.
  24   @param[in] Delete         TRUE to delete the volume label. FALSE otherwise.
  25   @param[in] Name           New name to set to the volume label.
  26
  27   @retval SHELL_SUCCESS     The operation was sucessful.
  28 **/
  29 SHELL_STATUS
  30 EFIAPI
  31 HandleVol(
  32   IN CONST CHAR16  *Path,
  33   IN CONST BOOLEAN Delete,
  34   IN CONST CHAR16  *Name OPTIONAL
  35   )
  36 {
  37   EFI_STATUS            Status;
  38   SHELL_STATUS          ShellStatus;
  39   EFI_FILE_SYSTEM_INFO  *SysInfo;
  40   UINTN                 SysInfoSize;
  41   SHELL_FILE_HANDLE     ShellFileHandle;
  42   EFI_FILE_PROTOCOL     *EfiFpHandle;
  43   UINTN                 Size1;
  44   UINTN                 Size2;
  45
  46   ShellStatus   = SHELL_SUCCESS;
  47
  48   if (
  49       Name != NULL && (
  50       StrStr(Name, L"%") != NULL ||
  51       StrStr(Name, L"^") != NULL ||
  52       StrStr(Name, L"*") != NULL ||
  53       StrStr(Name, L"+") != NULL ||
  54       StrStr(Name, L"=") != NULL ||
  55       StrStr(Name, L"[") != NULL ||
  56       StrStr(Name, L"]") != NULL ||
  57       StrStr(Name, L"|") != NULL ||
  58       StrStr(Name, L":") != NULL ||
  59       StrStr(Name, L";") != NULL ||
  60       StrStr(Name, L"\"") != NULL ||
  61       StrStr(Name, L"<") != NULL ||
  62       StrStr(Name, L">") != NULL ||
  63       StrStr(Name, L"?") != NULL ||
  64       StrStr(Name, L"/") != NULL ||
  65       StrStr(Name, L" ") != NULL )
  66       ){
  67     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel2HiiHandle, L"vol", Name);
  68     return (SHELL_INVALID_PARAMETER);
  69   }
  70
  71   Status = gEfiShellProtocol->OpenFileByName(
  72     Path,
  73     &ShellFileHandle,
  74     Name != NULL?EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE:EFI_FILE_MODE_READ);
  75
  76   if (EFI_ERROR(Status) || ShellFileHandle == NULL) {
  77     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel2HiiHandle, L"vol", Path);
  78     return (SHELL_ACCESS_DENIED);
  79   }
  80
  81   //
  82   // Get the Volume Info from ShellFileHandle
  83   //
  84   SysInfo     = NULL;
  85   SysInfoSize = 0;
  86   EfiFpHandle = ConvertShellHandleToEfiFileProtocol(ShellFileHandle);
  87   Status = EfiFpHandle->GetInfo(
  88     EfiFpHandle,
  89     &gEfiFileSystemInfoGuid,
  90     &SysInfoSize,
  91     SysInfo);
  92
  93   if (Status == EFI_BUFFER_TOO_SMALL) {
  94     SysInfo = AllocateZeroPool(SysInfoSize);
  95     Status = EfiFpHandle->GetInfo(
  96       EfiFpHandle,
  97       &gEfiFileSystemInfoGuid,
  98       &SysInfoSize,
  99       SysInfo);
 100   }
 101
 102   ASSERT(SysInfo != NULL);
 103
 104   if (Delete) {
 105     *((CHAR16 *) SysInfo->VolumeLabel) = CHAR_NULL;
 106     SysInfo->Size = SIZE_OF_EFI_FILE_SYSTEM_INFO + StrSize(SysInfo->VolumeLabel);
 107     Status = EfiFpHandle->SetInfo(
 108       EfiFpHandle,
 109       &gEfiFileSystemInfoGuid,
 110       (UINTN)SysInfo->Size,
 111       SysInfo);
 112   } else if (Name != NULL) {
 113     Size1 = StrSize(Name);
 114     Size2 = StrSize(SysInfo->VolumeLabel);
 115     if (Size1 > Size2) {
 116       SysInfo = ReallocatePool((UINTN)SysInfo->Size, (UINTN)SysInfo->Size + Size1 - Size2, SysInfo);
 117       if (SysInfo == NULL) {
 118         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellLevel2HiiHandle, L"vol");
 119         ShellStatus = SHELL_OUT_OF_RESOURCES;
 120       }
 121     }
 122     if (SysInfo != NULL) {
 123       StrnCpy ((CHAR16 *) SysInfo->VolumeLabel, Name, (Size1 > Size2?Size1/sizeof(CHAR16):Size2/sizeof(CHAR16))-1);
 124       SysInfo->Size = SIZE_OF_EFI_FILE_SYSTEM_INFO + Size1;
 125       Status = EfiFpHandle->SetInfo(
 126         EfiFpHandle,
 127         &gEfiFileSystemInfoGuid,
 128         (UINTN)SysInfo->Size,
 129         SysInfo);
 130     }
 131   }
 132
 133   FreePool(SysInfo);
 134
 135   if (Delete || Name != NULL) {
 136     if (EFI_ERROR(Status)) {
 137       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_AD), gShellLevel2HiiHandle, L"vol", Path);
 138       ShellStatus = SHELL_ACCESS_DENIED;
 139     }
 140   }
 141
 142   SysInfoSize = 0;
 143   SysInfo = NULL;
 144
 145   Status = EfiFpHandle->GetInfo(
 146     EfiFpHandle,
 147     &gEfiFileSystemInfoGuid,
 148     &SysInfoSize,
 149     SysInfo);
 150
 151   if (Status == EFI_BUFFER_TOO_SMALL) {
 152     SysInfo = AllocateZeroPool(SysInfoSize);
 153     Status = EfiFpHandle->GetInfo(
 154       EfiFpHandle,
 155       &gEfiFileSystemInfoGuid,
 156       &SysInfoSize,
 157       SysInfo);
 158   }
 159
 160   gEfiShellProtocol->CloseFile(ShellFileHandle);
 161
 162   ASSERT(SysInfo != NULL);
 163
 164   if (SysInfo != NULL) {
 165     //
 166     // print VolumeInfo table
 167     //
 168     ShellPrintHiiEx (
 169       0,
 170       gST->ConOut->Mode->CursorRow,
 171       NULL,
 172       STRING_TOKEN (STR_VOL_VOLINFO),
 173       gShellLevel2HiiHandle,
 174       SysInfo->VolumeLabel,
 175       SysInfo->ReadOnly?L"r":L"rw",
 176       SysInfo->VolumeSize,
 177       SysInfo->FreeSpace,
 178       SysInfo->BlockSize
 179      );
 180     SHELL_FREE_NON_NULL(SysInfo);
 181   }
 182
 183   return (ShellStatus);
 184 }
 185
 186 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
 187   {L"-d", TypeFlag},
 188   {L"-n", TypeValue},
 189   {NULL, TypeMax}
 190   };
 191
 192 /**
 193   Function for 'Vol' command.
 194
 195   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 196   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 197 **/
 198 SHELL_STATUS
 199 EFIAPI
 200 ShellCommandRunVol (
 201   IN EFI_HANDLE        ImageHandle,
 202   IN EFI_SYSTEM_TABLE  *SystemTable
 203   )
 204 {
 205   EFI_STATUS    Status;
 206   LIST_ENTRY    *Package;
 207   CHAR16        *ProblemParam;
 208   SHELL_STATUS  ShellStatus;
 209   CONST CHAR16  *PathName;
 210   CONST CHAR16  *CurDir;
 211   BOOLEAN       DeleteMode;
 212   CHAR16        *FullPath;
 213   CHAR16        *TempSpot;
 214   UINTN         Length;
 215   CONST CHAR16  *NewName;
 216
 217   Length              = 0;
 218   ProblemParam        = NULL;
 219   ShellStatus         = SHELL_SUCCESS;
 220   PathName            = NULL;
 221   CurDir              = NULL;
 222   FullPath            = NULL;
 223
 224   //
 225   // initialize the shell lib (we must be in non-auto-init...)
 226   //
 227   Status = ShellInitialize();
 228   ASSERT_EFI_ERROR(Status);
 229
 230   //
 231   // Fix local copies of the protocol pointers
 232   //
 233   Status = CommandInit();
 234   ASSERT_EFI_ERROR(Status);
 235
 236   //
 237   // parse the command line
 238   //
 239   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 240   if (EFI_ERROR(Status)) {
 241     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 242       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, L"vol", ProblemParam);
 243       FreePool(ProblemParam);
 244       ShellStatus = SHELL_INVALID_PARAMETER;
 245     } else {
 246       ASSERT(FALSE);
 247     }
 248   } else {
 249     //
 250     // check for "-?"
 251     //
 252     if (ShellCommandLineGetFlag(Package, L"-?")) {
 253       ASSERT(FALSE);
 254     }
 255
 256     if (ShellCommandLineGetCount(Package) > 2) {
 257       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel2HiiHandle, L"vol");
 258       ShellStatus = SHELL_INVALID_PARAMETER;
 259     } else {
 260       PathName = ShellCommandLineGetRawValue(Package, 1);
 261       if (PathName == NULL) {
 262         CurDir = gEfiShellProtocol->GetCurDir(NULL);
 263         if (CurDir == NULL) {
 264           ShellStatus = SHELL_NOT_FOUND;
 265           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_CWD), gShellLevel2HiiHandle, L"vol");
 266         } else {
 267           PathName = CurDir;
 268         }
 269       }
 270       if (PathName != NULL) {
 271         TempSpot = StrStr(PathName, L":");
 272         if (TempSpot != NULL) {
 273           *TempSpot = CHAR_NULL;
 274         }
 275         TempSpot = StrStr(PathName, L"\\");
 276         if (TempSpot != NULL) {
 277           *TempSpot = CHAR_NULL;
 278         }
 279         StrnCatGrow(&FullPath, &Length, PathName, 0);
 280         StrnCatGrow(&FullPath, &Length, L":\\", 0);
 281         DeleteMode = ShellCommandLineGetFlag(Package, L"-d");
 282         NewName    = ShellCommandLineGetValue(Package, L"-n");
 283         if (DeleteMode && ShellCommandLineGetFlag(Package, L"-n")) {
 284           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CONFLICT), gShellLevel2HiiHandle, L"vol", L"-d", L"-n");
 285           ShellStatus = SHELL_INVALID_PARAMETER;
 286         } else if (ShellCommandLineGetFlag(Package, L"-n") && NewName == NULL) {
 287           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellLevel2HiiHandle, L"vol", L"-n");
 288           ShellStatus = SHELL_INVALID_PARAMETER;
 289         } else if (NewName != NULL && StrLen(NewName) > 11) {
 290           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM_VAL), gShellLevel2HiiHandle, L"vol", NewName, L"-n");
 291           ShellStatus = SHELL_INVALID_PARAMETER;
 292         } else if (ShellStatus == SHELL_SUCCESS) {
 293           ShellStatus = HandleVol(
 294             FullPath,
 295             DeleteMode,
 296             NewName
 297            );
 298         }
 299       }
 300     }
 301   }
 302
 303   SHELL_FREE_NON_NULL(FullPath);
 304
 305   //
 306   // free the command line package
 307   //
 308   ShellCommandLineFreeVarList (Package);
 309
 310   return (ShellStatus);
 311 }