ShellPkg/Library/UefiShellLevel2CommandsLib/Rm.c

   1 /** @file
   2   Main file for attrib shell level 2 function.
   3
   4   Copyright (c) 2009 - 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
  17 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
  18   {L"-q", TypeFlag},
  19   {NULL, TypeMax}
  20   };
  21
  22 /**
  23   Determine if a directory has no files in it.
  24
  25   @param[in] FileHandle   The EFI_HANDLE to the directory.
  26
  27   @retval TRUE  The directory has no files (or directories).
  28   @retval FALSE The directory has at least 1 file or directory in it.
  29 **/
  30 BOOLEAN
  31 EFIAPI
  32 IsDirectoryEmpty (
  33   IN EFI_HANDLE   FileHandle
  34   )
  35 {
  36   EFI_FILE_INFO   *FileInfo;
  37   BOOLEAN         NoFile;
  38   BOOLEAN         RetVal;
  39
  40   RetVal = TRUE;
  41   NoFile = FALSE;
  42   FileInfo = NULL;
  43
  44   for (FileHandleFindFirstFile(FileHandle, &FileInfo)
  45     ;  !NoFile
  46     ;  FileHandleFindNextFile(FileHandle, FileInfo, &NoFile)
  47    ){
  48     if (StrStr(FileInfo->FileName, L".") != FileInfo->FileName
  49       &&StrStr(FileInfo->FileName, L"..") != FileInfo->FileName) {
  50       RetVal = FALSE;
  51     }
  52   }
  53   return (RetVal);
  54 }
  55
  56 /**
  57   Delete a node and all nodes under it (including sub directories).
  58
  59   @param[in] Node   The node to start deleting with.
  60   @param[in] Quiet  TRUE to print no messages.
  61
  62   @retval SHELL_SUCCESS       The operation was successful.
  63   @retval SHELL_ACCESS_DENIED A file was read only.
  64   @retval SHELL_ABORTED       The abort message was received.
  65   @retval SHELL_DEVICE_ERROR  A device error occured reading this Node.
  66 **/
  67 SHELL_STATUS
  68 EFIAPI
  69 CascadeDelete(
  70   IN EFI_SHELL_FILE_INFO  *Node,
  71   IN CONST BOOLEAN        Quiet
  72   )
  73 {
  74   SHELL_STATUS          ShellStatus;
  75   EFI_SHELL_FILE_INFO   *List;
  76   EFI_SHELL_FILE_INFO   *Node2;
  77   EFI_STATUS            Status;
  78   SHELL_PROMPT_RESPONSE *Resp;
  79   CHAR16                *TempName;
  80   UINTN                 NewSize;
  81
  82   Resp                  = NULL;
  83   ShellStatus           = SHELL_SUCCESS;
  84   List                  = NULL;
  85   Status                = EFI_SUCCESS;
  86
  87   if ((Node->Info->Attribute & EFI_FILE_READ_ONLY) == EFI_FILE_READ_ONLY) {
  88     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_RM_LOG_DETELE_RO), gShellLevel2HiiHandle, Node->FullName);
  89     return (SHELL_ACCESS_DENIED);
  90   }
  91
  92   if ((Node->Info->Attribute & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY) {
  93     if (!IsDirectoryEmpty(Node->Handle)) {
  94       if (!Quiet) {
  95         Status = ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_RM_LOG_DELETE_CONF), gShellLevel2HiiHandle, Node->FullName);
  96         Status = ShellPromptForResponse(ShellPromptResponseTypeYesNo, NULL, (VOID**)&Resp);
  97         ASSERT(Resp != NULL);
  98         if (EFI_ERROR(Status) || *Resp != ShellPromptResponseYes) {
  99           SHELL_FREE_NON_NULL(Resp);
 100           return (SHELL_ABORTED);
 101         }
 102         SHELL_FREE_NON_NULL(Resp);
 103       }
 104       //
 105       // empty out the directory
 106       //
 107       Status = gEfiShellProtocol->FindFilesInDir(Node->Handle, &List);
 108       if (EFI_ERROR(Status)) {
 109         if (List!=NULL) {
 110           gEfiShellProtocol->FreeFileList(&List);
 111         }
 112         return (SHELL_DEVICE_ERROR);
 113       }
 114       for (Node2 = (EFI_SHELL_FILE_INFO   *)GetFirstNode(&List->Link)
 115         ;  !IsNull(&List->Link, &Node2->Link)
 116         ;  Node2 = (EFI_SHELL_FILE_INFO   *)GetNextNode(&List->Link, &Node2->Link)
 117        ){
 118         //
 119         // skip the directory traversing stuff...
 120         //
 121         if (StrCmp(Node2->FileName, L".") == 0 || StrCmp(Node2->FileName, L"..") == 0) {
 122           continue;
 123         }
 124         Node2->Status = gEfiShellProtocol->OpenFileByName (Node2->FullName, &Node2->Handle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE);
 125         if (EFI_ERROR(Node2->Status) && StrStr(Node2->FileName, L":") == NULL) {
 126           //
 127           // Update the node filename to have full path with file system identifier
 128           //
 129           NewSize = StrSize(Node->FullName) + StrSize(Node2->FullName);
 130           TempName = AllocateZeroPool(NewSize);
 131           if (TempName == NULL) {
 132             ShellStatus = SHELL_OUT_OF_RESOURCES;
 133           } else {
 134             StrnCpy(TempName, Node->FullName, NewSize/sizeof(CHAR16) -1);
 135             TempName[StrStr(TempName, L":")+1-TempName] = CHAR_NULL;
 136             StrnCat(TempName, Node2->FullName, NewSize/sizeof(CHAR16) -1 - StrLen(TempName));
 137             FreePool((VOID*)Node2->FullName);
 138             Node2->FullName = TempName;
 139
 140             //
 141             // Now try again to open the file
 142             //
 143             Node2->Status = gEfiShellProtocol->OpenFileByName (Node2->FullName, &Node2->Handle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE);
 144           }
 145         }
 146         if (!EFI_ERROR(Node2->Status)) {
 147           ShellStatus = CascadeDelete(Node2, Quiet);
 148         } else if (ShellStatus == SHELL_SUCCESS) {
 149           ShellStatus = (SHELL_STATUS)(Node2->Status&(~0x80000000));
 150         }
 151         if (ShellStatus != SHELL_SUCCESS) {
 152           if (List!=NULL) {
 153             gEfiShellProtocol->FreeFileList(&List);
 154           }
 155           return (ShellStatus);
 156         }
 157       }
 158       if (List!=NULL) {
 159         gEfiShellProtocol->FreeFileList(&List);
 160       }
 161     }
 162   }
 163
 164   if (!(StrCmp(Node->FileName, L".") == 0 || StrCmp(Node->FileName, L"..") == 0)) {
 165     //
 166     // now delete the current node...
 167     //
 168     if (!Quiet) {
 169       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_RM_LOG_DELETE), gShellLevel2HiiHandle, Node->FullName);
 170     }
 171     Status = gEfiShellProtocol->DeleteFile(Node->Handle);
 172     Node->Handle = NULL;
 173   }
 174
 175   //
 176   // We cant allow for the warning here! (Dont use EFI_ERROR Macro).
 177   //
 178   if (Status != EFI_SUCCESS){
 179     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_RM_LOG_DELETE_ERR), gShellLevel2HiiHandle, Status);
 180     return (SHELL_ACCESS_DENIED);
 181   } else {
 182     if (!Quiet) {
 183       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_RM_LOG_DELETE_COMP), gShellLevel2HiiHandle);
 184     }
 185     return (SHELL_SUCCESS);
 186   }
 187 }
 188
 189 /**
 190   Determins if a Node is a valid delete target.  Will prevent deleting the root directory.
 191
 192   @param[in] List       RESERVED.  Not used.
 193   @param[in] Node       The node to analyze.
 194   @param[in] Package    RESERVED.  Not used.
 195 **/
 196 BOOLEAN
 197 EFIAPI
 198 IsValidDeleteTarget(
 199   IN CONST EFI_SHELL_FILE_INFO  *List,
 200   IN CONST EFI_SHELL_FILE_INFO  *Node,
 201   IN CONST LIST_ENTRY           *Package
 202   )
 203 {
 204   CONST CHAR16        *TempLocation;
 205   BOOLEAN             RetVal;
 206   CHAR16              *SearchString;
 207   CHAR16              *Pattern;
 208   UINTN               Size;
 209
 210   if (Node == NULL || Node->FullName == NULL) {
 211     return (FALSE);
 212   }
 213
 214   TempLocation = StrStr(Node->FullName, L":");
 215   if (StrLen(TempLocation) <= 2) {
 216     //
 217     // Deleting the root directory is invalid.
 218     //
 219     return (FALSE);
 220   }
 221
 222   TempLocation = ShellGetCurrentDir(NULL);
 223   if (TempLocation == NULL) {
 224     //
 225     // No working directory is specified so whatever is left is ok.
 226     //
 227     return (TRUE);
 228   }
 229
 230   Pattern       = NULL;
 231   SearchString  = NULL;
 232   Size          = 0;
 233   Pattern       = StrnCatGrow(&Pattern     , NULL, TempLocation  , 0);
 234   SearchString  = StrnCatGrow(&SearchString, &Size, Node->FullName, 0);
 235   if (!EFI_ERROR(ShellIsDirectory(SearchString))) {
 236     SearchString  = StrnCatGrow(&SearchString, &Size, L"\\", 0);
 237     SearchString  = StrnCatGrow(&SearchString, &Size, L"*", 0);
 238   }
 239
 240   if (Pattern == NULL || SearchString == NULL) {
 241     RetVal = FALSE;
 242   } else {
 243     RetVal = TRUE;
 244     if (gUnicodeCollation->MetaiMatch(gUnicodeCollation, Pattern, SearchString)) {
 245       RetVal = FALSE;
 246     }
 247   }
 248
 249   SHELL_FREE_NON_NULL(Pattern     );
 250   SHELL_FREE_NON_NULL(SearchString);
 251
 252   return (RetVal);
 253 }
 254
 255 /**
 256   Function for 'rm' command.
 257
 258   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 259   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 260 **/
 261 SHELL_STATUS
 262 EFIAPI
 263 ShellCommandRunRm (
 264   IN EFI_HANDLE        ImageHandle,
 265   IN EFI_SYSTEM_TABLE  *SystemTable
 266   )
 267 {
 268   EFI_STATUS            Status;
 269   LIST_ENTRY            *Package;
 270   CHAR16                *ProblemParam;
 271   CONST CHAR16          *Param;
 272   SHELL_STATUS          ShellStatus;
 273   UINTN                 ParamCount;
 274   EFI_SHELL_FILE_INFO   *FileList;
 275   EFI_SHELL_FILE_INFO   *Node;
 276
 277   ProblemParam        = NULL;
 278   ShellStatus         = SHELL_SUCCESS;
 279   ParamCount          = 0;
 280   FileList            = NULL;
 281
 282   //
 283   // initialize the shell lib (we must be in non-auto-init...)
 284   //
 285   Status = ShellInitialize();
 286   ASSERT_EFI_ERROR(Status);
 287
 288   //
 289   // parse the command line
 290   //
 291   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 292   if (EFI_ERROR(Status)) {
 293     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 294       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);
 295       FreePool(ProblemParam);
 296       ShellStatus = SHELL_INVALID_PARAMETER;
 297     } else {
 298       ASSERT(FALSE);
 299     }
 300   } else {
 301     //
 302     // check for "-?"
 303     //
 304     if (ShellCommandLineGetFlag(Package, L"-?")) {
 305       ASSERT(FALSE);
 306     }
 307     if (ShellCommandLineGetRawValue(Package, 1) == NULL) {
 308       //
 309       // we insufficient parameters
 310       //
 311       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel2HiiHandle);
 312       ShellStatus = SHELL_INVALID_PARAMETER;
 313     } else {
 314       //
 315       // get a list with each file specified by parameters
 316       // if parameter is a directory then add all the files below it to the list
 317       //
 318       for ( ParamCount = 1, Param = ShellCommandLineGetRawValue(Package, ParamCount)
 319           ; Param != NULL
 320           ; ParamCount++, Param = ShellCommandLineGetRawValue(Package, ParamCount)
 321          ){
 322         Status = ShellOpenFileMetaArg((CHAR16*)Param, EFI_FILE_MODE_WRITE|EFI_FILE_MODE_READ, &FileList);
 323         if (EFI_ERROR(Status) || FileList == NULL || IsListEmpty(&FileList->Link)) {
 324           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NF), gShellLevel2HiiHandle, (CHAR16*)Param);
 325           ShellStatus = SHELL_NOT_FOUND;
 326           break;
 327         }
 328       }
 329
 330       if (ShellStatus == SHELL_SUCCESS){
 331         //
 332         // loop through the list and make sure we are not aborting...
 333         //
 334         for ( Node = (EFI_SHELL_FILE_INFO*)GetFirstNode(&FileList->Link)
 335             ; !IsNull(&FileList->Link, &Node->Link) && !ShellGetExecutionBreakFlag()
 336             ; Node = (EFI_SHELL_FILE_INFO*)GetNextNode(&FileList->Link, &Node->Link)
 337            ){
 338           //
 339           // skip the directory traversing stuff...
 340           //
 341           if (StrCmp(Node->FileName, L".") == 0 || StrCmp(Node->FileName, L"..") == 0) {
 342             continue;
 343           }
 344
 345           //
 346           // do the deleting of nodes
 347           //
 348           if (EFI_ERROR(Node->Status)){
 349             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_RM_LOG_DELETE_ERR2), gShellLevel2HiiHandle, Node->Status);
 350             ShellStatus = SHELL_ACCESS_DENIED;
 351             break;
 352           }
 353           if (!IsValidDeleteTarget(FileList, Node, Package)) {
 354             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_RM_LOG_DELETE_ERR3), gShellLevel2HiiHandle, Node->FullName);
 355             ShellStatus = SHELL_INVALID_PARAMETER;
 356             break;
 357           }
 358
 359           ShellStatus = CascadeDelete(Node, ShellCommandLineGetFlag(Package, L"-q"));
 360         }
 361       }
 362       //
 363       // Free the fileList
 364       //
 365       if (FileList != NULL) {
 366         Status = ShellCloseFileMetaArg(&FileList);
 367       }
 368       FileList = NULL;
 369     }
 370
 371     //
 372     // free the command line package
 373     //
 374     ShellCommandLineFreeVarList (Package);
 375   }
 376
 377   return (ShellStatus);
 378 }
 379