2 Main file for NULL named library for level 2 shell command functions.
22 * functions are non-interactive only
25 Copyright (c) 2009 - 2011, 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
;
39 CONST EFI_GUID gShellLevel2HiiGuid
= \
41 0xf95a7ccc, 0x4c55, 0x4426, { 0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae } \
45 Get the filename to get help text from if not using HII.
51 ShellCommandGetManFileNameLevel2 (
59 Constructor for the Shell Level 2 Commands library.
61 Install the handlers for level 2 UEFI Shell 2.0 commands.
63 @param ImageHandle the image handle of the process
64 @param SystemTable the EFI System Table pointer
66 @retval EFI_SUCCESS the shell command handlers were installed sucessfully
67 @retval EFI_UNSUPPORTED the shell level required was not found.
71 ShellLevel2CommandsLibConstructor (
72 IN EFI_HANDLE ImageHandle
,
73 IN EFI_SYSTEM_TABLE
*SystemTable
77 // if shell level is less than 2 do nothing
79 if (PcdGet8(PcdShellSupportLevel
) < 2) {
80 return (EFI_UNSUPPORTED
);
83 gShellLevel2HiiHandle
= HiiAddPackages (&gShellLevel2HiiGuid
, gImageHandle
, UefiShellLevel2CommandsLibStrings
, NULL
);
84 if (gShellLevel2HiiHandle
== NULL
) {
85 return (EFI_DEVICE_ERROR
);
89 // install our shell command handlers that are always installed
91 ShellCommandRegisterCommandName(L
"attrib", ShellCommandRunAttrib
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_ATTRIB
) );
92 ShellCommandRegisterCommandName(L
"cd", ShellCommandRunCd
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_CD
) );
93 ShellCommandRegisterCommandName(L
"cp", ShellCommandRunCp
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_CP
) );
94 ShellCommandRegisterCommandName(L
"load", ShellCommandRunLoad
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_LOAD
) );
95 ShellCommandRegisterCommandName(L
"map", ShellCommandRunMap
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_MAP
) );
96 ShellCommandRegisterCommandName(L
"mkdir", ShellCommandRunMkDir
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_MKDIR
) );
97 ShellCommandRegisterCommandName(L
"mv", ShellCommandRunMv
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_MV
) );
98 ShellCommandRegisterCommandName(L
"parse", ShellCommandRunParse
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_PARSE
) );
99 ShellCommandRegisterCommandName(L
"reset", ShellCommandRunReset
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_RESET
) );
100 ShellCommandRegisterCommandName(L
"set", ShellCommandRunSet
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_SET
) );
101 ShellCommandRegisterCommandName(L
"ls", ShellCommandRunLs
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_LS
) );
102 ShellCommandRegisterCommandName(L
"rm", ShellCommandRunRm
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_RM
) );
103 ShellCommandRegisterCommandName(L
"vol", ShellCommandRunVol
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_VOL
) );
106 // support for permenant (built in) aliases
108 ShellCommandRegisterAlias(L
"rm", L
"del");
109 ShellCommandRegisterAlias(L
"ls", L
"dir");
110 ShellCommandRegisterAlias(L
"cp", L
"copy");
111 ShellCommandRegisterAlias(L
"mkdir", L
"md");
112 ShellCommandRegisterAlias(L
"cd ..", L
"cd..");
113 ShellCommandRegisterAlias(L
"cd \\", L
"cd\\");
115 // These are installed in level 2 or 3...
117 if (PcdGet8(PcdShellSupportLevel
) == 2 || PcdGet8(PcdShellSupportLevel
) == 3) {
118 ShellCommandRegisterCommandName(L
"date", ShellCommandRunDate
, ShellCommandGetManFileNameLevel2
, PcdGet8(PcdShellSupportLevel
), L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_DATE
) );
119 ShellCommandRegisterCommandName(L
"time", ShellCommandRunTime
, ShellCommandGetManFileNameLevel2
, PcdGet8(PcdShellSupportLevel
), L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIME
) );
120 ShellCommandRegisterCommandName(L
"timezone", ShellCommandRunTimeZone
, ShellCommandGetManFileNameLevel2
, PcdGet8(PcdShellSupportLevel
), L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIMEZONE
));
124 // we want to be able to test these so install them under a different name in debug mode...
126 ShellCommandRegisterCommandName(L
"l2date", ShellCommandRunDate
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_DATE
) );
127 ShellCommandRegisterCommandName(L
"l2time", ShellCommandRunTime
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIME
) );
128 ShellCommandRegisterCommandName(L
"l2timezone", ShellCommandRunTimeZone
, ShellCommandGetManFileNameLevel2
, 2, L
"", TRUE
, gShellLevel2HiiHandle
, STRING_TOKEN(STR_GET_HELP_TIMEZONE
));
132 return (EFI_SUCCESS
);
136 Destructor for the library. free any resources.
138 @param ImageHandle The image handle of the process.
139 @param SystemTable The EFI System Table pointer.
141 @retval EFI_SUCCESS Always returned.
145 ShellLevel2CommandsLibDestructor (
146 IN EFI_HANDLE ImageHandle
,
147 IN EFI_SYSTEM_TABLE
*SystemTable
150 if (gShellLevel2HiiHandle
!= NULL
) {
151 HiiRemovePackages(gShellLevel2HiiHandle
);
153 return (EFI_SUCCESS
);
157 Function to clean up paths. Removes the following items:
158 single periods in the path (no need for the current directory tag)
159 double periods in the path and removes a single parent directory.
161 This will be done inline and the resultant string may be be 'too big'.
163 @param[in] PathToReturn The pointer to the string containing the path.
165 @return PathToReturn is always returned.
170 IN CHAR16
*PathToReturn
175 if (PathToReturn
==NULL
) {
179 // Fix up the directory name
181 while ((TempString
= StrStr(PathToReturn
, L
"\\..\\")) != NULL
) {
182 *TempString
= CHAR_NULL
;
184 ChopLastSlash(PathToReturn
);
185 TempSize
= StrSize(TempString
);
186 CopyMem(PathToReturn
+StrLen(PathToReturn
), TempString
, TempSize
);
188 if ((TempString
= StrStr(PathToReturn
, L
"\\..")) != NULL
&& *(TempString
+ 3) == CHAR_NULL
) {
189 *TempString
= CHAR_NULL
;
190 ChopLastSlash(PathToReturn
);
192 while ((TempString
= StrStr(PathToReturn
, L
"\\.\\")) != NULL
) {
193 *TempString
= CHAR_NULL
;
195 TempSize
= StrSize(TempString
);
196 CopyMem(PathToReturn
+StrLen(PathToReturn
), TempString
, TempSize
);
198 if ((TempString
= StrStr(PathToReturn
, L
"\\.")) != NULL
&& *(TempString
+ 2) == CHAR_NULL
) {
199 *TempString
= CHAR_NULL
;
201 return (PathToReturn
);
205 returns a fully qualified directory (contains a map drive at the begining)
206 path from a unknown directory path.
208 If Path is already fully qualified this will return a duplicat otherwise this
209 will use get the current directory and use that to build the fully qualified
212 if the return value is not NULL it must be caller freed.
214 @param[in] Path The unknown Path Value
216 @retval NULL A memory allocation failed
217 @retval NULL a fully qualified path could not be discovered.
218 @retval other pointer to a fuly qualified path.
222 GetFullyQualifiedPath(
223 IN CONST CHAR16
* Path
226 CHAR16
*PathToReturn
;
228 CONST CHAR16
*CurDir
;
233 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
235 // convert a local path to an absolute path
237 if (StrStr(Path
, L
":") == NULL
) {
238 CurDir
= gEfiShellProtocol
->GetCurDir(NULL
);
239 StrnCatGrow(&PathToReturn
, &Size
, CurDir
, 0);
240 if (*Path
== L
'\\') {
244 StrnCatGrow(&PathToReturn
, &Size
, Path
, 0);
246 CleanPath(PathToReturn
);
248 while (PathToReturn
[StrLen(PathToReturn
)-1] == L
'*') {
249 PathToReturn
[StrLen(PathToReturn
)-1] = CHAR_NULL
;
252 return (PathToReturn
);
256 Function to verify all intermediate directories in the path.
258 @param[in] Path The pointer to the path to fix.
260 @retval EFI_SUCCESS The operation was successful.
264 VerifyIntermediateDirectories (
265 IN CONST CHAR16
*Path
271 SHELL_FILE_HANDLE FileHandle
;
273 ASSERT(Path
!= NULL
);
275 Status
= EFI_SUCCESS
;
277 PathCopy
= StrnCatGrow(&PathCopy
, NULL
, Path
, 0);
280 for (TempSpot
= &PathCopy
[StrLen(PathCopy
)-1] ; *TempSpot
!= CHAR_NULL
&& *TempSpot
!= L
'\\' ; TempSpot
= &PathCopy
[StrLen(PathCopy
)-1]){
281 *TempSpot
= CHAR_NULL
;
283 if (*TempSpot
== L
'\\') {
284 *TempSpot
= CHAR_NULL
;
287 if (PathCopy
!= NULL
&& *PathCopy
!= CHAR_NULL
) {
288 Status
= VerifyIntermediateDirectories(PathCopy
);
290 if (PathCopy
[StrLen(PathCopy
)-1] != L
':') {
291 if (!EFI_ERROR(Status
)) {
292 Status
= ShellOpenFileByName(PathCopy
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
293 if (FileHandle
!= NULL
) {
294 ShellCloseFile(&FileHandle
);
300 SHELL_FREE_NON_NULL(PathCopy
);
306 Be lazy and borrow from baselib.
308 @param[in] Char The character to convert to upper case.
310 @return Char as an upper case character.
314 InternalCharToUpper (
319 String comparison without regard to case for a limited number of characters.
321 @param[in] Source The first item to compare.
322 @param[in] Target The second item to compare.
323 @param[in] Count How many characters to compare.
325 @retval NULL Source and Target are identical strings without regard to case.
326 @return The location in Source where there is a difference.
331 IN CONST CHAR16
*Source
,
332 IN CONST CHAR16
*Target
,
340 ASSERT(Source
!= NULL
);
341 ASSERT(Target
!= NULL
);
343 for (LoopCount
= 0 ; LoopCount
< Count
; LoopCount
++) {
344 Char1
= InternalCharToUpper(Source
[LoopCount
]);
345 Char2
= InternalCharToUpper(Target
[LoopCount
]);
346 if (Char1
!= Char2
) {
347 return (&Source
[LoopCount
]);