2 Main file for cp shell level 2 function.
4 Copyright (c) 2009 - 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
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 take a list of files to copy and a destination location and do
19 the verification and copying of those files to that location. This function
20 will report any errors to the user and halt.
22 @param[in] FileList A LIST_ENTRY* based list of files to move.
23 @param[in] DestDir The destination location.
24 @param[in] SilentMode TRUE to eliminate screen output.
25 @param[in] RecursiveMode TRUE to copy directories.
26 @param[in] Resp The response to the overwrite query (if always).
28 @retval SHELL_SUCCESS the files were all moved.
29 @retval SHELL_INVALID_PARAMETER a parameter was invalid
30 @retval SHELL_SECURITY_VIOLATION a security violation ocurred
31 @retval SHELL_WRITE_PROTECTED the destination was write protected
32 @retval SHELL_OUT_OF_RESOURCES a memory allocation failed
37 IN CONST EFI_SHELL_FILE_INFO
*FileList
,
38 IN CONST CHAR16
*DestDir
,
39 IN BOOLEAN SilentMode
,
40 IN BOOLEAN RecursiveMode
,
45 Function to Copy one file to another location
47 If the destination exists the user will be prompted and the result put into *resp
49 @param[in] Source pointer to source file name
50 @param[in] Dest pointer to destination file name
51 @param[out] Resp pointer to response from question. Pass back on looped calling
52 @param[in] SilentMode whether to run in quiet mode or not
54 @retval SHELL_SUCCESS The source file was copied to the destination
59 IN CONST CHAR16
*Source
,
60 IN CONST CHAR16
*Dest
,
67 SHELL_FILE_HANDLE SourceHandle
;
68 SHELL_FILE_HANDLE DestHandle
;
73 EFI_SHELL_FILE_INFO
*List
;
74 SHELL_STATUS ShellStatus
;
84 ReadSize
= PcdGet16(PcdShellFileOperationSize
);
85 // Why bother copying a file to itself
86 if (StrCmp(Source
, Dest
) == 0) {
87 return (SHELL_SUCCESS
);
91 // Open destination file without create
93 Status
= ShellOpenFileByName(Dest
, &DestHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
, 0);
98 if (DestHandle
!= NULL
) {
99 ShellCloseFile(&DestHandle
);
104 // if the destination file existed check response and possibly prompt user
106 if (!EFI_ERROR(Status
)) {
107 if (Response
== NULL
&& !SilentMode
) {
108 Status
= ShellPromptForResponseHii(ShellPromptResponseTypeYesNoAllCancel
, STRING_TOKEN (STR_GEN_DEST_EXIST_OVR
), gShellLevel2HiiHandle
, &Response
);
111 // possibly return based on response
114 switch (*(SHELL_PROMPT_RESPONSE
*)Response
) {
115 case ShellPromptResponseNo
:
117 // return success here so we dont stop the process
119 return (SHELL_SUCCESS
);
120 case ShellPromptResponseCancel
:
123 // indicate to stop everything
125 return (SHELL_ABORTED
);
126 case ShellPromptResponseAll
:
128 case ShellPromptResponseYes
:
131 return SHELL_ABORTED
;
136 if (ShellIsDirectory(Source
) == EFI_SUCCESS
) {
137 Status
= ShellCreateDirectory(Dest
, &DestHandle
);
138 if (EFI_ERROR(Status
)) {
139 return (SHELL_ACCESS_DENIED
);
143 // Now copy all the files under the directory...
147 StrnCatGrow(&TempName
, &Size
, Source
, 0);
148 StrnCatGrow(&TempName
, &Size
, L
"\\*", 0);
149 ShellOpenFileMetaArg((CHAR16
*)TempName
, EFI_FILE_MODE_READ
, &List
);
151 StrnCatGrow(&TempName
, &Size
, Dest
, 0);
152 StrnCatGrow(&TempName
, &Size
, L
"\\", 0);
153 ShellStatus
= ValidateAndCopyFiles(List
, TempName
, SilentMode
, TRUE
, Resp
);
154 ShellCloseFileMetaArg(&List
);
159 // open file with create enabled
161 Status
= ShellOpenFileByName(Dest
, &DestHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, 0);
162 if (EFI_ERROR(Status
)) {
163 return (SHELL_ACCESS_DENIED
);
169 Status
= ShellOpenFileByName(Source
, &SourceHandle
, EFI_FILE_MODE_READ
, 0);
170 ASSERT_EFI_ERROR(Status
);
173 // copy data between files
175 Buffer
= AllocateZeroPool(ReadSize
);
176 ASSERT(Buffer
!= NULL
);
177 while (ReadSize
== PcdGet16(PcdShellFileOperationSize
) && !EFI_ERROR(Status
)) {
178 Status
= ShellReadFile(SourceHandle
, &ReadSize
, Buffer
);
179 ASSERT_EFI_ERROR(Status
);
180 Status
= ShellWriteFile(DestHandle
, &ReadSize
, Buffer
);
187 if (DestHandle
!= NULL
) {
188 ShellCloseFile(&DestHandle
);
191 if (SourceHandle
!= NULL
) {
192 ShellCloseFile(&SourceHandle
);
199 return (SHELL_SUCCESS
);
203 function to take a list of files to copy and a destination location and do
204 the verification and copying of those files to that location. This function
205 will report any errors to the user and halt.
207 The key is to have this function called ONLY once. this allows for the parameter
208 verification to happen correctly.
210 @param[in] FileList A LIST_ENTRY* based list of files to move.
211 @param[in] DestDir The destination location.
212 @param[in] SilentMode TRUE to eliminate screen output.
213 @param[in] RecursiveMode TRUE to copy directories.
214 @param[in] Resp The response to the overwrite query (if always).
216 @retval SHELL_SUCCESS the files were all moved.
217 @retval SHELL_INVALID_PARAMETER a parameter was invalid
218 @retval SHELL_SECURITY_VIOLATION a security violation ocurred
219 @retval SHELL_WRITE_PROTECTED the destination was write protected
220 @retval SHELL_OUT_OF_RESOURCES a memory allocation failed
224 ValidateAndCopyFiles(
225 IN CONST EFI_SHELL_FILE_INFO
*FileList
,
226 IN CONST CHAR16
*DestDir
,
227 IN BOOLEAN SilentMode
,
228 IN BOOLEAN RecursiveMode
,
234 CONST EFI_SHELL_FILE_INFO
*Node
;
235 SHELL_STATUS ShellStatus
;
240 CONST CHAR16
*TempLocation
;
250 ShellStatus
= SHELL_SUCCESS
;
252 Cwd
= ShellGetCurrentDir(NULL
);
254 ASSERT(FileList
!= NULL
);
255 ASSERT(DestDir
!= NULL
);
258 // We already verified that this was present.
263 // If we are trying to copy multiple files... make sure we got a directory for the target...
265 if (EFI_ERROR(ShellIsDirectory(DestDir
)) && FileList
->Link
.ForwardLink
!= FileList
->Link
.BackLink
) {
267 // Error for destination not a directory
269 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NOT_DIR
), gShellLevel2HiiHandle
, DestDir
);
270 return (SHELL_INVALID_PARAMETER
);
272 for (Node
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&FileList
->Link
)
273 ; !IsNull(&FileList
->Link
, &Node
->Link
)
274 ; Node
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&FileList
->Link
, &Node
->Link
)
277 // skip the directory traversing stuff...
279 if (StrCmp(Node
->FileName
, L
".") == 0 || StrCmp(Node
->FileName
, L
"..") == 0) {
283 NewSize
= StrSize(DestDir
);
284 NewSize
+= StrSize(Node
->FullName
);
285 NewSize
+= StrSize(Cwd
);
286 if (NewSize
> PathLen
) {
291 // Make sure got -r if required
293 if (!RecursiveMode
&& !EFI_ERROR(ShellIsDirectory(Node
->FullName
))) {
294 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_DIR_REQ
), gShellLevel2HiiHandle
);
295 return (SHELL_INVALID_PARAMETER
);
299 // make sure got dest as dir if needed
301 if (!EFI_ERROR(ShellIsDirectory(Node
->FullName
)) && EFI_ERROR(ShellIsDirectory(DestDir
))) {
303 // Error for destination not a directory
305 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NOT_DIR
), gShellLevel2HiiHandle
, DestDir
);
306 return (SHELL_INVALID_PARAMETER
);
310 HiiOutput
= HiiGetString (gShellLevel2HiiHandle
, STRING_TOKEN (STR_CP_OUTPUT
), NULL
);
311 HiiResultOk
= HiiGetString (gShellLevel2HiiHandle
, STRING_TOKEN (STR_GEN_RES_OK
), NULL
);
312 DestPath
= AllocateZeroPool(PathLen
);
314 if (DestPath
== NULL
|| HiiOutput
== NULL
|| HiiResultOk
== NULL
) {
315 SHELL_FREE_NON_NULL(DestPath
);
316 SHELL_FREE_NON_NULL(HiiOutput
);
317 SHELL_FREE_NON_NULL(HiiResultOk
);
318 return (SHELL_OUT_OF_RESOURCES
);
322 // Go through the list of files to copy...
324 for (Node
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&FileList
->Link
)
325 ; !IsNull(&FileList
->Link
, &Node
->Link
)
326 ; Node
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&FileList
->Link
, &Node
->Link
)
328 if (ShellGetExecutionBreakFlag()) {
331 ASSERT(Node
->FileName
!= NULL
);
332 ASSERT(Node
->FullName
!= NULL
);
335 // skip the directory traversing stuff...
337 if (StrCmp(Node
->FileName
, L
".") == 0 || StrCmp(Node
->FileName
, L
"..") == 0) {
341 if (FileList
->Link
.ForwardLink
== FileList
->Link
.BackLink
// 1 item
342 && EFI_ERROR(ShellIsDirectory(DestDir
)) // not an existing directory
344 if (StrStr(DestDir
, L
":") == NULL
) {
346 // simple copy of a single file
348 StrCpy(DestPath
, Cwd
);
349 if (DestPath
[StrLen(DestPath
)-1] != L
'\\' && DestDir
[0] != L
'\\') {
350 StrCat(DestPath
, L
"\\");
351 } else if (DestPath
[StrLen(DestPath
)-1] == L
'\\' && DestDir
[0] == L
'\\') {
352 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
354 StrCat(DestPath
, DestDir
);
356 StrCpy(DestPath
, DestDir
);
360 // we have multiple files or a directory in the DestDir
364 // Check for leading slash
366 if (DestDir
[0] == L
'\\') {
368 // Copy to the root of CWD
370 StrCpy(DestPath
, Cwd
);
371 while (PathRemoveLastItem(DestPath
));
372 StrCat(DestPath
, DestDir
+1);
373 StrCat(DestPath
, Node
->FileName
);
374 } else if (StrStr(DestDir
, L
":") == NULL
) {
375 StrCpy(DestPath
, Cwd
);
376 if (DestPath
[StrLen(DestPath
)-1] != L
'\\' && DestDir
[0] != L
'\\') {
377 StrCat(DestPath
, L
"\\");
378 } else if (DestPath
[StrLen(DestPath
)-1] == L
'\\' && DestDir
[0] == L
'\\') {
379 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
381 StrCat(DestPath
, DestDir
);
382 if (DestDir
[StrLen(DestDir
)-1] != L
'\\' && Node
->FileName
[0] != L
'\\') {
383 StrCat(DestPath
, L
"\\");
384 } else if (DestDir
[StrLen(DestDir
)-1] == L
'\\' && Node
->FileName
[0] == L
'\\') {
385 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
387 StrCat(DestPath
, Node
->FileName
);
390 StrCpy(DestPath
, DestDir
);
391 if (DestDir
[StrLen(DestDir
)-1] != L
'\\' && Node
->FileName
[0] != L
'\\') {
392 StrCat(DestPath
, L
"\\");
393 } else if (DestDir
[StrLen(DestDir
)-1] == L
'\\' && Node
->FileName
[0] == L
'\\') {
394 ((CHAR16
*)DestDir
)[StrLen(DestDir
)-1] = CHAR_NULL
;
396 StrCat(DestPath
, Node
->FileName
);
401 // Make sure the path exists
403 if (EFI_ERROR(VerifyIntermediateDirectories(DestPath
))) {
404 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_DIR_WNF
), gShellLevel2HiiHandle
);
405 ShellStatus
= SHELL_DEVICE_ERROR
;
409 if ( !EFI_ERROR(ShellIsDirectory(Node
->FullName
))
410 && !EFI_ERROR(ShellIsDirectory(DestPath
))
411 && StrniCmp(Node
->FullName
, DestPath
, StrLen(DestPath
)) == NULL
413 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_SD_PARENT
), gShellLevel2HiiHandle
);
414 ShellStatus
= SHELL_INVALID_PARAMETER
;
417 if (StringNoCaseCompare(&Node
->FullName
, &DestPath
) == 0) {
418 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_SD_SAME
), gShellLevel2HiiHandle
);
419 ShellStatus
= SHELL_INVALID_PARAMETER
;
423 if ((TempLocation
= StrniCmp(Node
->FullName
, DestPath
, StrLen(Node
->FullName
))) == 0
424 && (DestPath
[StrLen(Node
->FullName
)] == CHAR_NULL
|| DestPath
[StrLen(Node
->FullName
)] == L
'\\')
426 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_SD_SAME
), gShellLevel2HiiHandle
);
427 ShellStatus
= SHELL_INVALID_PARAMETER
;
431 PathCleanUpDirectories(DestPath
);
433 ShellPrintEx(-1, -1, HiiOutput
, Node
->FullName
, DestPath
);
436 // copy single file...
438 ShellStatus
= CopySingleFile(Node
->FullName
, DestPath
, &Response
, SilentMode
);
439 if (ShellStatus
!= SHELL_SUCCESS
) {
443 if (ShellStatus
== SHELL_SUCCESS
&& Resp
== NULL
) {
444 ShellPrintEx(-1, -1, L
"%s", HiiResultOk
);
447 SHELL_FREE_NON_NULL(DestPath
);
448 SHELL_FREE_NON_NULL(HiiOutput
);
449 SHELL_FREE_NON_NULL(HiiResultOk
);
451 SHELL_FREE_NON_NULL(Response
);
454 return (ShellStatus
);
458 Validate and if successful copy all the files from the list into
459 destination directory.
461 @param[in] FileList The list of files to copy.
462 @param[in] DestDir The directory to copy files to.
463 @param[in] SilentMode TRUE to eliminate screen output.
464 @param[in] RecursiveMode TRUE to copy directories.
466 @retval SHELL_INVALID_PARAMETER A parameter was invalid.
467 @retval SHELL_SUCCESS The operation was successful.
471 ProcessValidateAndCopyFiles(
472 IN EFI_SHELL_FILE_INFO
*FileList
,
473 IN CONST CHAR16
*DestDir
,
474 IN BOOLEAN SilentMode
,
475 IN BOOLEAN RecursiveMode
478 SHELL_STATUS ShellStatus
;
479 EFI_SHELL_FILE_INFO
*List
;
481 EFI_FILE_INFO
*FileInfo
;
485 Status
= ShellOpenFileMetaArg((CHAR16
*)DestDir
, EFI_FILE_MODE_READ
, &List
);
486 if (List
!= NULL
&& List
->Link
.ForwardLink
!= List
->Link
.BackLink
) {
487 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_MARG_ERROR
), gShellLevel2HiiHandle
, DestDir
);
488 ShellStatus
= SHELL_INVALID_PARAMETER
;
489 ShellCloseFileMetaArg(&List
);
490 } else if (List
!= NULL
) {
491 ASSERT(((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
) != NULL
);
492 ASSERT(((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
)->FullName
!= NULL
);
494 FileInfo
= gEfiShellProtocol
->GetFileInfo(((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
)->Handle
);
495 ASSERT(FileInfo
!= NULL
);
496 if ((FileInfo
->Attribute
& EFI_FILE_READ_ONLY
) == 0) {
497 ShellStatus
= ValidateAndCopyFiles(FileList
, ((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
)->FullName
, SilentMode
, RecursiveMode
, NULL
);
499 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_DEST_ERROR
), gShellLevel2HiiHandle
);
500 ShellStatus
= SHELL_ACCESS_DENIED
;
502 SHELL_FREE_NON_NULL(FileInfo
);
503 ShellCloseFileMetaArg(&List
);
505 ShellStatus
= ValidateAndCopyFiles(FileList
, DestDir
, SilentMode
, RecursiveMode
, NULL
);
508 return (ShellStatus
);
511 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
518 Function for 'cp' command.
520 @param[in] ImageHandle Handle to the Image (NULL if Internal).
521 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
526 IN EFI_HANDLE ImageHandle
,
527 IN EFI_SYSTEM_TABLE
*SystemTable
532 CHAR16
*ProblemParam
;
533 SHELL_STATUS ShellStatus
;
536 EFI_SHELL_FILE_INFO
*FileList
;
538 BOOLEAN RecursiveMode
;
542 ShellStatus
= SHELL_SUCCESS
;
547 // initialize the shell lib (we must be in non-auto-init...)
549 Status
= ShellInitialize();
550 ASSERT_EFI_ERROR(Status
);
552 Status
= CommandInit();
553 ASSERT_EFI_ERROR(Status
);
556 // parse the command line
558 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
559 if (EFI_ERROR(Status
)) {
560 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
561 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, ProblemParam
);
562 FreePool(ProblemParam
);
563 ShellStatus
= SHELL_INVALID_PARAMETER
;
571 if (ShellCommandLineGetFlag(Package
, L
"-?")) {
576 // Initialize SilentMode and RecursiveMode
578 if (gEfiShellProtocol
->BatchIsActive()) {
581 SilentMode
= ShellCommandLineGetFlag(Package
, L
"-q");
583 RecursiveMode
= ShellCommandLineGetFlag(Package
, L
"-r");
585 switch (ParamCount
= ShellCommandLineGetCount(Package
)) {
589 // we have insufficient parameters
591 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
592 ShellStatus
= SHELL_INVALID_PARAMETER
;
596 // must have valid CWD for single parameter...
598 Cwd
= ShellGetCurrentDir(NULL
);
600 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_CWD
), gShellLevel2HiiHandle
);
601 ShellStatus
= SHELL_INVALID_PARAMETER
;
603 Status
= ShellOpenFileMetaArg((CHAR16
*)ShellCommandLineGetRawValue(Package
, 1), EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
, &FileList
);
604 if (FileList
== NULL
|| IsListEmpty(&FileList
->Link
) || EFI_ERROR(Status
)) {
605 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_NF
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, 1));
606 ShellStatus
= SHELL_NOT_FOUND
;
608 ShellStatus
= ProcessValidateAndCopyFiles(FileList
, Cwd
, SilentMode
, RecursiveMode
);
615 // Make a big list of all the files...
617 for (ParamCount
--, LoopCounter
= 1 ; LoopCounter
< ParamCount
&& ShellStatus
== SHELL_SUCCESS
; LoopCounter
++) {
618 if (ShellGetExecutionBreakFlag()) {
621 Status
= ShellOpenFileMetaArg((CHAR16
*)ShellCommandLineGetRawValue(Package
, LoopCounter
), EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
, &FileList
);
622 if (EFI_ERROR(Status
) || FileList
== NULL
|| IsListEmpty(&FileList
->Link
)) {
623 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_NF
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, LoopCounter
));
624 ShellStatus
= SHELL_NOT_FOUND
;
627 if (ShellStatus
!= SHELL_SUCCESS
) {
628 Status
= ShellCloseFileMetaArg(&FileList
);
631 // now copy them all...
633 if (FileList
!= NULL
&& !IsListEmpty(&FileList
->Link
)) {
634 ShellStatus
= ProcessValidateAndCopyFiles(FileList
, PathCleanUpDirectories((CHAR16
*)ShellCommandLineGetRawValue(Package
, ParamCount
)), SilentMode
, RecursiveMode
);
635 Status
= ShellCloseFileMetaArg(&FileList
);
636 if (EFI_ERROR(Status
) && ShellStatus
== SHELL_SUCCESS
) {
637 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_FILE
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, ParamCount
), ShellStatus
|MAX_BIT
);
638 ShellStatus
= SHELL_ACCESS_DENIED
;
643 } // switch on parameter count
645 if (FileList
!= NULL
) {
646 ShellCloseFileMetaArg(&FileList
);
650 // free the command line package
652 ShellCommandLineFreeVarList (Package
);
655 if (ShellGetExecutionBreakFlag()) {
656 return (SHELL_ABORTED
);
659 return (ShellStatus
);