ShellPkg/Library/UefiShellLevel2CommandsLib/Vol.c

   1 /** @file
   2   Main file for vol shell level 2 function.
   3
   4   Copyright (c) 2011, 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     StrCpy ((CHAR16 *) SysInfo->VolumeLabel, L"");
 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     }
 117     StrCpy ((CHAR16 *) SysInfo->VolumeLabel, Name);
 118     SysInfo->Size = SIZE_OF_EFI_FILE_SYSTEM_INFO + Size1;
 119     Status = EfiFpHandle->SetInfo(
 120       EfiFpHandle,
 121       &gEfiFileSystemInfoGuid,
 122       (UINTN)SysInfo->Size,
 123       SysInfo);
 124   }
 125
 126   FreePool(SysInfo);
 127
 128   if (Delete || Name != NULL) {
 129     if (EFI_ERROR(Status)) {
 130       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_AD), gShellLevel2HiiHandle, Path);
 131       ShellStatus = SHELL_ACCESS_DENIED;
 132     }
 133   }
 134
 135   SysInfoSize = 0;
 136   SysInfo = NULL;
 137
 138   Status = EfiFpHandle->GetInfo(
 139     EfiFpHandle,
 140     &gEfiFileSystemInfoGuid,
 141     &SysInfoSize,
 142     SysInfo);
 143
 144   if (Status == EFI_BUFFER_TOO_SMALL) {
 145     SysInfo = AllocateZeroPool(SysInfoSize);
 146     Status = EfiFpHandle->GetInfo(
 147       EfiFpHandle,
 148       &gEfiFileSystemInfoGuid,
 149       &SysInfoSize,
 150       SysInfo);
 151   }
 152
 153   gEfiShellProtocol->CloseFile(ShellFileHandle);
 154
 155   ASSERT(SysInfo != NULL);
 156
 157   //
 158   // print VolumeInfo table
 159   //
 160   ShellPrintHiiEx (
 161     0,
 162     gST->ConOut->Mode->CursorRow,
 163     NULL,
 164     STRING_TOKEN (STR_VOL_VOLINFO),
 165     gShellLevel2HiiHandle,
 166     SysInfo->VolumeLabel,
 167     SysInfo->ReadOnly?L"r":L"rw",
 168     SysInfo->VolumeSize,
 169     SysInfo->FreeSpace,
 170     SysInfo->BlockSize
 171    );
 172   SHELL_FREE_NON_NULL(SysInfo);
 173
 174   return (ShellStatus);
 175 }
 176
 177 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
 178   {L"-d", TypeFlag},
 179   {L"-n", TypeValue},
 180   {NULL, TypeMax}
 181   };
 182
 183 /**
 184   Function for 'Vol' command.
 185
 186   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 187   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 188 **/
 189 SHELL_STATUS
 190 EFIAPI
 191 ShellCommandRunVol (
 192   IN EFI_HANDLE        ImageHandle,
 193   IN EFI_SYSTEM_TABLE  *SystemTable
 194   )
 195 {
 196   EFI_STATUS    Status;
 197   LIST_ENTRY    *Package;
 198   CHAR16        *ProblemParam;
 199   SHELL_STATUS  ShellStatus;
 200   CONST CHAR16  *PathName;
 201   CONST CHAR16  *CurDir;
 202   BOOLEAN       DeleteMode;
 203   CHAR16        *FullPath;
 204   CHAR16        *TempSpot;
 205   UINTN         Length;
 206   CONST CHAR16  *NewName;
 207
 208   Length              = 0;
 209   ProblemParam        = NULL;
 210   ShellStatus         = SHELL_SUCCESS;
 211   PathName            = NULL;
 212   CurDir              = NULL;
 213   FullPath            = NULL;
 214
 215   //
 216   // initialize the shell lib (we must be in non-auto-init...)
 217   //
 218   Status = ShellInitialize();
 219   ASSERT_EFI_ERROR(Status);
 220
 221   //
 222   // Fix local copies of the protocol pointers
 223   //
 224   Status = CommandInit();
 225   ASSERT_EFI_ERROR(Status);
 226
 227   //
 228   // parse the command line
 229   //
 230   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 231   if (EFI_ERROR(Status)) {
 232     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 233       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);
 234       FreePool(ProblemParam);
 235       ShellStatus = SHELL_INVALID_PARAMETER;
 236     } else {
 237       ASSERT(FALSE);
 238     }
 239   } else {
 240     //
 241     // check for "-?"
 242     //
 243     if (ShellCommandLineGetFlag(Package, L"-?")) {
 244       ASSERT(FALSE);
 245     }
 246
 247     if (ShellCommandLineGetCount(Package) > 2) {
 248       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel2HiiHandle);
 249       ShellStatus = SHELL_INVALID_PARAMETER;
 250     } else {
 251       PathName = ShellCommandLineGetRawValue(Package, 1);
 252       if (PathName == NULL) {
 253         CurDir = gEfiShellProtocol->GetCurDir(NULL);
 254         if (CurDir == NULL) {
 255           ShellStatus = SHELL_NOT_FOUND;
 256           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_CWD), gShellLevel2HiiHandle);
 257         } else {
 258           PathName = CurDir;
 259         }
 260       }
 261       if (PathName != NULL) {
 262         TempSpot = StrStr(PathName, L":");
 263         if (TempSpot != NULL) {
 264           *TempSpot = CHAR_NULL;
 265         }
 266         TempSpot = StrStr(PathName, L"\\");
 267         if (TempSpot != NULL) {
 268           *TempSpot = CHAR_NULL;
 269         }
 270         StrnCatGrow(&FullPath, &Length, PathName, 0);
 271         StrnCatGrow(&FullPath, &Length, L":\\", 0);
 272         DeleteMode = ShellCommandLineGetFlag(Package, L"-d");
 273         NewName    = ShellCommandLineGetValue(Package, L"-n");
 274         if (DeleteMode && ShellCommandLineGetFlag(Package, L"-n")) {
 275           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellLevel2HiiHandle);
 276           ShellStatus = SHELL_INVALID_PARAMETER;
 277         } else if (ShellCommandLineGetFlag(Package, L"-n") && NewName == NULL) {
 278           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellLevel2HiiHandle, L"-n");
 279           ShellStatus = SHELL_INVALID_PARAMETER;
 280         } else if (NewName != NULL && StrLen(NewName) > 11) {
 281           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM_VAL), gShellLevel2HiiHandle, L"-n");
 282           ShellStatus = SHELL_INVALID_PARAMETER;
 283         } else if (ShellStatus == SHELL_SUCCESS) {
 284           ShellStatus = HandleVol(
 285             FullPath,
 286             DeleteMode,
 287             NewName
 288            );
 289         }
 290       }
 291     }
 292   }
 293
 294   SHELL_FREE_NON_NULL(FullPath);
 295
 296   //
 297   // free the command line package
 298   //
 299   ShellCommandLineFreeVarList (Package);
 300
 301   return (ShellStatus);
 302 }