ShellPkg/Library/UefiShellLevel2CommandsLib/Vol.c

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