2 Main file for NULL named library for level 2 shell command functions.
22 * functions are non-interactive only
25 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
26 This program and the accompanying materials
27 are licensed and made available under the terms and conditions of the BSD License
28 which accompanies this distribution. The full text of the license may be found at
29 http://opensource.org/licenses/bsd-license.php
31 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
32 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
35 #include "UefiShellLevel2CommandsLib.h"
37 CONST CHAR16 mFileName
[] = L
"ShellCommands";
38 EFI_HANDLE gShellLevel2HiiHandle
= NULL
;
41 Get the filename to get help text from if not using HII.
47 ShellCommandGetManFileNameLevel2 (
55 Constructor for the Shell Level 2 Commands library.
57 Install the handlers for level 2 UEFI Shell 2.0 commands.
59 @param ImageHandle the image handle of the process
60 @param SystemTable the EFI System Table pointer
62 @retval EFI_SUCCESS the shell command handlers were installed sucessfully
63 @retval EFI_UNSUPPORTED the shell level required was not found.
67 ShellLevel2CommandsLibConstructor (
68 IN EFI_HANDLE ImageHandle
,
69 IN EFI_SYSTEM_TABLE
*SystemTable
73 // if shell level is less than 2 do nothing
75 if (PcdGet8(PcdShellSupportLevel
) < 2) {
79 gShellLevel2HiiHandle
= HiiAddPackages (&gShellLevel2HiiGuid
, gImageHandle
, UefiShellLevel2CommandsLibStrings
, NULL
);
80 if (gShellLevel2HiiHandle
== NULL
) {
81 return (EFI_DEVICE_ERROR
);
85 // install our shell command handlers that are always installed
87 ShellCommandRegisterCommandName(L
"attrib", ShellCommandRunAttrib
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_ATTRIB
) );
88 ShellCommandRegisterCommandName(L
"cd", ShellCommandRunCd
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_CD
) );
89 ShellCommandRegisterCommandName(L
"cp", ShellCommandRunCp
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_CP
) );
90 ShellCommandRegisterCommandName(L
"load", ShellCommandRunLoad
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_LOAD
) );
91 ShellCommandRegisterCommandName(L
"map", ShellCommandRunMap
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_MAP
) );
92 ShellCommandRegisterCommandName(L
"mkdir", ShellCommandRunMkDir
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_MKDIR
) );
93 ShellCommandRegisterCommandName(L
"mv", ShellCommandRunMv
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_MV
) );
94 ShellCommandRegisterCommandName(L
"parse", ShellCommandRunParse
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_PARSE
) );
95 ShellCommandRegisterCommandName(L
"reset", ShellCommandRunReset
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_RESET
) );
96 ShellCommandRegisterCommandName(L
"set", ShellCommandRunSet
, ShellCommandGetManFileNameLevel2
, 2, L
"",FALSE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_SET
) );
97 ShellCommandRegisterCommandName(L
"ls", ShellCommandRunLs
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_LS
) );
98 ShellCommandRegisterCommandName(L
"rm", ShellCommandRunRm
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_RM
) );
99 ShellCommandRegisterCommandName(L
"vol", ShellCommandRunVol
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_VOL
) );
102 // support for permenant (built in) aliases
104 ShellCommandRegisterAlias(L
"rm", L
"del");
105 ShellCommandRegisterAlias(L
"ls", L
"dir");
106 ShellCommandRegisterAlias(L
"cp", L
"copy");
107 ShellCommandRegisterAlias(L
"mkdir", L
"md");
108 ShellCommandRegisterAlias(L
"cd ..", L
"cd..");
109 ShellCommandRegisterAlias(L
"cd \\", L
"cd\\");
110 ShellCommandRegisterAlias(L
"ren", L
"mv");
112 // These are installed in level 2 or 3...
114 if (PcdGet8(PcdShellSupportLevel
) == 2 || PcdGet8(PcdShellSupportLevel
) == 3) {
115 ShellCommandRegisterCommandName(L
"date", ShellCommandRunDate
, ShellCommandGetManFileNameLevel2
, PcdGet8(PcdShellSupportLevel
), L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_DATE
) );
116 ShellCommandRegisterCommandName(L
"time", ShellCommandRunTime
, ShellCommandGetManFileNameLevel2
, PcdGet8(PcdShellSupportLevel
), L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIME
) );
117 ShellCommandRegisterCommandName(L
"timezone", ShellCommandRunTimeZone
, ShellCommandGetManFileNameLevel2
, PcdGet8(PcdShellSupportLevel
), L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIMEZONE
));
121 // we want to be able to test these so install them under a different name in debug mode...
123 ShellCommandRegisterCommandName(L
"l2date", ShellCommandRunDate
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_DATE
) );
124 ShellCommandRegisterCommandName(L
"l2time", ShellCommandRunTime
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIME
) );
125 ShellCommandRegisterCommandName(L
"l2timezone", ShellCommandRunTimeZone
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIMEZONE
));
129 return (EFI_SUCCESS
);
133 Destructor for the library. free any resources.
135 @param ImageHandle The image handle of the process.
136 @param SystemTable The EFI System Table pointer.
138 @retval EFI_SUCCESS Always returned.
142 ShellLevel2CommandsLibDestructor (
143 IN EFI_HANDLE ImageHandle
,
144 IN EFI_SYSTEM_TABLE
*SystemTable
147 if (gShellLevel2HiiHandle
!= NULL
) {
148 HiiRemovePackages(gShellLevel2HiiHandle
);
150 return (EFI_SUCCESS
);
154 returns a fully qualified directory (contains a map drive at the begining)
155 path from a unknown directory path.
157 If Path is already fully qualified this will return a duplicat otherwise this
158 will use get the current directory and use that to build the fully qualified
161 if the return value is not NULL it must be caller freed.
163 @param[in] Path The unknown Path Value
165 @retval NULL A memory allocation failed
166 @retval NULL A fully qualified path could not be discovered.
167 @retval other An allocated pointer to a fuly qualified path.
171 GetFullyQualifiedPath(
172 IN CONST CHAR16
* Path
175 CHAR16
*PathToReturn
;
177 CONST CHAR16
*CurDir
;
182 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
184 // convert a local path to an absolute path
186 if (StrStr(Path
, L
":") == NULL
) {
187 CurDir
= gEfiShellProtocol
->GetCurDir(NULL
);
188 StrnCatGrow(&PathToReturn
, &Size
, CurDir
, 0);
189 if (*Path
== L
'\\') {
193 StrnCatGrow(&PathToReturn
, &Size
, Path
, 0);
195 PathCleanUpDirectories(PathToReturn
);
197 if (PathToReturn
== NULL
) {
201 while (PathToReturn
[StrLen(PathToReturn
)-1] == L
'*') {
202 PathToReturn
[StrLen(PathToReturn
)-1] = CHAR_NULL
;
205 return (PathToReturn
);
209 Function to verify all intermediate directories in the path.
211 @param[in] Path The pointer to the path to fix.
213 @retval EFI_SUCCESS The operation was successful.
217 VerifyIntermediateDirectories (
218 IN CONST CHAR16
*Path
224 SHELL_FILE_HANDLE FileHandle
;
226 ASSERT(Path
!= NULL
);
228 Status
= EFI_SUCCESS
;
230 PathCopy
= StrnCatGrow(&PathCopy
, NULL
, Path
, 0);
233 if (PathCopy
== NULL
) {
234 return (EFI_OUT_OF_RESOURCES
);
237 for (TempSpot
= &PathCopy
[StrLen(PathCopy
)-1] ; *TempSpot
!= CHAR_NULL
&& *TempSpot
!= L
'\\' ; TempSpot
= &PathCopy
[StrLen(PathCopy
)-1]){
238 *TempSpot
= CHAR_NULL
;
240 if (*TempSpot
== L
'\\') {
241 *TempSpot
= CHAR_NULL
;
244 if (PathCopy
!= NULL
&& *PathCopy
!= CHAR_NULL
) {
245 Status
= VerifyIntermediateDirectories(PathCopy
);
247 if (PathCopy
[StrLen(PathCopy
)-1] != L
':') {
248 if (!EFI_ERROR(Status
)) {
249 Status
= ShellOpenFileByName(PathCopy
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
250 if (FileHandle
!= NULL
) {
251 ShellCloseFile(&FileHandle
);
257 SHELL_FREE_NON_NULL(PathCopy
);
263 Be lazy and borrow from baselib.
265 @param[in] Char The character to convert to upper case.
267 @return Char as an upper case character.
271 InternalCharToUpper (
276 String comparison without regard to case for a limited number of characters.
278 @param[in] Source The first item to compare.
279 @param[in] Target The second item to compare.
280 @param[in] Count How many characters to compare.
282 @retval NULL Source and Target are identical strings without regard to case.
283 @return The location in Source where there is a difference.
288 IN CONST CHAR16
*Source
,
289 IN CONST CHAR16
*Target
,
297 ASSERT(Source
!= NULL
);
298 ASSERT(Target
!= NULL
);
300 for (LoopCount
= 0 ; LoopCount
< Count
; LoopCount
++) {
301 Char1
= InternalCharToUpper(Source
[LoopCount
]);
302 Char2
= InternalCharToUpper(Target
[LoopCount
]);
303 if (Char1
!= Char2
) {
304 return (&Source
[LoopCount
]);