2 Main file for mv shell level 2 function.
4 Copyright (c) 2009 - 2013, 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
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.
15 #include "UefiShellLevel2CommandsLib.h"
18 Function to validate that moving a specific file (FileName) to a specific
19 location (DestPath) is valid.
21 This function will verify that the destination is not a subdirectory of
22 FullName, that the Current working Directory is not being moved, and that
23 the directory is not read only.
25 if the move is invalid this function will report the error to StdOut.
27 @param FullName [in] The name of the file to move.
28 @param Cwd [in] The current working directory
29 @param DestPath [in] The target location to move to
30 @param Attribute[in] The Attribute of the file
32 @retval TRUE The move is valid
33 @retval FALSE The move is not
38 IN CONST CHAR16
*FullName
,
40 IN CONST CHAR16
*DestPath
,
41 IN CONST UINT64 Attribute
49 if (Cwd
!= NULL
&& StrCmp(FullName
, Cwd
) == 0) {
53 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MV_INV_CWD
), gShellLevel2HiiHandle
);
57 Test
= StrnCatGrow(&Test
, NULL
, DestPath
, 0);
59 ASSERT(TestWalker
!= NULL
);
60 while(*TestWalker
== L
'\\') {
63 while(TestWalker
!= NULL
&& TestWalker
[StrLen(TestWalker
)-1] == L
'\\') {
64 TestWalker
[StrLen(TestWalker
)-1] = CHAR_NULL
;
66 ASSERT(TestWalker
!= NULL
);
67 ASSERT(FullName
!= NULL
);
68 if (StrStr(FullName
, TestWalker
) != 0) {
69 TempLen
= StrLen(FullName
);
70 if (StrStr(FullName
, TestWalker
) != FullName
// not the first items... (could below it)
71 && TempLen
<= (StrLen(TestWalker
) + 1)
72 && StrStr(FullName
+StrLen(TestWalker
) + 1, L
"\\") == NULL
) {
76 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MV_INV_SUB
), gShellLevel2HiiHandle
);
82 if (StrStr(DestPath
, FullName
) != 0 && StrStr(DestPath
, FullName
) != DestPath
) {
86 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MV_INV_SUB
), gShellLevel2HiiHandle
);
89 if ((Attribute
& EFI_FILE_READ_ONLY
) != 0) {
91 // invalid to move read only
93 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MV_INV_RO
), gShellLevel2HiiHandle
);
96 Test
= StrStr(FullName
, L
":");
97 Test1
= StrStr(DestPath
, L
":");
98 if (Test1
!= NULL
&& Test
!= NULL
) {
101 Result
= StringNoCaseCompare(&FullName
, &DestPath
);
105 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MV_INV_FS
), gShellLevel2HiiHandle
);
113 Function to take a destination path that might contain wildcards and verify
114 that there is only a single possible target (IE we cant have wildcards that
115 have 2 possible destination).
117 if the result is sucessful the caller must free *DestPathPointer.
119 @param[in] DestDir The original path to the destination.
120 @param[in, out] DestPathPointer A pointer to the callee allocated final path.
121 @param[in] Cwd A pointer to the current working directory.
123 @retval SHELL_INVALID_PARAMETER The DestDir could not be resolved to a location.
124 @retval SHELL_INVALID_PARAMETER The DestDir could be resolved to more than 1 location.
125 @retval SHELL_INVALID_PARAMETER Cwd is required and is NULL.
126 @retval SHELL_SUCCESS The operation was sucessful.
130 GetDestinationLocation(
131 IN CONST CHAR16
*DestDir
,
132 IN OUT CHAR16
**DestPathPointer
,
136 EFI_SHELL_FILE_INFO
*DestList
;
137 EFI_SHELL_FILE_INFO
*Node
;
144 if (StrStr(DestDir
, L
"\\") == DestDir
) {
146 return SHELL_INVALID_PARAMETER
;
148 DestPath
= AllocateZeroPool(StrSize(Cwd
));
149 if (DestPath
== NULL
) {
150 return (SHELL_OUT_OF_RESOURCES
);
152 StrCpy(DestPath
, Cwd
);
153 while (PathRemoveLastItem(DestPath
)) ;
154 *DestPathPointer
= DestPath
;
155 return (SHELL_SUCCESS
);
158 // get the destination path
160 ShellOpenFileMetaArg((CHAR16
*)DestDir
, EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
|EFI_FILE_MODE_CREATE
, &DestList
);
161 if (DestList
== NULL
|| IsListEmpty(&DestList
->Link
)) {
163 // Not existing... must be renaming
165 if (StrStr(DestDir
, L
":") == NULL
) {
167 ShellCloseFileMetaArg(&DestList
);
168 return (SHELL_INVALID_PARAMETER
);
170 NewSize
= StrSize(Cwd
);
171 NewSize
+= StrSize(DestDir
);
172 DestPath
= AllocateZeroPool(NewSize
);
173 if (DestPath
== NULL
) {
174 ShellCloseFileMetaArg(&DestList
);
175 return (SHELL_OUT_OF_RESOURCES
);
177 StrCpy(DestPath
, Cwd
);
178 if (DestPath
[StrLen(DestPath
)-1] != L
'\\' && DestDir
[0] != L
'\\') {
179 StrCat(DestPath
, L
"\\");
180 } else if (DestPath
[StrLen(DestPath
)-1] == L
'\\' && DestDir
[0] == L
'\\') {
181 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
183 StrCat(DestPath
, DestDir
);
185 ASSERT(DestPath
== NULL
);
186 DestPath
= StrnCatGrow(&DestPath
, NULL
, DestDir
, 0);
187 if (DestPath
== NULL
) {
188 ShellCloseFileMetaArg(&DestList
);
189 return (SHELL_OUT_OF_RESOURCES
);
193 Node
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&DestList
->Link
);
195 // Make sure there is only 1 node in the list.
197 if (!IsNodeAtEnd(&DestList
->Link
, &Node
->Link
)) {
198 ShellCloseFileMetaArg(&DestList
);
199 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_MARG_ERROR
), gShellLevel2HiiHandle
, DestDir
);
200 return (SHELL_INVALID_PARAMETER
);
202 if (ShellIsDirectory(Node
->FullName
)==EFI_SUCCESS
) {
203 DestPath
= AllocateZeroPool(StrSize(Node
->FullName
)+sizeof(CHAR16
));
204 if (DestPath
== NULL
) {
205 ShellCloseFileMetaArg(&DestList
);
206 return (SHELL_OUT_OF_RESOURCES
);
208 StrCpy(DestPath
, Node
->FullName
);
209 StrCat(DestPath
, L
"\\");
212 // cant move onto another file.
214 ShellCloseFileMetaArg(&DestList
);
215 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_ERROR
), gShellLevel2HiiHandle
, DestDir
);
216 return (SHELL_INVALID_PARAMETER
);
220 *DestPathPointer
= DestPath
;
221 ShellCloseFileMetaArg(&DestList
);
223 return (SHELL_SUCCESS
);
227 function to take a list of files to move and a destination location and do
228 the verification and moving of those files to that location. This function
229 will report any errors to the user and continue to move the rest of the files.
231 @param[in] FileList A LIST_ENTRY* based list of files to move
232 @param[out] Resp pointer to response from question. Pass back on looped calling
233 @param[in] DestDir the destination location
235 @retval SHELL_SUCCESS the files were all moved.
236 @retval SHELL_INVALID_PARAMETER a parameter was invalid
237 @retval SHELL_SECURITY_VIOLATION a security violation ocurred
238 @retval SHELL_WRITE_PROTECTED the destination was write protected
239 @retval SHELL_OUT_OF_RESOURCES a memory allocation failed
243 ValidateAndMoveFiles(
244 IN CONST EFI_SHELL_FILE_INFO
*FileList
,
246 IN CONST CHAR16
*DestDir
254 SHELL_STATUS ShellStatus
;
255 CONST EFI_SHELL_FILE_INFO
*Node
;
256 EFI_FILE_INFO
*NewFileInfo
;
257 CHAR16
*TempLocation
;
261 SHELL_FILE_HANDLE DestHandle
;
263 ASSERT(FileList
!= NULL
);
264 ASSERT(DestDir
!= NULL
);
267 Cwd
= ShellGetCurrentDir(NULL
);
271 // Get and validate the destination location
273 ShellStatus
= GetDestinationLocation(DestDir
, &DestPath
, Cwd
);
274 if (ShellStatus
!= SHELL_SUCCESS
) {
275 return (ShellStatus
);
277 DestPath
= PathCleanUpDirectories(DestPath
);
279 HiiOutput
= HiiGetString (gShellLevel2HiiHandle
, STRING_TOKEN (STR_MV_OUTPUT
), NULL
);
280 HiiResultOk
= HiiGetString (gShellLevel2HiiHandle
, STRING_TOKEN (STR_GEN_RES_OK
), NULL
);
281 ASSERT (DestPath
!= NULL
);
282 ASSERT (HiiResultOk
!= NULL
);
283 ASSERT (HiiOutput
!= NULL
);
284 // ASSERT (Cwd != NULL);
287 // Go through the list of files and directories to move...
289 for (Node
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&FileList
->Link
)
290 ; !IsNull(&FileList
->Link
, &Node
->Link
)
291 ; Node
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&FileList
->Link
, &Node
->Link
)
293 if (ShellGetExecutionBreakFlag()) {
296 ASSERT(Node
->FileName
!= NULL
);
297 ASSERT(Node
->FullName
!= NULL
);
300 // skip the directory traversing stuff...
302 if (StrCmp(Node
->FileName
, L
".") == 0 || StrCmp(Node
->FileName
, L
"..") == 0) {
307 // Validate that the move is valid
309 if (!IsValidMove(Node
->FullName
, Cwd
, DestPath
, Node
->Info
->Attribute
)) {
310 ShellStatus
= SHELL_INVALID_PARAMETER
;
315 // Chop off map info from "DestPath"
317 if ((TempLocation
= StrStr(DestPath
, L
":")) != NULL
) {
318 CopyMem(DestPath
, TempLocation
+1, StrSize(TempLocation
+1));
322 // construct the new file info block
324 NewSize
= StrSize(DestPath
);
325 NewSize
+= StrSize(Node
->FileName
) + SIZE_OF_EFI_FILE_INFO
+ sizeof(CHAR16
);
326 NewFileInfo
= AllocateZeroPool(NewSize
);
327 if (NewFileInfo
== NULL
) {
328 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_MEM
), gShellLevel2HiiHandle
);
329 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
331 CopyMem(NewFileInfo
, Node
->Info
, SIZE_OF_EFI_FILE_INFO
);
332 if (DestPath
[0] != L
'\\') {
333 StrCpy(NewFileInfo
->FileName
, L
"\\");
334 StrCat(NewFileInfo
->FileName
, DestPath
);
336 StrCpy(NewFileInfo
->FileName
, DestPath
);
338 Length
= StrLen(NewFileInfo
->FileName
);
342 if (NewFileInfo
->FileName
[Length
] == L
'\\') {
343 if (Node
->FileName
[0] == L
'\\') {
345 // Don't allow for double slashes. Eliminate one of them.
347 NewFileInfo
->FileName
[Length
] = CHAR_NULL
;
349 StrCat(NewFileInfo
->FileName
, Node
->FileName
);
351 NewFileInfo
->Size
= SIZE_OF_EFI_FILE_INFO
+ StrSize(NewFileInfo
->FileName
);
352 ShellPrintEx(-1, -1, HiiOutput
, Node
->FullName
, NewFileInfo
->FileName
);
354 if (!EFI_ERROR(ShellFileExists(NewFileInfo
->FileName
))) {
355 if (Response
== NULL
) {
356 ShellPromptForResponseHii(ShellPromptResponseTypeYesNoAllCancel
, STRING_TOKEN (STR_GEN_DEST_EXIST_OVR
), gShellLevel2HiiHandle
, &Response
);
358 switch (*(SHELL_PROMPT_RESPONSE
*)Response
) {
359 case ShellPromptResponseNo
:
360 FreePool(NewFileInfo
);
362 case ShellPromptResponseCancel
:
365 // indicate to stop everything
367 FreePool(NewFileInfo
);
370 FreePool(HiiResultOk
);
371 return (SHELL_ABORTED
);
372 case ShellPromptResponseAll
:
375 case ShellPromptResponseYes
:
380 FreePool(NewFileInfo
);
383 FreePool(HiiResultOk
);
384 return SHELL_ABORTED
;
386 Status
= ShellOpenFileByName(NewFileInfo
->FileName
, &DestHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
, 0);
387 ShellDeleteFile(&DestHandle
);
392 // Perform the move operation
394 Status
= ShellSetFileInfo(Node
->Handle
, NewFileInfo
);
397 // Free the info object we used...
399 FreePool(NewFileInfo
);
404 if (EFI_ERROR(Status
)) {
405 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
406 ShellStatus
= SHELL_INVALID_PARAMETER
;
407 if (Status
== EFI_SECURITY_VIOLATION
) {
408 ShellStatus
= SHELL_SECURITY_VIOLATION
;
409 } else if (Status
== EFI_WRITE_PROTECTED
) {
410 ShellStatus
= SHELL_WRITE_PROTECTED
;
411 } else if (Status
== EFI_OUT_OF_RESOURCES
) {
412 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
413 } else if (Status
== EFI_DEVICE_ERROR
) {
414 ShellStatus
= SHELL_DEVICE_ERROR
;
415 } else if (Status
== EFI_ACCESS_DENIED
) {
416 ShellStatus
= SHELL_ACCESS_DENIED
;
419 ShellPrintEx(-1, -1, L
"%s", HiiResultOk
);
426 FreePool(HiiResultOk
);
427 return (ShellStatus
);
431 Function for 'mv' command.
433 @param[in] ImageHandle Handle to the Image (NULL if Internal).
434 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
439 IN EFI_HANDLE ImageHandle
,
440 IN EFI_SYSTEM_TABLE
*SystemTable
445 CHAR16
*ProblemParam
;
446 SHELL_STATUS ShellStatus
;
449 EFI_SHELL_FILE_INFO
*FileList
;
453 ShellStatus
= SHELL_SUCCESS
;
459 // initialize the shell lib (we must be in non-auto-init...)
461 Status
= ShellInitialize();
462 ASSERT_EFI_ERROR(Status
);
465 // parse the command line
467 Status
= ShellCommandLineParse (EmptyParamList
, &Package
, &ProblemParam
, TRUE
);
468 if (EFI_ERROR(Status
)) {
469 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
470 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, ProblemParam
);
471 FreePool(ProblemParam
);
472 ShellStatus
= SHELL_INVALID_PARAMETER
;
480 if (ShellCommandLineGetFlag(Package
, L
"-?")) {
484 switch (ParamCount
= ShellCommandLineGetCount(Package
)) {
488 // we have insufficient parameters
490 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
491 ShellStatus
= SHELL_INVALID_PARAMETER
;
495 // must have valid CWD for single parameter...
497 if (ShellGetCurrentDir(NULL
) == NULL
){
498 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_CWD
), gShellLevel2HiiHandle
);
499 ShellStatus
= SHELL_INVALID_PARAMETER
;
501 Status
= ShellOpenFileMetaArg((CHAR16
*)ShellCommandLineGetRawValue(Package
, 1), EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
, &FileList
);
502 if (FileList
== NULL
|| IsListEmpty(&FileList
->Link
) || EFI_ERROR(Status
)) {
503 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_NF
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, 1));
504 ShellStatus
= SHELL_NOT_FOUND
;
507 // ValidateAndMoveFiles will report errors to the screen itself
509 ShellStatus
= ValidateAndMoveFiles(FileList
, &Response
, ShellGetCurrentDir(NULL
));
515 ///@todo make sure this works with error half way through and continues...
516 for (ParamCount
--, LoopCounter
= 1 ; LoopCounter
< ParamCount
; LoopCounter
++) {
517 if (ShellGetExecutionBreakFlag()) {
520 Status
= ShellOpenFileMetaArg((CHAR16
*)ShellCommandLineGetRawValue(Package
, LoopCounter
), EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
, &FileList
);
521 if (FileList
== NULL
|| IsListEmpty(&FileList
->Link
) || EFI_ERROR(Status
)) {
522 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_NF
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, LoopCounter
));
523 ShellStatus
= SHELL_NOT_FOUND
;
526 // ValidateAndMoveFiles will report errors to the screen itself
527 // Only change ShellStatus if it's sucessful
529 if (ShellStatus
== SHELL_SUCCESS
) {
530 ShellStatus
= ValidateAndMoveFiles(FileList
, &Response
, ShellCommandLineGetRawValue(Package
, ParamCount
));
532 ValidateAndMoveFiles(FileList
, &Response
, ShellCommandLineGetRawValue(Package
, ParamCount
));
535 if (FileList
!= NULL
&& !IsListEmpty(&FileList
->Link
)) {
536 Status
= ShellCloseFileMetaArg(&FileList
);
537 if (EFI_ERROR(Status
) && ShellStatus
== SHELL_SUCCESS
) {
538 ShellStatus
= SHELL_ACCESS_DENIED
;
539 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_FILE
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, 1), ShellStatus
|MAX_BIT
);
544 } // switch on parameter count
546 if (FileList
!= NULL
) {
547 ShellCloseFileMetaArg(&FileList
);
551 // free the command line package
553 ShellCommandLineFreeVarList (Package
);
556 SHELL_FREE_NON_NULL(Response
);
558 if (ShellGetExecutionBreakFlag()) {
559 return (SHELL_ABORTED
);
562 return (ShellStatus
);