]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ShellPkg: Fix 'mv' command to not attempt moving a file from write-protected media
[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / Mv.c
1 /** @file
2 Main file for mv shell level 2 function.
3
4 (C) Copyright 2013-2014, Hewlett-Packard Development Company, L.P.
5 Copyright (c) 2009 - 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
18 /**
19 Function to validate that moving a specific file (FileName) to a specific
20 location (DestPath) is valid.
21
22 This function will verify that the destination is not a subdirectory of
23 FullName, that the Current working Directory is not being moved, and that
24 the directory is not read only.
25
26 if the move is invalid this function will report the error to StdOut.
27
28 @param FullName [in] The name of the file to move.
29 @param Cwd [in] The current working directory
30 @param DestPath [in] The target location to move to
31 @param Attribute[in] The Attribute of the file
32 @param FileStatus[in] The Status of the file when opened
33
34 @retval TRUE The move is valid
35 @retval FALSE The move is not
36 **/
37 BOOLEAN
38 EFIAPI
39 IsValidMove(
40 IN CONST CHAR16 *FullName,
41 IN CONST CHAR16 *Cwd,
42 IN CONST CHAR16 *DestPath,
43 IN CONST UINT64 Attribute,
44 IN CONST EFI_STATUS FileStatus
45 )
46 {
47 CHAR16 *Test;
48 CHAR16 *Test1;
49 CHAR16 *TestWalker;
50 INTN Result;
51 UINTN TempLen;
52 if (Cwd != NULL && StrCmp(FullName, Cwd) == 0) {
53 //
54 // Invalid move
55 //
56 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MV_INV_CWD), gShellLevel2HiiHandle);
57 return (FALSE);
58 }
59 Test = NULL;
60 Test = StrnCatGrow(&Test, NULL, DestPath, 0);
61 TestWalker = Test;
62 ASSERT(TestWalker != NULL);
63 while(*TestWalker == L'\\') {
64 TestWalker++;
65 }
66 while(TestWalker != NULL && TestWalker[StrLen(TestWalker)-1] == L'\\') {
67 TestWalker[StrLen(TestWalker)-1] = CHAR_NULL;
68 }
69 ASSERT(TestWalker != NULL);
70 ASSERT(FullName != NULL);
71 if (StrStr(FullName, TestWalker) != 0) {
72 TempLen = StrLen(FullName);
73 if (StrStr(FullName, TestWalker) != FullName // not the first items... (could below it)
74 && TempLen <= (StrLen(TestWalker) + 1)
75 && StrStr(FullName+StrLen(TestWalker) + 1, L"\\") == NULL) {
76 //
77 // Invalid move
78 //
79 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MV_INV_SUB), gShellLevel2HiiHandle);
80 FreePool(Test);
81 return (FALSE);
82 }
83 }
84 FreePool(Test);
85 if (StrStr(DestPath, FullName) != 0 && StrStr(DestPath, FullName) != DestPath) {
86 //
87 // Invalid move
88 //
89 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MV_INV_SUB), gShellLevel2HiiHandle);
90 return (FALSE);
91 }
92 if (((Attribute & EFI_FILE_READ_ONLY) != 0) || (FileStatus == EFI_WRITE_PROTECTED)) {
93 //
94 // invalid to move read only
95 //
96 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MV_INV_RO), gShellLevel2HiiHandle, FullName);
97 return (FALSE);
98 }
99 Test = StrStr(FullName, L":");
100 Test1 = StrStr(DestPath, L":");
101 if (Test1 != NULL && Test != NULL) {
102 *Test = CHAR_NULL;
103 *Test1 = CHAR_NULL;
104 Result = StringNoCaseCompare(&FullName, &DestPath);
105 *Test = L':';
106 *Test1 = L':';
107 if (Result != 0) {
108 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MV_INV_FS), gShellLevel2HiiHandle);
109 return (FALSE);
110 }
111 }
112 return (TRUE);
113 }
114
115 /**
116 Function to take a destination path that might contain wildcards and verify
117 that there is only a single possible target (IE we cant have wildcards that
118 have 2 possible destination).
119
120 if the result is sucessful the caller must free *DestPathPointer.
121
122 @param[in] DestDir The original path to the destination.
123 @param[in, out] DestPathPointer A pointer to the callee allocated final path.
124 @param[in] Cwd A pointer to the current working directory.
125
126 @retval SHELL_INVALID_PARAMETER The DestDir could not be resolved to a location.
127 @retval SHELL_INVALID_PARAMETER The DestDir could be resolved to more than 1 location.
128 @retval SHELL_INVALID_PARAMETER Cwd is required and is NULL.
129 @retval SHELL_SUCCESS The operation was sucessful.
130 **/
131 SHELL_STATUS
132 EFIAPI
133 GetDestinationLocation(
134 IN CONST CHAR16 *DestDir,
135 IN OUT CHAR16 **DestPathPointer,
136 IN CONST CHAR16 *Cwd
137 )
138 {
139 EFI_SHELL_FILE_INFO *DestList;
140 EFI_SHELL_FILE_INFO *Node;
141 CHAR16 *DestPath;
142 UINTN NewSize;
143 UINTN CurrentSize;
144
145 DestList = NULL;
146 DestPath = NULL;
147
148 if (StrStr(DestDir, L"\\") == DestDir) {
149 if (Cwd == NULL) {
150 return SHELL_INVALID_PARAMETER;
151 }
152 DestPath = AllocateZeroPool(StrSize(Cwd));
153 if (DestPath == NULL) {
154 return (SHELL_OUT_OF_RESOURCES);
155 }
156 StrCpy(DestPath, Cwd);
157 while (PathRemoveLastItem(DestPath)) ;
158
159 //
160 // Append DestDir beyond '\' which may be present
161 //
162 CurrentSize = StrSize(DestPath);
163 StrnCatGrow(&DestPath, &CurrentSize, &DestDir[1], 0);
164
165 *DestPathPointer = DestPath;
166 return (SHELL_SUCCESS);
167 }
168 //
169 // get the destination path
170 //
171 ShellOpenFileMetaArg((CHAR16*)DestDir, EFI_FILE_MODE_WRITE|EFI_FILE_MODE_READ|EFI_FILE_MODE_CREATE, &DestList);
172 if (DestList == NULL || IsListEmpty(&DestList->Link)) {
173 //
174 // Not existing... must be renaming
175 //
176 if (StrStr(DestDir, L":") == NULL) {
177 if (Cwd == NULL) {
178 ShellCloseFileMetaArg(&DestList);
179 return (SHELL_INVALID_PARAMETER);
180 }
181 NewSize = StrSize(Cwd);
182 NewSize += StrSize(DestDir);
183 DestPath = AllocateZeroPool(NewSize);
184 if (DestPath == NULL) {
185 ShellCloseFileMetaArg(&DestList);
186 return (SHELL_OUT_OF_RESOURCES);
187 }
188 StrCpy(DestPath, Cwd);
189 if (DestPath[StrLen(DestPath)-1] != L'\\' && DestDir[0] != L'\\') {
190 StrCat(DestPath, L"\\");
191 } else if (DestPath[StrLen(DestPath)-1] == L'\\' && DestDir[0] == L'\\') {
192 ((CHAR16*)DestPath)[StrLen(DestPath)-1] = CHAR_NULL;
193 }
194 StrCat(DestPath, DestDir);
195 } else {
196 ASSERT(DestPath == NULL);
197 DestPath = StrnCatGrow(&DestPath, NULL, DestDir, 0);
198 if (DestPath == NULL) {
199 ShellCloseFileMetaArg(&DestList);
200 return (SHELL_OUT_OF_RESOURCES);
201 }
202 }
203 } else {
204 Node = (EFI_SHELL_FILE_INFO*)GetFirstNode(&DestList->Link);
205 //
206 // Make sure there is only 1 node in the list.
207 //
208 if (!IsNodeAtEnd(&DestList->Link, &Node->Link)) {
209 ShellCloseFileMetaArg(&DestList);
210 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_MARG_ERROR), gShellLevel2HiiHandle, DestDir);
211 return (SHELL_INVALID_PARAMETER);
212 }
213 if (ShellIsDirectory(Node->FullName)==EFI_SUCCESS) {
214 DestPath = AllocateZeroPool(StrSize(Node->FullName)+sizeof(CHAR16));
215 if (DestPath == NULL) {
216 ShellCloseFileMetaArg(&DestList);
217 return (SHELL_OUT_OF_RESOURCES);
218 }
219 StrCpy(DestPath, Node->FullName);
220 StrCat(DestPath, L"\\");
221 } else {
222 //
223 // cant move onto another file.
224 //
225 ShellCloseFileMetaArg(&DestList);
226 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_ERROR), gShellLevel2HiiHandle, DestDir);
227 return (SHELL_INVALID_PARAMETER);
228 }
229 }
230
231 *DestPathPointer = DestPath;
232 ShellCloseFileMetaArg(&DestList);
233
234 return (SHELL_SUCCESS);
235 }
236
237 /**
238 function to take a list of files to move and a destination location and do
239 the verification and moving of those files to that location. This function
240 will report any errors to the user and continue to move the rest of the files.
241
242 @param[in] FileList A LIST_ENTRY* based list of files to move
243 @param[out] Resp pointer to response from question. Pass back on looped calling
244 @param[in] DestDir the destination location
245
246 @retval SHELL_SUCCESS the files were all moved.
247 @retval SHELL_INVALID_PARAMETER a parameter was invalid
248 @retval SHELL_SECURITY_VIOLATION a security violation ocurred
249 @retval SHELL_WRITE_PROTECTED the destination was write protected
250 @retval SHELL_OUT_OF_RESOURCES a memory allocation failed
251 **/
252 SHELL_STATUS
253 EFIAPI
254 ValidateAndMoveFiles(
255 IN CONST EFI_SHELL_FILE_INFO *FileList,
256 OUT VOID **Resp,
257 IN CONST CHAR16 *DestDir
258 )
259 {
260 EFI_STATUS Status;
261 CHAR16 *HiiOutput;
262 CHAR16 *HiiResultOk;
263 CHAR16 *DestPath;
264 CONST CHAR16 *Cwd;
265 SHELL_STATUS ShellStatus;
266 CONST EFI_SHELL_FILE_INFO *Node;
267 EFI_FILE_INFO *NewFileInfo;
268 CHAR16 *TempLocation;
269 UINTN NewSize;
270 UINTN Length;
271 VOID *Response;
272 SHELL_FILE_HANDLE DestHandle;
273
274 ASSERT(FileList != NULL);
275 ASSERT(DestDir != NULL);
276
277 DestPath = NULL;
278 Cwd = ShellGetCurrentDir(NULL);
279 Response = *Resp;
280
281 //
282 // Get and validate the destination location
283 //
284 ShellStatus = GetDestinationLocation(DestDir, &DestPath, Cwd);
285 if (ShellStatus != SHELL_SUCCESS) {
286 return (ShellStatus);
287 }
288 DestPath = PathCleanUpDirectories(DestPath);
289
290 HiiOutput = HiiGetString (gShellLevel2HiiHandle, STRING_TOKEN (STR_MV_OUTPUT), NULL);
291 HiiResultOk = HiiGetString (gShellLevel2HiiHandle, STRING_TOKEN (STR_GEN_RES_OK), NULL);
292 ASSERT (DestPath != NULL);
293 ASSERT (HiiResultOk != NULL);
294 ASSERT (HiiOutput != NULL);
295
296 //
297 // Go through the list of files and directories to move...
298 //
299 for (Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&FileList->Link)
300 ; !IsNull(&FileList->Link, &Node->Link)
301 ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&FileList->Link, &Node->Link)
302 ){
303 if (ShellGetExecutionBreakFlag()) {
304 break;
305 }
306
307 //
308 // These should never be NULL
309 //
310 ASSERT(Node->FileName != NULL);
311 ASSERT(Node->FullName != NULL);
312 ASSERT(Node->Info != NULL);
313
314 //
315 // skip the directory traversing stuff...
316 //
317 if (StrCmp(Node->FileName, L".") == 0 || StrCmp(Node->FileName, L"..") == 0) {
318 continue;
319 }
320
321 //
322 // Validate that the move is valid
323 //
324 if (!IsValidMove(Node->FullName, Cwd, DestPath, Node->Info->Attribute, Node->Status)) {
325 ShellStatus = SHELL_INVALID_PARAMETER;
326 continue;
327 }
328
329 //
330 // Chop off map info from "DestPath"
331 //
332 if ((TempLocation = StrStr(DestPath, L":")) != NULL) {
333 CopyMem(DestPath, TempLocation+1, StrSize(TempLocation+1));
334 }
335
336 //
337 // construct the new file info block
338 //
339 NewSize = StrSize(DestPath);
340 NewSize += StrSize(Node->FileName) + SIZE_OF_EFI_FILE_INFO + sizeof(CHAR16);
341 NewFileInfo = AllocateZeroPool(NewSize);
342 if (NewFileInfo == NULL) {
343 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_MEM), gShellLevel2HiiHandle);
344 ShellStatus = SHELL_OUT_OF_RESOURCES;
345 } else {
346 CopyMem(NewFileInfo, Node->Info, SIZE_OF_EFI_FILE_INFO);
347 if (DestPath[0] != L'\\') {
348 StrCpy(NewFileInfo->FileName, L"\\");
349 StrCat(NewFileInfo->FileName, DestPath);
350 } else {
351 StrCpy(NewFileInfo->FileName, DestPath);
352 }
353 Length = StrLen(NewFileInfo->FileName);
354 if (Length > 0) {
355 Length--;
356 }
357 if (NewFileInfo->FileName[Length] == L'\\') {
358 if (Node->FileName[0] == L'\\') {
359 //
360 // Don't allow for double slashes. Eliminate one of them.
361 //
362 NewFileInfo->FileName[Length] = CHAR_NULL;
363 }
364 StrCat(NewFileInfo->FileName, Node->FileName);
365 }
366 NewFileInfo->Size = SIZE_OF_EFI_FILE_INFO + StrSize(NewFileInfo->FileName);
367 ShellPrintEx(-1, -1, HiiOutput, Node->FullName, NewFileInfo->FileName);
368
369 if (!EFI_ERROR(ShellFileExists(NewFileInfo->FileName))) {
370 if (Response == NULL) {
371 ShellPromptForResponseHii(ShellPromptResponseTypeYesNoAllCancel, STRING_TOKEN (STR_GEN_DEST_EXIST_OVR), gShellLevel2HiiHandle, &Response);
372 }
373 switch (*(SHELL_PROMPT_RESPONSE*)Response) {
374 case ShellPromptResponseNo:
375 FreePool(NewFileInfo);
376 continue;
377 case ShellPromptResponseCancel:
378 *Resp = Response;
379 //
380 // indicate to stop everything
381 //
382 FreePool(NewFileInfo);
383 FreePool(DestPath);
384 FreePool(HiiOutput);
385 FreePool(HiiResultOk);
386 return (SHELL_ABORTED);
387 case ShellPromptResponseAll:
388 *Resp = Response;
389 break;
390 case ShellPromptResponseYes:
391 FreePool(Response);
392 break;
393 default:
394 FreePool(Response);
395 FreePool(NewFileInfo);
396 FreePool(DestPath);
397 FreePool(HiiOutput);
398 FreePool(HiiResultOk);
399 return SHELL_ABORTED;
400 }
401 Status = ShellOpenFileByName(NewFileInfo->FileName, &DestHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE, 0);
402 ShellDeleteFile(&DestHandle);
403 }
404
405
406 //
407 // Perform the move operation
408 //
409 Status = ShellSetFileInfo(Node->Handle, NewFileInfo);
410
411 //
412 // Free the info object we used...
413 //
414 FreePool(NewFileInfo);
415
416 //
417 // Check our result
418 //
419 if (EFI_ERROR(Status)) {
420 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_UK), gShellLevel2HiiHandle, Status);
421 ShellStatus = SHELL_INVALID_PARAMETER;
422 if (Status == EFI_SECURITY_VIOLATION) {
423 ShellStatus = SHELL_SECURITY_VIOLATION;
424 } else if (Status == EFI_WRITE_PROTECTED) {
425 ShellStatus = SHELL_WRITE_PROTECTED;
426 } else if (Status == EFI_OUT_OF_RESOURCES) {
427 ShellStatus = SHELL_OUT_OF_RESOURCES;
428 } else if (Status == EFI_DEVICE_ERROR) {
429 ShellStatus = SHELL_DEVICE_ERROR;
430 } else if (Status == EFI_ACCESS_DENIED) {
431 ShellStatus = SHELL_ACCESS_DENIED;
432 }
433 } else {
434 ShellPrintEx(-1, -1, L"%s", HiiResultOk);
435 }
436 }
437 } // for loop
438
439 FreePool(DestPath);
440 FreePool(HiiOutput);
441 FreePool(HiiResultOk);
442 return (ShellStatus);
443 }
444
445 /**
446 Function for 'mv' command.
447
448 @param[in] ImageHandle Handle to the Image (NULL if Internal).
449 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
450 **/
451 SHELL_STATUS
452 EFIAPI
453 ShellCommandRunMv (
454 IN EFI_HANDLE ImageHandle,
455 IN EFI_SYSTEM_TABLE *SystemTable
456 )
457 {
458 EFI_STATUS Status;
459 LIST_ENTRY *Package;
460 CHAR16 *ProblemParam;
461 SHELL_STATUS ShellStatus;
462 UINTN ParamCount;
463 UINTN LoopCounter;
464 EFI_SHELL_FILE_INFO *FileList;
465 VOID *Response;
466
467 ProblemParam = NULL;
468 ShellStatus = SHELL_SUCCESS;
469 ParamCount = 0;
470 FileList = NULL;
471 Response = NULL;
472
473 //
474 // initialize the shell lib (we must be in non-auto-init...)
475 //
476 Status = ShellInitialize();
477 ASSERT_EFI_ERROR(Status);
478
479 //
480 // parse the command line
481 //
482 Status = ShellCommandLineParse (EmptyParamList, &Package, &ProblemParam, TRUE);
483 if (EFI_ERROR(Status)) {
484 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
485 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);
486 FreePool(ProblemParam);
487 ShellStatus = SHELL_INVALID_PARAMETER;
488 } else {
489 ASSERT(FALSE);
490 }
491 } else {
492 //
493 // check for "-?"
494 //
495 if (ShellCommandLineGetFlag(Package, L"-?")) {
496 ASSERT(FALSE);
497 }
498
499 switch (ParamCount = ShellCommandLineGetCount(Package)) {
500 case 0:
501 case 1:
502 //
503 // we have insufficient parameters
504 //
505 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel2HiiHandle);
506 ShellStatus = SHELL_INVALID_PARAMETER;
507 break;
508 case 2:
509 //
510 // must have valid CWD for single parameter...
511 //
512 if (ShellGetCurrentDir(NULL) == NULL){
513 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_CWD), gShellLevel2HiiHandle);
514 ShellStatus = SHELL_INVALID_PARAMETER;
515 } else {
516 Status = ShellOpenFileMetaArg((CHAR16*)ShellCommandLineGetRawValue(Package, 1), EFI_FILE_MODE_WRITE|EFI_FILE_MODE_READ, &FileList);
517 if (FileList == NULL || IsListEmpty(&FileList->Link) || EFI_ERROR(Status)) {
518 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NF), gShellLevel2HiiHandle, ShellCommandLineGetRawValue(Package, 1));
519 ShellStatus = SHELL_NOT_FOUND;
520 } else {
521 //
522 // ValidateAndMoveFiles will report errors to the screen itself
523 //
524 ShellStatus = ValidateAndMoveFiles(FileList, &Response, ShellGetCurrentDir(NULL));
525 }
526 }
527
528 break;
529 default:
530 ///@todo make sure this works with error half way through and continues...
531 for (ParamCount--, LoopCounter = 1 ; LoopCounter < ParamCount ; LoopCounter++) {
532 if (ShellGetExecutionBreakFlag()) {
533 break;
534 }
535 Status = ShellOpenFileMetaArg((CHAR16*)ShellCommandLineGetRawValue(Package, LoopCounter), EFI_FILE_MODE_WRITE|EFI_FILE_MODE_READ, &FileList);
536 if (FileList == NULL || IsListEmpty(&FileList->Link) || EFI_ERROR(Status)) {
537 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NF), gShellLevel2HiiHandle, ShellCommandLineGetRawValue(Package, LoopCounter));
538 ShellStatus = SHELL_NOT_FOUND;
539 } else {
540 //
541 // ValidateAndMoveFiles will report errors to the screen itself
542 // Only change ShellStatus if it's sucessful
543 //
544 if (ShellStatus == SHELL_SUCCESS) {
545 ShellStatus = ValidateAndMoveFiles(FileList, &Response, ShellCommandLineGetRawValue(Package, ParamCount));
546 } else {
547 ValidateAndMoveFiles(FileList, &Response, ShellCommandLineGetRawValue(Package, ParamCount));
548 }
549 }
550 if (FileList != NULL && !IsListEmpty(&FileList->Link)) {
551 Status = ShellCloseFileMetaArg(&FileList);
552 if (EFI_ERROR(Status) && ShellStatus == SHELL_SUCCESS) {
553 ShellStatus = SHELL_ACCESS_DENIED;
554 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_FILE), gShellLevel2HiiHandle, ShellCommandLineGetRawValue(Package, 1), ShellStatus|MAX_BIT);
555 }
556 }
557 }
558 break;
559 } // switch on parameter count
560
561 if (FileList != NULL) {
562 ShellCloseFileMetaArg(&FileList);
563 }
564
565 //
566 // free the command line package
567 //
568 ShellCommandLineFreeVarList (Package);
569 }
570
571 SHELL_FREE_NON_NULL(Response);
572
573 if (ShellGetExecutionBreakFlag()) {
574 return (SHELL_ABORTED);
575 }
576
577 return (ShellStatus);
578 }
EFI Development Kit II mirror for PVE