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 // If we are trying to copy multiple files... make sure we got a directory for the target...
260 if (EFI_ERROR(ShellIsDirectory(DestDir
)) && FileList
->Link
.ForwardLink
!= FileList
->Link
.BackLink
) {
262 // Error for destination not a directory
264 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NOT_DIR
), gShellLevel2HiiHandle
, DestDir
);
265 return (SHELL_INVALID_PARAMETER
);
267 for (Node
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&FileList
->Link
)
268 ; !IsNull(&FileList
->Link
, &Node
->Link
)
269 ; Node
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&FileList
->Link
, &Node
->Link
)
272 // skip the directory traversing stuff...
274 if (StrCmp(Node
->FileName
, L
".") == 0 || StrCmp(Node
->FileName
, L
"..") == 0) {
278 NewSize
= StrSize(DestDir
);
279 NewSize
+= StrSize(Node
->FullName
);
280 NewSize
+= StrSize(Cwd
);
281 if (NewSize
> PathLen
) {
286 // Make sure got -r if required
288 if (!RecursiveMode
&& !EFI_ERROR(ShellIsDirectory(Node
->FullName
))) {
289 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_DIR_REQ
), gShellLevel2HiiHandle
);
290 return (SHELL_INVALID_PARAMETER
);
294 // make sure got dest as dir if needed
296 if (!EFI_ERROR(ShellIsDirectory(Node
->FullName
)) && EFI_ERROR(ShellIsDirectory(DestDir
))) {
298 // Error for destination not a directory
300 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NOT_DIR
), gShellLevel2HiiHandle
, DestDir
);
301 return (SHELL_INVALID_PARAMETER
);
305 HiiOutput
= HiiGetString (gShellLevel2HiiHandle
, STRING_TOKEN (STR_CP_OUTPUT
), NULL
);
306 HiiResultOk
= HiiGetString (gShellLevel2HiiHandle
, STRING_TOKEN (STR_GEN_RES_OK
), NULL
);
307 DestPath
= AllocateZeroPool(PathLen
);
309 if (DestPath
== NULL
|| HiiOutput
== NULL
|| HiiResultOk
== NULL
) {
310 SHELL_FREE_NON_NULL(DestPath
);
311 SHELL_FREE_NON_NULL(HiiOutput
);
312 SHELL_FREE_NON_NULL(HiiResultOk
);
313 return (SHELL_OUT_OF_RESOURCES
);
317 // Go through the list of files to copy...
319 for (Node
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&FileList
->Link
)
320 ; !IsNull(&FileList
->Link
, &Node
->Link
)
321 ; Node
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&FileList
->Link
, &Node
->Link
)
323 if (ShellGetExecutionBreakFlag()) {
326 ASSERT(Node
->FileName
!= NULL
);
327 ASSERT(Node
->FullName
!= NULL
);
330 // skip the directory traversing stuff...
332 if (StrCmp(Node
->FileName
, L
".") == 0 || StrCmp(Node
->FileName
, L
"..") == 0) {
336 if (FileList
->Link
.ForwardLink
== FileList
->Link
.BackLink
// 1 item
337 && EFI_ERROR(ShellIsDirectory(DestDir
)) // not an existing directory
339 if (StrStr(DestDir
, L
":") == NULL
) {
341 // simple copy of a single file
343 StrCpy(DestPath
, Cwd
);
344 if (DestPath
[StrLen(DestPath
)-1] != L
'\\' && DestDir
[0] != L
'\\') {
345 StrCat(DestPath
, L
"\\");
346 } else if (DestPath
[StrLen(DestPath
)-1] == L
'\\' && DestDir
[0] == L
'\\') {
347 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
349 StrCat(DestPath
, DestDir
);
351 StrCpy(DestPath
, DestDir
);
355 // we have multiple files or a directory in the DestDir
357 if (StrStr(DestDir
, L
":") == NULL
) {
358 StrCpy(DestPath
, Cwd
);
359 if (DestPath
[StrLen(DestPath
)-1] != L
'\\' && DestDir
[0] != L
'\\') {
360 StrCat(DestPath
, L
"\\");
361 } else if (DestPath
[StrLen(DestPath
)-1] == L
'\\' && DestDir
[0] == L
'\\') {
362 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
364 StrCat(DestPath
, DestDir
);
365 if (DestDir
[StrLen(DestDir
)-1] != L
'\\' && Node
->FileName
[0] != L
'\\') {
366 StrCat(DestPath
, L
"\\");
367 } else if (DestDir
[StrLen(DestDir
)-1] == L
'\\' && Node
->FileName
[0] == L
'\\') {
368 ((CHAR16
*)DestPath
)[StrLen(DestPath
)-1] = CHAR_NULL
;
370 StrCat(DestPath
, Node
->FileName
);
373 StrCpy(DestPath
, DestDir
);
374 if (DestDir
[StrLen(DestDir
)-1] != L
'\\' && Node
->FileName
[0] != L
'\\') {
375 StrCat(DestPath
, L
"\\");
376 } else if (DestDir
[StrLen(DestDir
)-1] == L
'\\' && Node
->FileName
[0] == L
'\\') {
377 ((CHAR16
*)DestDir
)[StrLen(DestDir
)-1] = CHAR_NULL
;
379 StrCat(DestPath
, Node
->FileName
);
384 // Make sure the path exists
386 if (EFI_ERROR(VerifyIntermediateDirectories(DestPath
))) {
387 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_DIR_WNF
), gShellLevel2HiiHandle
);
388 ShellStatus
= SHELL_DEVICE_ERROR
;
392 if ( !EFI_ERROR(ShellIsDirectory(Node
->FullName
))
393 && !EFI_ERROR(ShellIsDirectory(DestPath
))
394 && StrniCmp(Node
->FullName
, DestPath
, StrLen(DestPath
)) == NULL
396 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_SD_PARENT
), gShellLevel2HiiHandle
);
397 ShellStatus
= SHELL_INVALID_PARAMETER
;
400 if (StringNoCaseCompare(&Node
->FullName
, &DestPath
) == 0) {
401 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_SD_SAME
), gShellLevel2HiiHandle
);
402 ShellStatus
= SHELL_INVALID_PARAMETER
;
406 if ((TempLocation
= StrniCmp(Node
->FullName
, DestPath
, StrLen(Node
->FullName
))) == 0
407 && (DestPath
[StrLen(Node
->FullName
)] == CHAR_NULL
|| DestPath
[StrLen(Node
->FullName
)] == L
'\\')
409 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_SD_SAME
), gShellLevel2HiiHandle
);
410 ShellStatus
= SHELL_INVALID_PARAMETER
;
416 ShellPrintEx(-1, -1, HiiOutput
, Node
->FullName
, DestPath
);
419 // copy single file...
421 ShellStatus
= CopySingleFile(Node
->FullName
, DestPath
, &Response
, SilentMode
);
422 if (ShellStatus
!= SHELL_SUCCESS
) {
426 if (ShellStatus
== SHELL_SUCCESS
&& Resp
== NULL
) {
427 ShellPrintEx(-1, -1, L
"%s", HiiResultOk
);
430 SHELL_FREE_NON_NULL(DestPath
);
431 SHELL_FREE_NON_NULL(HiiOutput
);
432 SHELL_FREE_NON_NULL(HiiResultOk
);
434 SHELL_FREE_NON_NULL(Response
);
437 return (ShellStatus
);
441 Validate and if successful copy all the files from the list into
442 destination directory.
444 @param[in] FileList The list of files to copy.
445 @param[in] DestDir The directory to copy files to.
446 @param[in] SilentMode TRUE to eliminate screen output.
447 @param[in] RecursiveMode TRUE to copy directories.
449 @retval SHELL_INVALID_PARAMETER A parameter was invalid.
450 @retval SHELL_SUCCESS The operation was successful.
454 ProcessValidateAndCopyFiles(
455 IN EFI_SHELL_FILE_INFO
*FileList
,
456 IN CONST CHAR16
*DestDir
,
457 IN BOOLEAN SilentMode
,
458 IN BOOLEAN RecursiveMode
461 SHELL_STATUS ShellStatus
;
462 EFI_SHELL_FILE_INFO
*List
;
464 EFI_FILE_INFO
*FileInfo
;
468 Status
= ShellOpenFileMetaArg((CHAR16
*)DestDir
, EFI_FILE_MODE_READ
, &List
);
469 if (List
!= NULL
&& List
->Link
.ForwardLink
!= List
->Link
.BackLink
) {
470 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_MARG_ERROR
), gShellLevel2HiiHandle
, DestDir
);
471 ShellStatus
= SHELL_INVALID_PARAMETER
;
472 ShellCloseFileMetaArg(&List
);
473 } else if (List
!= NULL
) {
474 ASSERT(((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
) != NULL
);
475 ASSERT(((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
)->FullName
!= NULL
);
477 FileInfo
= gEfiShellProtocol
->GetFileInfo(((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
)->Handle
);
478 ASSERT(FileInfo
!= NULL
);
479 if ((FileInfo
->Attribute
& EFI_FILE_READ_ONLY
) == 0) {
480 ShellStatus
= ValidateAndCopyFiles(FileList
, ((EFI_SHELL_FILE_INFO
*)List
->Link
.ForwardLink
)->FullName
, SilentMode
, RecursiveMode
, NULL
);
482 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_CP_DEST_ERROR
), gShellLevel2HiiHandle
);
483 ShellStatus
= SHELL_ACCESS_DENIED
;
485 SHELL_FREE_NON_NULL(FileInfo
);
486 ShellCloseFileMetaArg(&List
);
488 ShellStatus
= ValidateAndCopyFiles(FileList
, DestDir
, SilentMode
, RecursiveMode
, NULL
);
491 return (ShellStatus
);
494 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
501 Function for 'cp' command.
503 @param[in] ImageHandle Handle to the Image (NULL if Internal).
504 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
509 IN EFI_HANDLE ImageHandle
,
510 IN EFI_SYSTEM_TABLE
*SystemTable
515 CHAR16
*ProblemParam
;
516 SHELL_STATUS ShellStatus
;
519 EFI_SHELL_FILE_INFO
*FileList
;
521 BOOLEAN RecursiveMode
;
525 ShellStatus
= SHELL_SUCCESS
;
530 // initialize the shell lib (we must be in non-auto-init...)
532 Status
= ShellInitialize();
533 ASSERT_EFI_ERROR(Status
);
535 Status
= CommandInit();
536 ASSERT_EFI_ERROR(Status
);
539 // parse the command line
541 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
542 if (EFI_ERROR(Status
)) {
543 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
544 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, ProblemParam
);
545 FreePool(ProblemParam
);
546 ShellStatus
= SHELL_INVALID_PARAMETER
;
554 if (ShellCommandLineGetFlag(Package
, L
"-?")) {
559 // Initialize SilentMode and RecursiveMode
561 if (gEfiShellProtocol
->BatchIsActive()) {
564 SilentMode
= ShellCommandLineGetFlag(Package
, L
"-q");
566 RecursiveMode
= ShellCommandLineGetFlag(Package
, L
"-r");
568 switch (ParamCount
= ShellCommandLineGetCount(Package
)) {
572 // we have insufficient parameters
574 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
575 ShellStatus
= SHELL_INVALID_PARAMETER
;
579 // must have valid CWD for single parameter...
581 Cwd
= ShellGetCurrentDir(NULL
);
583 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_CWD
), gShellLevel2HiiHandle
);
584 ShellStatus
= SHELL_INVALID_PARAMETER
;
586 Status
= ShellOpenFileMetaArg((CHAR16
*)ShellCommandLineGetRawValue(Package
, 1), EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
, &FileList
);
587 if (FileList
== NULL
|| IsListEmpty(&FileList
->Link
) || EFI_ERROR(Status
)) {
588 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_NF
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, 1));
589 ShellStatus
= SHELL_NOT_FOUND
;
591 ShellStatus
= ProcessValidateAndCopyFiles(FileList
, Cwd
, SilentMode
, RecursiveMode
);
598 // Make a big list of all the files...
600 for (ParamCount
--, LoopCounter
= 1 ; LoopCounter
< ParamCount
&& ShellStatus
== SHELL_SUCCESS
; LoopCounter
++) {
601 if (ShellGetExecutionBreakFlag()) {
604 Status
= ShellOpenFileMetaArg((CHAR16
*)ShellCommandLineGetRawValue(Package
, LoopCounter
), EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
, &FileList
);
605 if (EFI_ERROR(Status
) || FileList
== NULL
|| IsListEmpty(&FileList
->Link
)) {
606 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_NF
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, LoopCounter
));
607 ShellStatus
= SHELL_NOT_FOUND
;
610 if (ShellStatus
!= SHELL_SUCCESS
) {
611 Status
= ShellCloseFileMetaArg(&FileList
);
614 // now copy them all...
616 if (FileList
!= NULL
&& !IsListEmpty(&FileList
->Link
)) {
617 ShellStatus
= ProcessValidateAndCopyFiles(FileList
, ShellCommandCleanPath((CHAR16
*)ShellCommandLineGetRawValue(Package
, ParamCount
)), SilentMode
, RecursiveMode
);
618 Status
= ShellCloseFileMetaArg(&FileList
);
619 if (EFI_ERROR(Status
) && ShellStatus
== SHELL_SUCCESS
) {
620 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_FILE
), gShellLevel2HiiHandle
, ShellCommandLineGetRawValue(Package
, ParamCount
), ShellStatus
|MAX_BIT
);
621 ShellStatus
= SHELL_ACCESS_DENIED
;
626 } // switch on parameter count
628 if (FileList
!= NULL
) {
629 ShellCloseFileMetaArg(&FileList
);
633 // free the command line package
635 ShellCommandLineFreeVarList (Package
);
638 if (ShellGetExecutionBreakFlag()) {
639 return (SHELL_ABORTED
);
642 return (ShellStatus
);