]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Application/Shell/Shell.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ShellPkg: Refactor Alias replacement into separate function
[mirror_edk2.git] / ShellPkg / Application / Shell / Shell.c
1 /** @file
2 This is THE shell (application)
3
4 Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2013, Hewlett-Packard Development Company, L.P.
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "Shell.h"
17
18 //
19 // Initialize the global structure
20 //
21 SHELL_INFO ShellInfoObject = {
22 NULL,
23 NULL,
24 FALSE,
25 FALSE,
26 {
27 {{
28 0,
29 0,
30 0,
31 0,
32 0,
33 0,
34 0,
35 0,
36 0
37 }},
38 0,
39 NULL,
40 NULL
41 },
42 {{NULL, NULL}, NULL},
43 {
44 {{NULL, NULL}, NULL},
45 0,
46 0,
47 TRUE
48 },
49 NULL,
50 0,
51 NULL,
52 NULL,
53 NULL,
54 NULL,
55 NULL,
56 {{NULL, NULL}, NULL, NULL},
57 {{NULL, NULL}, NULL, NULL},
58 NULL,
59 NULL,
60 NULL,
61 NULL,
62 NULL,
63 NULL,
64 NULL,
65 NULL,
66 FALSE
67 };
68
69 STATIC CONST CHAR16 mScriptExtension[] = L".NSH";
70 STATIC CONST CHAR16 mExecutableExtensions[] = L".NSH;.EFI";
71 STATIC CONST CHAR16 mStartupScript[] = L"startup.nsh";
72
73 /**
74 Cleans off leading and trailing spaces and tabs
75
76 @param[in] String pointer to the string to trim them off
77 **/
78 EFI_STATUS
79 EFIAPI
80 TrimSpaces(
81 IN CHAR16 **String
82 )
83 {
84 ASSERT(String != NULL);
85 ASSERT(*String!= NULL);
86 //
87 // Remove any spaces and tabs at the beginning of the (*String).
88 //
89 while (((*String)[0] == L' ') || ((*String)[0] == L'\t')) {
90 CopyMem((*String), (*String)+1, StrSize((*String)) - sizeof((*String)[0]));
91 }
92
93 //
94 // Remove any spaces at the end of the (*String).
95 //
96 while ((*String)[StrLen((*String))-1] == L' ') {
97 (*String)[StrLen((*String))-1] = CHAR_NULL;
98 }
99
100 return (EFI_SUCCESS);
101 }
102
103 /**
104 Find a command line contains a split operation
105
106 @param[in] CmdLine The command line to parse.
107
108 @retval A pointer to the | character in CmdLine or NULL if not present.
109 **/
110 CONST
111 CHAR16*
112 EFIAPI
113 FindSplit(
114 IN CONST CHAR16 *CmdLine
115 )
116 {
117 CONST CHAR16 *TempSpot;
118 TempSpot = NULL;
119 if (StrStr(CmdLine, L"|") != NULL) {
120 for (TempSpot = CmdLine ; TempSpot != NULL && *TempSpot != CHAR_NULL ; TempSpot++) {
121 if (*TempSpot == L'^' && *(TempSpot+1) == L'|') {
122 TempSpot++;
123 } else if (*TempSpot == L'|') {
124 break;
125 }
126 }
127 }
128 return (TempSpot);
129 }
130
131 /**
132 Determine if a command line contains a split operation
133
134 @param[in] CmdLine The command line to parse.
135
136 @retval TRUE CmdLine has a valid split.
137 @retval FALSE CmdLine does not have a valid split.
138 **/
139 BOOLEAN
140 EFIAPI
141 ContainsSplit(
142 IN CONST CHAR16 *CmdLine
143 )
144 {
145 CONST CHAR16 *TempSpot;
146 TempSpot = FindSplit(CmdLine);
147 return (TempSpot != NULL && *TempSpot != CHAR_NULL);
148 }
149
150 /**
151 Function to start monitoring for CTRL-S using SimpleTextInputEx. This
152 feature's enabled state was not known when the shell initially launched.
153
154 @retval EFI_SUCCESS The feature is enabled.
155 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
156 **/
157 EFI_STATUS
158 EFIAPI
159 InternalEfiShellStartCtrlSMonitor(
160 VOID
161 )
162 {
163 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *SimpleEx;
164 EFI_KEY_DATA KeyData;
165 EFI_STATUS Status;
166
167 Status = gBS->OpenProtocol(
168 gST->ConsoleInHandle,
169 &gEfiSimpleTextInputExProtocolGuid,
170 (VOID**)&SimpleEx,
171 gImageHandle,
172 NULL,
173 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
174 if (EFI_ERROR(Status)) {
175 ShellPrintHiiEx(
176 -1,
177 -1,
178 NULL,
179 STRING_TOKEN (STR_SHELL_NO_IN_EX),
180 ShellInfoObject.HiiHandle);
181 return (EFI_SUCCESS);
182 }
183
184 KeyData.KeyState.KeyToggleState = 0;
185 KeyData.Key.ScanCode = 0;
186 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;
187 KeyData.Key.UnicodeChar = L's';
188
189 Status = SimpleEx->RegisterKeyNotify(
190 SimpleEx,
191 &KeyData,
192 NotificationFunction,
193 &ShellInfoObject.CtrlSNotifyHandle1);
194
195 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;
196 if (!EFI_ERROR(Status)) {
197 Status = SimpleEx->RegisterKeyNotify(
198 SimpleEx,
199 &KeyData,
200 NotificationFunction,
201 &ShellInfoObject.CtrlSNotifyHandle2);
202 }
203 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;
204 KeyData.Key.UnicodeChar = 19;
205
206 if (!EFI_ERROR(Status)) {
207 Status = SimpleEx->RegisterKeyNotify(
208 SimpleEx,
209 &KeyData,
210 NotificationFunction,
211 &ShellInfoObject.CtrlSNotifyHandle3);
212 }
213 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;
214 if (!EFI_ERROR(Status)) {
215 Status = SimpleEx->RegisterKeyNotify(
216 SimpleEx,
217 &KeyData,
218 NotificationFunction,
219 &ShellInfoObject.CtrlSNotifyHandle4);
220 }
221 return (Status);
222 }
223
224
225
226 /**
227 The entry point for the application.
228
229 @param[in] ImageHandle The firmware allocated handle for the EFI image.
230 @param[in] SystemTable A pointer to the EFI System Table.
231
232 @retval EFI_SUCCESS The entry point is executed successfully.
233 @retval other Some error occurs when executing this entry point.
234
235 **/
236 EFI_STATUS
237 EFIAPI
238 UefiMain (
239 IN EFI_HANDLE ImageHandle,
240 IN EFI_SYSTEM_TABLE *SystemTable
241 )
242 {
243 EFI_STATUS Status;
244 CHAR16 *TempString;
245 UINTN Size;
246 EFI_HANDLE ConInHandle;
247 EFI_SIMPLE_TEXT_INPUT_PROTOCOL *OldConIn;
248
249 if (PcdGet8(PcdShellSupportLevel) > 3) {
250 return (EFI_UNSUPPORTED);
251 }
252
253 //
254 // Clear the screen
255 //
256 Status = gST->ConOut->ClearScreen(gST->ConOut);
257 if (EFI_ERROR(Status)) {
258 return (Status);
259 }
260
261 //
262 // Populate the global structure from PCDs
263 //
264 ShellInfoObject.ImageDevPath = NULL;
265 ShellInfoObject.FileDevPath = NULL;
266 ShellInfoObject.PageBreakEnabled = PcdGetBool(PcdShellPageBreakDefault);
267 ShellInfoObject.ViewingSettings.InsertMode = PcdGetBool(PcdShellInsertModeDefault);
268 ShellInfoObject.LogScreenCount = PcdGet8 (PcdShellScreenLogCount );
269
270 //
271 // verify we dont allow for spec violation
272 //
273 ASSERT(ShellInfoObject.LogScreenCount >= 3);
274
275 //
276 // Initialize the LIST ENTRY objects...
277 //
278 InitializeListHead(&ShellInfoObject.BufferToFreeList.Link);
279 InitializeListHead(&ShellInfoObject.ViewingSettings.CommandHistory.Link);
280 InitializeListHead(&ShellInfoObject.SplitList.Link);
281
282 //
283 // Check PCDs for optional features that are not implemented yet.
284 //
285 if ( PcdGetBool(PcdShellSupportOldProtocols)
286 || !FeaturePcdGet(PcdShellRequireHiiPlatform)
287 || FeaturePcdGet(PcdShellSupportFrameworkHii)
288 ) {
289 return (EFI_UNSUPPORTED);
290 }
291
292 //
293 // turn off the watchdog timer
294 //
295 gBS->SetWatchdogTimer (0, 0, 0, NULL);
296
297 //
298 // install our console logger. This will keep a log of the output for back-browsing
299 //
300 Status = ConsoleLoggerInstall(ShellInfoObject.LogScreenCount, &ShellInfoObject.ConsoleInfo);
301 if (!EFI_ERROR(Status)) {
302 //
303 // Enable the cursor to be visible
304 //
305 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
306
307 //
308 // If supporting EFI 1.1 we need to install HII protocol
309 // only do this if PcdShellRequireHiiPlatform == FALSE
310 //
311 // remove EFI_UNSUPPORTED check above when complete.
312 ///@todo add support for Framework HII
313
314 //
315 // install our (solitary) HII package
316 //
317 ShellInfoObject.HiiHandle = HiiAddPackages (&gEfiCallerIdGuid, gImageHandle, ShellStrings, NULL);
318 if (ShellInfoObject.HiiHandle == NULL) {
319 if (PcdGetBool(PcdShellSupportFrameworkHii)) {
320 ///@todo Add our package into Framework HII
321 }
322 if (ShellInfoObject.HiiHandle == NULL) {
323 return (EFI_NOT_STARTED);
324 }
325 }
326
327 //
328 // create and install the EfiShellParametersProtocol
329 //
330 Status = CreatePopulateInstallShellParametersProtocol(&ShellInfoObject.NewShellParametersProtocol, &ShellInfoObject.RootShellInstance);
331 ASSERT_EFI_ERROR(Status);
332 ASSERT(ShellInfoObject.NewShellParametersProtocol != NULL);
333
334 //
335 // create and install the EfiShellProtocol
336 //
337 Status = CreatePopulateInstallShellProtocol(&ShellInfoObject.NewEfiShellProtocol);
338 ASSERT_EFI_ERROR(Status);
339 ASSERT(ShellInfoObject.NewEfiShellProtocol != NULL);
340
341 //
342 // Now initialize the shell library (it requires Shell Parameters protocol)
343 //
344 Status = ShellInitialize();
345 ASSERT_EFI_ERROR(Status);
346
347 Status = CommandInit();
348 ASSERT_EFI_ERROR(Status);
349
350 //
351 // Check the command line
352 //
353 Status = ProcessCommandLine();
354
355 //
356 // If shell support level is >= 1 create the mappings and paths
357 //
358 if (PcdGet8(PcdShellSupportLevel) >= 1) {
359 Status = ShellCommandCreateInitialMappingsAndPaths();
360 }
361
362 //
363 // save the device path for the loaded image and the device path for the filepath (under loaded image)
364 // These are where to look for the startup.nsh file
365 //
366 Status = GetDevicePathsForImageAndFile(&ShellInfoObject.ImageDevPath, &ShellInfoObject.FileDevPath);
367 ASSERT_EFI_ERROR(Status);
368
369 //
370 // Display the version
371 //
372 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoVersion) {
373 ShellPrintHiiEx (
374 0,
375 gST->ConOut->Mode->CursorRow,
376 NULL,
377 STRING_TOKEN (STR_VER_OUTPUT_MAIN_SHELL),
378 ShellInfoObject.HiiHandle,
379 SupportLevel[PcdGet8(PcdShellSupportLevel)],
380 gEfiShellProtocol->MajorVersion,
381 gEfiShellProtocol->MinorVersion
382 );
383
384 ShellPrintHiiEx (
385 -1,
386 -1,
387 NULL,
388 STRING_TOKEN (STR_VER_OUTPUT_MAIN_SUPPLIER),
389 ShellInfoObject.HiiHandle,
390 (CHAR16 *) PcdGetPtr (PcdShellSupplier)
391 );
392
393 ShellPrintHiiEx (
394 -1,
395 -1,
396 NULL,
397 STRING_TOKEN (STR_VER_OUTPUT_MAIN_UEFI),
398 ShellInfoObject.HiiHandle,
399 (gST->Hdr.Revision&0xffff0000)>>16,
400 (gST->Hdr.Revision&0x0000ffff),
401 gST->FirmwareVendor,
402 gST->FirmwareRevision
403 );
404 }
405
406 //
407 // Display the mapping
408 //
409 if (PcdGet8(PcdShellSupportLevel) >= 2 && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoMap) {
410 Status = RunCommand(L"map");
411 ASSERT_EFI_ERROR(Status);
412 }
413
414 //
415 // init all the built in alias'
416 //
417 Status = SetBuiltInAlias();
418 ASSERT_EFI_ERROR(Status);
419
420 //
421 // Initialize environment variables
422 //
423 if (ShellCommandGetProfileList() != NULL) {
424 Status = InternalEfiShellSetEnv(L"profiles", ShellCommandGetProfileList(), TRUE);
425 ASSERT_EFI_ERROR(Status);
426 }
427
428 Size = 100;
429 TempString = AllocateZeroPool(Size);
430
431 UnicodeSPrint(TempString, Size, L"%d", PcdGet8(PcdShellSupportLevel));
432 Status = InternalEfiShellSetEnv(L"uefishellsupport", TempString, TRUE);
433 ASSERT_EFI_ERROR(Status);
434
435 UnicodeSPrint(TempString, Size, L"%d.%d", ShellInfoObject.NewEfiShellProtocol->MajorVersion, ShellInfoObject.NewEfiShellProtocol->MinorVersion);
436 Status = InternalEfiShellSetEnv(L"uefishellversion", TempString, TRUE);
437 ASSERT_EFI_ERROR(Status);
438
439 UnicodeSPrint(TempString, Size, L"%d.%d", (gST->Hdr.Revision & 0xFFFF0000) >> 16, gST->Hdr.Revision & 0x0000FFFF);
440 Status = InternalEfiShellSetEnv(L"uefiversion", TempString, TRUE);
441 ASSERT_EFI_ERROR(Status);
442
443 FreePool(TempString);
444
445 if (!EFI_ERROR(Status)) {
446 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt) {
447 //
448 // Set up the event for CTRL-C monitoring...
449 //
450 Status = InernalEfiShellStartMonitor();
451 }
452
453 if (!EFI_ERROR(Status) && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
454 //
455 // Set up the event for CTRL-S monitoring...
456 //
457 Status = InternalEfiShellStartCtrlSMonitor();
458 }
459
460 if (!EFI_ERROR(Status) && ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
461 //
462 // close off the gST->ConIn
463 //
464 OldConIn = gST->ConIn;
465 ConInHandle = gST->ConsoleInHandle;
466 gST->ConIn = CreateSimpleTextInOnFile((SHELL_FILE_HANDLE)&FileInterfaceNulFile, &gST->ConsoleInHandle);
467 } else {
468 OldConIn = NULL;
469 ConInHandle = NULL;
470 }
471
472 if (!EFI_ERROR(Status) && PcdGet8(PcdShellSupportLevel) >= 1) {
473 //
474 // process the startup script or launch the called app.
475 //
476 Status = DoStartupScript(ShellInfoObject.ImageDevPath, ShellInfoObject.FileDevPath);
477 }
478
479 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.Exit && !ShellCommandGetExit() && (PcdGet8(PcdShellSupportLevel) >= 3 || PcdGetBool(PcdShellForceConsole)) && !EFI_ERROR(Status) && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
480 //
481 // begin the UI waiting loop
482 //
483 do {
484 //
485 // clean out all the memory allocated for CONST <something> * return values
486 // between each shell prompt presentation
487 //
488 if (!IsListEmpty(&ShellInfoObject.BufferToFreeList.Link)){
489 FreeBufferList(&ShellInfoObject.BufferToFreeList);
490 }
491
492 //
493 // Reset page break back to default.
494 //
495 ShellInfoObject.PageBreakEnabled = PcdGetBool(PcdShellPageBreakDefault);
496 ShellInfoObject.ConsoleInfo->Enabled = TRUE;
497 ShellInfoObject.ConsoleInfo->RowCounter = 0;
498
499 //
500 // Reset the CTRL-C event (yes we ignore the return values)
501 //
502 Status = gBS->CheckEvent (ShellInfoObject.NewEfiShellProtocol->ExecutionBreak);
503
504 //
505 // Display Prompt
506 //
507 Status = DoShellPrompt();
508 } while (!ShellCommandGetExit());
509 }
510 if (OldConIn != NULL && ConInHandle != NULL) {
511 CloseSimpleTextInOnFile (gST->ConIn);
512 gST->ConIn = OldConIn;
513 gST->ConsoleInHandle = ConInHandle;
514 }
515 }
516 }
517
518 //
519 // uninstall protocols / free memory / etc...
520 //
521 if (ShellInfoObject.UserBreakTimer != NULL) {
522 gBS->CloseEvent(ShellInfoObject.UserBreakTimer);
523 DEBUG_CODE(ShellInfoObject.UserBreakTimer = NULL;);
524 }
525 if (ShellInfoObject.ImageDevPath != NULL) {
526 FreePool(ShellInfoObject.ImageDevPath);
527 DEBUG_CODE(ShellInfoObject.ImageDevPath = NULL;);
528 }
529 if (ShellInfoObject.FileDevPath != NULL) {
530 FreePool(ShellInfoObject.FileDevPath);
531 DEBUG_CODE(ShellInfoObject.FileDevPath = NULL;);
532 }
533 if (ShellInfoObject.NewShellParametersProtocol != NULL) {
534 CleanUpShellParametersProtocol(ShellInfoObject.NewShellParametersProtocol);
535 DEBUG_CODE(ShellInfoObject.NewShellParametersProtocol = NULL;);
536 }
537 if (ShellInfoObject.NewEfiShellProtocol != NULL){
538 if (ShellInfoObject.NewEfiShellProtocol->IsRootShell()){
539 InternalEfiShellSetEnv(L"cwd", NULL, TRUE);
540 }
541 CleanUpShellProtocol(ShellInfoObject.NewEfiShellProtocol);
542 DEBUG_CODE(ShellInfoObject.NewEfiShellProtocol = NULL;);
543 }
544
545 if (!IsListEmpty(&ShellInfoObject.BufferToFreeList.Link)){
546 FreeBufferList(&ShellInfoObject.BufferToFreeList);
547 }
548
549 if (!IsListEmpty(&ShellInfoObject.SplitList.Link)){
550 ASSERT(FALSE); ///@todo finish this de-allocation.
551 }
552
553 if (ShellInfoObject.ShellInitSettings.FileName != NULL) {
554 FreePool(ShellInfoObject.ShellInitSettings.FileName);
555 DEBUG_CODE(ShellInfoObject.ShellInitSettings.FileName = NULL;);
556 }
557
558 if (ShellInfoObject.ShellInitSettings.FileOptions != NULL) {
559 FreePool(ShellInfoObject.ShellInitSettings.FileOptions);
560 DEBUG_CODE(ShellInfoObject.ShellInitSettings.FileOptions = NULL;);
561 }
562
563 if (ShellInfoObject.HiiHandle != NULL) {
564 HiiRemovePackages(ShellInfoObject.HiiHandle);
565 DEBUG_CODE(ShellInfoObject.HiiHandle = NULL;);
566 }
567
568 if (!IsListEmpty(&ShellInfoObject.ViewingSettings.CommandHistory.Link)){
569 FreeBufferList(&ShellInfoObject.ViewingSettings.CommandHistory);
570 }
571
572 ASSERT(ShellInfoObject.ConsoleInfo != NULL);
573 if (ShellInfoObject.ConsoleInfo != NULL) {
574 ConsoleLoggerUninstall(ShellInfoObject.ConsoleInfo);
575 FreePool(ShellInfoObject.ConsoleInfo);
576 DEBUG_CODE(ShellInfoObject.ConsoleInfo = NULL;);
577 }
578
579 if (ShellCommandGetExit()) {
580 return ((EFI_STATUS)ShellCommandGetExitCode());
581 }
582 return (Status);
583 }
584
585 /**
586 Sets all the alias' that were registered with the ShellCommandLib library.
587
588 @retval EFI_SUCCESS all init commands were run sucessfully.
589 **/
590 EFI_STATUS
591 EFIAPI
592 SetBuiltInAlias(
593 )
594 {
595 EFI_STATUS Status;
596 CONST ALIAS_LIST *List;
597 ALIAS_LIST *Node;
598
599 //
600 // Get all the commands we want to run
601 //
602 List = ShellCommandGetInitAliasList();
603
604 //
605 // for each command in the List
606 //
607 for ( Node = (ALIAS_LIST*)GetFirstNode(&List->Link)
608 ; !IsNull (&List->Link, &Node->Link)
609 ; Node = (ALIAS_LIST *)GetNextNode(&List->Link, &Node->Link)
610 ){
611 //
612 // install the alias'
613 //
614 Status = InternalSetAlias(Node->CommandString, Node->Alias, TRUE);
615 ASSERT_EFI_ERROR(Status);
616 }
617 return (EFI_SUCCESS);
618 }
619
620 /**
621 Internal function to determine if 2 command names are really the same.
622
623 @param[in] Command1 The pointer to the first command name.
624 @param[in] Command2 The pointer to the second command name.
625
626 @retval TRUE The 2 command names are the same.
627 @retval FALSE The 2 command names are not the same.
628 **/
629 BOOLEAN
630 EFIAPI
631 IsCommand(
632 IN CONST CHAR16 *Command1,
633 IN CONST CHAR16 *Command2
634 )
635 {
636 if (StringNoCaseCompare(&Command1, &Command2) == 0) {
637 return (TRUE);
638 }
639 return (FALSE);
640 }
641
642 /**
643 Internal function to determine if a command is a script only command.
644
645 @param[in] CommandName The pointer to the command name.
646
647 @retval TRUE The command is a script only command.
648 @retval FALSE The command is not a script only command.
649 **/
650 BOOLEAN
651 EFIAPI
652 IsScriptOnlyCommand(
653 IN CONST CHAR16 *CommandName
654 )
655 {
656 if (IsCommand(CommandName, L"for")
657 ||IsCommand(CommandName, L"endfor")
658 ||IsCommand(CommandName, L"if")
659 ||IsCommand(CommandName, L"else")
660 ||IsCommand(CommandName, L"endif")
661 ||IsCommand(CommandName, L"goto")) {
662 return (TRUE);
663 }
664 return (FALSE);
665 }
666
667 /**
668 This function will populate the 2 device path protocol parameters based on the
669 global gImageHandle. The DevPath will point to the device path for the handle that has
670 loaded image protocol installed on it. The FilePath will point to the device path
671 for the file that was loaded.
672
673 @param[in, out] DevPath On a sucessful return the device path to the loaded image.
674 @param[in, out] FilePath On a sucessful return the device path to the file.
675
676 @retval EFI_SUCCESS The 2 device paths were sucessfully returned.
677 @retval other A error from gBS->HandleProtocol.
678
679 @sa HandleProtocol
680 **/
681 EFI_STATUS
682 EFIAPI
683 GetDevicePathsForImageAndFile (
684 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,
685 IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath
686 )
687 {
688 EFI_STATUS Status;
689 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
690 EFI_DEVICE_PATH_PROTOCOL *ImageDevicePath;
691
692 ASSERT(DevPath != NULL);
693 ASSERT(FilePath != NULL);
694
695 Status = gBS->OpenProtocol (
696 gImageHandle,
697 &gEfiLoadedImageProtocolGuid,
698 (VOID**)&LoadedImage,
699 gImageHandle,
700 NULL,
701 EFI_OPEN_PROTOCOL_GET_PROTOCOL
702 );
703 if (!EFI_ERROR (Status)) {
704 Status = gBS->OpenProtocol (
705 LoadedImage->DeviceHandle,
706 &gEfiDevicePathProtocolGuid,
707 (VOID**)&ImageDevicePath,
708 gImageHandle,
709 NULL,
710 EFI_OPEN_PROTOCOL_GET_PROTOCOL
711 );
712 if (!EFI_ERROR (Status)) {
713 *DevPath = DuplicateDevicePath (ImageDevicePath);
714 *FilePath = DuplicateDevicePath (LoadedImage->FilePath);
715 gBS->CloseProtocol(
716 LoadedImage->DeviceHandle,
717 &gEfiDevicePathProtocolGuid,
718 gImageHandle,
719 NULL);
720 }
721 gBS->CloseProtocol(
722 gImageHandle,
723 &gEfiLoadedImageProtocolGuid,
724 gImageHandle,
725 NULL);
726 }
727 return (Status);
728 }
729
730 STATIC CONST SHELL_PARAM_ITEM mShellParamList[] = {
731 {L"-nostartup", TypeFlag},
732 {L"-startup", TypeFlag},
733 {L"-noconsoleout", TypeFlag},
734 {L"-noconsolein", TypeFlag},
735 {L"-nointerrupt", TypeFlag},
736 {L"-nomap", TypeFlag},
737 {L"-noversion", TypeFlag},
738 {L"-startup", TypeFlag},
739 {L"-delay", TypeValue},
740 {L"-_exit", TypeFlag},
741 {NULL, TypeMax}
742 };
743
744 /**
745 Process all Uefi Shell 2.0 command line options.
746
747 see Uefi Shell 2.0 section 3.2 for full details.
748
749 the command line must resemble the following:
750
751 shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
752
753 ShellOpt-options Options which control the initialization behavior of the shell.
754 These options are read from the EFI global variable "ShellOpt"
755 and are processed before options or file-name.
756
757 options Options which control the initialization behavior of the shell.
758
759 file-name The name of a UEFI shell application or script to be executed
760 after initialization is complete. By default, if file-name is
761 specified, then -nostartup is implied. Scripts are not supported
762 by level 0.
763
764 file-name-options The command-line options that are passed to file-name when it
765 is invoked.
766
767 This will initialize the ShellInfoObject.ShellInitSettings global variable.
768
769 @retval EFI_SUCCESS The variable is initialized.
770 **/
771 EFI_STATUS
772 EFIAPI
773 ProcessCommandLine(
774 VOID
775 )
776 {
777 EFI_STATUS Status;
778 LIST_ENTRY *Package;
779 UINTN Size;
780 CONST CHAR16 *TempConst;
781 UINTN Count;
782 UINTN LoopVar;
783 CHAR16 *ProblemParam;
784 UINT64 Intermediate;
785
786 Package = NULL;
787 ProblemParam = NULL;
788
789 Status = ShellCommandLineParse (mShellParamList, &Package, NULL, FALSE);
790
791 Count = 1;
792 Size = 0;
793 TempConst = ShellCommandLineGetRawValue(Package, Count++);
794 if (TempConst != NULL && StrLen(TempConst)) {
795 ShellInfoObject.ShellInitSettings.FileName = AllocateZeroPool(StrSize(TempConst));
796 if (ShellInfoObject.ShellInitSettings.FileName == NULL) {
797 return (EFI_OUT_OF_RESOURCES);
798 }
799 StrCpy(ShellInfoObject.ShellInitSettings.FileName, TempConst);
800 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup = 1;
801 for (LoopVar = 0 ; LoopVar < gEfiShellParametersProtocol->Argc ; LoopVar++) {
802 if (StrCmp(gEfiShellParametersProtocol->Argv[LoopVar], ShellInfoObject.ShellInitSettings.FileName)==0) {
803 LoopVar++;
804 //
805 // We found the file... add the rest of the params...
806 //
807 for ( ; LoopVar < gEfiShellParametersProtocol->Argc ; LoopVar++) {
808 ASSERT((ShellInfoObject.ShellInitSettings.FileOptions == NULL && Size == 0) || (ShellInfoObject.ShellInitSettings.FileOptions != NULL));
809 StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,
810 &Size,
811 L" ",
812 0);
813 if (ShellInfoObject.ShellInitSettings.FileOptions == NULL) {
814 SHELL_FREE_NON_NULL(ShellInfoObject.ShellInitSettings.FileName);
815 return (EFI_OUT_OF_RESOURCES);
816 }
817 StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,
818 &Size,
819 gEfiShellParametersProtocol->Argv[LoopVar],
820 0);
821 if (ShellInfoObject.ShellInitSettings.FileOptions == NULL) {
822 SHELL_FREE_NON_NULL(ShellInfoObject.ShellInitSettings.FileName);
823 return (EFI_OUT_OF_RESOURCES);
824 }
825 }
826 }
827 }
828 } else {
829 ShellCommandLineFreeVarList(Package);
830 Package = NULL;
831 Status = ShellCommandLineParse (mShellParamList, &Package, &ProblemParam, FALSE);
832 if (EFI_ERROR(Status)) {
833 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), ShellInfoObject.HiiHandle, ProblemParam);
834 FreePool(ProblemParam);
835 ShellCommandLineFreeVarList(Package);
836 return (EFI_INVALID_PARAMETER);
837 }
838 }
839
840 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup = ShellCommandLineGetFlag(Package, L"-startup");
841 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup = ShellCommandLineGetFlag(Package, L"-nostartup");
842 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleOut = ShellCommandLineGetFlag(Package, L"-noconsoleout");
843 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn = ShellCommandLineGetFlag(Package, L"-noconsolein");
844 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt = ShellCommandLineGetFlag(Package, L"-nointerrupt");
845 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoMap = ShellCommandLineGetFlag(Package, L"-nomap");
846 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoVersion = ShellCommandLineGetFlag(Package, L"-noversion");
847 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Delay = ShellCommandLineGetFlag(Package, L"-delay");
848 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Exit = ShellCommandLineGetFlag(Package, L"-_exit");
849
850 ShellInfoObject.ShellInitSettings.Delay = 5;
851
852 if (ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt) {
853 ShellInfoObject.ShellInitSettings.Delay = 0;
854 } else if (ShellInfoObject.ShellInitSettings.BitUnion.Bits.Delay) {
855 TempConst = ShellCommandLineGetValue(Package, L"-delay");
856 if (TempConst != NULL && *TempConst == L':') {
857 TempConst++;
858 }
859 if (TempConst != NULL && !EFI_ERROR(ShellConvertStringToUint64(TempConst, &Intermediate, FALSE, FALSE))) {
860 ShellInfoObject.ShellInitSettings.Delay = (UINTN)Intermediate;
861 }
862 }
863 ShellCommandLineFreeVarList(Package);
864
865 return (Status);
866 }
867
868 /**
869 Handles all interaction with the default startup script.
870
871 this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
872
873 @param ImagePath the path to the image for shell. first place to look for the startup script
874 @param FilePath the path to the file for shell. second place to look for the startup script.
875
876 @retval EFI_SUCCESS the variable is initialized.
877 **/
878 EFI_STATUS
879 EFIAPI
880 DoStartupScript(
881 EFI_DEVICE_PATH_PROTOCOL *ImagePath,
882 EFI_DEVICE_PATH_PROTOCOL *FilePath
883 )
884 {
885 EFI_STATUS Status;
886 UINTN Delay;
887 EFI_INPUT_KEY Key;
888 SHELL_FILE_HANDLE FileHandle;
889 EFI_DEVICE_PATH_PROTOCOL *NewPath;
890 EFI_DEVICE_PATH_PROTOCOL *NamePath;
891 CHAR16 *FileStringPath;
892 CHAR16 *TempSpot;
893 UINTN NewSize;
894 CONST CHAR16 *MapName;
895
896 Key.UnicodeChar = CHAR_NULL;
897 Key.ScanCode = 0;
898 FileHandle = NULL;
899
900 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup && ShellInfoObject.ShellInitSettings.FileName != NULL) {
901 //
902 // launch something else instead
903 //
904 NewSize = StrSize(ShellInfoObject.ShellInitSettings.FileName);
905 if (ShellInfoObject.ShellInitSettings.FileOptions != NULL) {
906 NewSize += StrSize(ShellInfoObject.ShellInitSettings.FileOptions) + sizeof(CHAR16);
907 }
908 FileStringPath = AllocateZeroPool(NewSize);
909 if (FileStringPath == NULL) {
910 return (EFI_OUT_OF_RESOURCES);
911 }
912 StrCpy(FileStringPath, ShellInfoObject.ShellInitSettings.FileName);
913 if (ShellInfoObject.ShellInitSettings.FileOptions != NULL) {
914 StrCat(FileStringPath, L" ");
915 StrCat(FileStringPath, ShellInfoObject.ShellInitSettings.FileOptions);
916 }
917 Status = RunCommand(FileStringPath);
918 FreePool(FileStringPath);
919 return (Status);
920
921 }
922
923 //
924 // for shell level 0 we do no scripts
925 // Without the Startup bit overriding we allow for nostartup to prevent scripts
926 //
927 if ( (PcdGet8(PcdShellSupportLevel) < 1)
928 || (ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup)
929 ){
930 return (EFI_SUCCESS);
931 }
932
933 gST->ConOut->EnableCursor(gST->ConOut, FALSE);
934 //
935 // print out our warning and see if they press a key
936 //
937 for ( Status = EFI_UNSUPPORTED, Delay = ShellInfoObject.ShellInitSettings.Delay
938 ; Delay != 0 && EFI_ERROR(Status)
939 ; Delay--
940 ){
941 ShellPrintHiiEx(0, gST->ConOut->Mode->CursorRow, NULL, STRING_TOKEN (STR_SHELL_STARTUP_QUESTION), ShellInfoObject.HiiHandle, Delay);
942 gBS->Stall (1000000);
943 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
944 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
945 }
946 }
947 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_CRLF), ShellInfoObject.HiiHandle);
948 gST->ConOut->EnableCursor(gST->ConOut, TRUE);
949
950 //
951 // ESC was pressed
952 //
953 if (Status == EFI_SUCCESS && Key.UnicodeChar == 0 && Key.ScanCode == SCAN_ESC) {
954 return (EFI_SUCCESS);
955 }
956
957 //
958 // Try the first location (must be file system)
959 //
960 MapName = ShellInfoObject.NewEfiShellProtocol->GetMapFromDevicePath(&ImagePath);
961 if (MapName != NULL) {
962 FileStringPath = NULL;
963 NewSize = 0;
964 FileStringPath = StrnCatGrow(&FileStringPath, &NewSize, MapName, 0);
965 if (FileStringPath == NULL) {
966 Status = EFI_OUT_OF_RESOURCES;
967 } else {
968 TempSpot = StrStr(FileStringPath, L";");
969 if (TempSpot != NULL) {
970 *TempSpot = CHAR_NULL;
971 }
972 FileStringPath = StrnCatGrow(&FileStringPath, &NewSize, ((FILEPATH_DEVICE_PATH*)FilePath)->PathName, 0);
973 PathRemoveLastItem(FileStringPath);
974 FileStringPath = StrnCatGrow(&FileStringPath, &NewSize, mStartupScript, 0);
975 Status = ShellInfoObject.NewEfiShellProtocol->OpenFileByName(FileStringPath, &FileHandle, EFI_FILE_MODE_READ);
976 FreePool(FileStringPath);
977 }
978 }
979 if (EFI_ERROR(Status)) {
980 NamePath = FileDevicePath (NULL, mStartupScript);
981 NewPath = AppendDevicePathNode (ImagePath, NamePath);
982 FreePool(NamePath);
983
984 //
985 // Try the location
986 //
987 Status = InternalOpenFileDevicePath(NewPath, &FileHandle, EFI_FILE_MODE_READ, 0);
988 FreePool(NewPath);
989 }
990 //
991 // If we got a file, run it
992 //
993 if (!EFI_ERROR(Status) && FileHandle != NULL) {
994 Status = RunScriptFileHandle (FileHandle, mStartupScript);
995 ShellInfoObject.NewEfiShellProtocol->CloseFile(FileHandle);
996 } else {
997 FileStringPath = ShellFindFilePath(mStartupScript);
998 if (FileStringPath == NULL) {
999 //
1000 // we return success since we dont need to have a startup script
1001 //
1002 Status = EFI_SUCCESS;
1003 ASSERT(FileHandle == NULL);
1004 } else {
1005 Status = RunScriptFile(FileStringPath);
1006 FreePool(FileStringPath);
1007 }
1008 }
1009
1010
1011 return (Status);
1012 }
1013
1014 /**
1015 Function to perform the shell prompt looping. It will do a single prompt,
1016 dispatch the result, and then return. It is expected that the caller will
1017 call this function in a loop many times.
1018
1019 @retval EFI_SUCCESS
1020 @retval RETURN_ABORTED
1021 **/
1022 EFI_STATUS
1023 EFIAPI
1024 DoShellPrompt (
1025 VOID
1026 )
1027 {
1028 UINTN Column;
1029 UINTN Row;
1030 CHAR16 *CmdLine;
1031 CONST CHAR16 *CurDir;
1032 UINTN BufferSize;
1033 EFI_STATUS Status;
1034
1035 CurDir = NULL;
1036
1037 //
1038 // Get screen setting to decide size of the command line buffer
1039 //
1040 gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Column, &Row);
1041 BufferSize = Column * Row * sizeof (CHAR16);
1042 CmdLine = AllocateZeroPool (BufferSize);
1043 if (CmdLine == NULL) {
1044 return EFI_OUT_OF_RESOURCES;
1045 }
1046
1047 CurDir = ShellInfoObject.NewEfiShellProtocol->GetEnv(L"cwd");
1048
1049 //
1050 // Prompt for input
1051 //
1052 gST->ConOut->SetCursorPosition (gST->ConOut, 0, gST->ConOut->Mode->CursorRow);
1053
1054 if (CurDir != NULL && StrLen(CurDir) > 1) {
1055 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_CURDIR), ShellInfoObject.HiiHandle, CurDir);
1056 } else {
1057 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_SHELL), ShellInfoObject.HiiHandle);
1058 }
1059
1060 //
1061 // Read a line from the console
1062 //
1063 Status = ShellInfoObject.NewEfiShellProtocol->ReadFile(ShellInfoObject.NewShellParametersProtocol->StdIn, &BufferSize, CmdLine);
1064
1065 //
1066 // Null terminate the string and parse it
1067 //
1068 if (!EFI_ERROR (Status)) {
1069 CmdLine[BufferSize / sizeof (CHAR16)] = CHAR_NULL;
1070 Status = RunCommand(CmdLine);
1071 }
1072
1073 //
1074 // Done with this command
1075 //
1076 FreePool (CmdLine);
1077 return Status;
1078 }
1079
1080 /**
1081 Add a buffer to the Buffer To Free List for safely returning buffers to other
1082 places without risking letting them modify internal shell information.
1083
1084 @param Buffer Something to pass to FreePool when the shell is exiting.
1085 **/
1086 VOID*
1087 EFIAPI
1088 AddBufferToFreeList(
1089 VOID *Buffer
1090 )
1091 {
1092 BUFFER_LIST *BufferListEntry;
1093
1094 if (Buffer == NULL) {
1095 return (NULL);
1096 }
1097
1098 BufferListEntry = AllocateZeroPool(sizeof(BUFFER_LIST));
1099 ASSERT(BufferListEntry != NULL);
1100 BufferListEntry->Buffer = Buffer;
1101 InsertTailList(&ShellInfoObject.BufferToFreeList.Link, &BufferListEntry->Link);
1102 return (Buffer);
1103 }
1104
1105 /**
1106 Add a buffer to the Line History List
1107
1108 @param Buffer The line buffer to add.
1109 **/
1110 VOID
1111 EFIAPI
1112 AddLineToCommandHistory(
1113 IN CONST CHAR16 *Buffer
1114 )
1115 {
1116 BUFFER_LIST *Node;
1117
1118 Node = AllocateZeroPool(sizeof(BUFFER_LIST));
1119 ASSERT(Node != NULL);
1120 Node->Buffer = AllocateZeroPool(StrSize(Buffer));
1121 ASSERT(Node->Buffer != NULL);
1122 StrCpy(Node->Buffer, Buffer);
1123
1124 InsertTailList(&ShellInfoObject.ViewingSettings.CommandHistory.Link, &Node->Link);
1125 }
1126
1127 /**
1128 Checks if a string is an alias for another command. If yes, then it replaces the alias name
1129 with the correct command name.
1130
1131 @param[in, out] CommandString Upon entry the potential alias. Upon return the
1132 command name if it was an alias. If it was not
1133 an alias it will be unchanged. This function may
1134 change the buffer to fit the command name.
1135
1136 @retval EFI_SUCCESS The name was changed.
1137 @retval EFI_SUCCESS The name was not an alias.
1138 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1139 **/
1140 EFI_STATUS
1141 EFIAPI
1142 ShellConvertAlias(
1143 IN OUT CHAR16 **CommandString
1144 )
1145 {
1146 CONST CHAR16 *NewString;
1147
1148 NewString = ShellInfoObject.NewEfiShellProtocol->GetAlias(*CommandString, NULL);
1149 if (NewString == NULL) {
1150 return (EFI_SUCCESS);
1151 }
1152 FreePool(*CommandString);
1153 *CommandString = AllocateZeroPool(StrSize(NewString));
1154 if (*CommandString == NULL) {
1155 return (EFI_OUT_OF_RESOURCES);
1156 }
1157 StrCpy(*CommandString, NewString);
1158 return (EFI_SUCCESS);
1159 }
1160
1161 /**
1162 Function allocates a new command line and replaces all instances of environment
1163 variable names that are correctly preset to their values.
1164
1165 If the return value is not NULL the memory must be caller freed.
1166
1167 @param[in] OriginalCommandLine The original command line
1168
1169 @retval NULL An error ocurred.
1170 @return The new command line with no environment variables present.
1171 **/
1172 CHAR16*
1173 EFIAPI
1174 ShellConvertVariables (
1175 IN CONST CHAR16 *OriginalCommandLine
1176 )
1177 {
1178 CONST CHAR16 *MasterEnvList;
1179 UINTN NewSize;
1180 CHAR16 *NewCommandLine1;
1181 CHAR16 *NewCommandLine2;
1182 CHAR16 *Temp;
1183 CHAR16 *Temp2;
1184 UINTN ItemSize;
1185 CHAR16 *ItemTemp;
1186 SCRIPT_FILE *CurrentScriptFile;
1187 ALIAS_LIST *AliasListNode;
1188
1189 ASSERT(OriginalCommandLine != NULL);
1190
1191 ItemSize = 0;
1192 NewSize = StrSize(OriginalCommandLine);
1193 CurrentScriptFile = ShellCommandGetCurrentScriptFile();
1194 Temp = NULL;
1195
1196 ///@todo update this to handle the %0 - %9 for scripting only (borrow from line 1256 area) ? ? ?
1197
1198 //
1199 // calculate the size required for the post-conversion string...
1200 //
1201 if (CurrentScriptFile != NULL) {
1202 for (AliasListNode = (ALIAS_LIST*)GetFirstNode(&CurrentScriptFile->SubstList)
1203 ; !IsNull(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1204 ; AliasListNode = (ALIAS_LIST*)GetNextNode(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1205 ){
1206 for (Temp = StrStr(OriginalCommandLine, AliasListNode->Alias)
1207 ; Temp != NULL
1208 ; Temp = StrStr(Temp+1, AliasListNode->Alias)
1209 ){
1210 //
1211 // we need a preceeding and if there is space no ^ preceeding (if no space ignore)
1212 //
1213 if ((((Temp-OriginalCommandLine)>2) && *(Temp-2) != L'^') || ((Temp-OriginalCommandLine)<=2)) {
1214 NewSize += StrSize(AliasListNode->CommandString);
1215 }
1216 }
1217 }
1218 }
1219
1220 for (MasterEnvList = EfiShellGetEnv(NULL)
1221 ; MasterEnvList != NULL && *MasterEnvList != CHAR_NULL //&& *(MasterEnvList+1) != CHAR_NULL
1222 ; MasterEnvList += StrLen(MasterEnvList) + 1
1223 ){
1224 if (StrSize(MasterEnvList) > ItemSize) {
1225 ItemSize = StrSize(MasterEnvList);
1226 }
1227 for (Temp = StrStr(OriginalCommandLine, MasterEnvList)
1228 ; Temp != NULL
1229 ; Temp = StrStr(Temp+1, MasterEnvList)
1230 ){
1231 //
1232 // we need a preceeding and following % and if there is space no ^ preceeding (if no space ignore)
1233 //
1234 if (*(Temp-1) == L'%' && *(Temp+StrLen(MasterEnvList)) == L'%' &&
1235 ((((Temp-OriginalCommandLine)>2) && *(Temp-2) != L'^') || ((Temp-OriginalCommandLine)<=2))) {
1236 NewSize+=StrSize(EfiShellGetEnv(MasterEnvList));
1237 }
1238 }
1239 }
1240
1241 //
1242 // now do the replacements...
1243 //
1244 NewCommandLine1 = AllocateZeroPool(NewSize);
1245 NewCommandLine2 = AllocateZeroPool(NewSize);
1246 ItemTemp = AllocateZeroPool(ItemSize+(2*sizeof(CHAR16)));
1247 if (NewCommandLine1 == NULL || NewCommandLine2 == NULL || ItemTemp == NULL) {
1248 SHELL_FREE_NON_NULL(NewCommandLine1);
1249 SHELL_FREE_NON_NULL(NewCommandLine2);
1250 SHELL_FREE_NON_NULL(ItemTemp);
1251 return (NULL);
1252 }
1253 StrCpy(NewCommandLine1, OriginalCommandLine);
1254 for (MasterEnvList = EfiShellGetEnv(NULL)
1255 ; MasterEnvList != NULL && *MasterEnvList != CHAR_NULL //&& *(MasterEnvList+1) != CHAR_NULL
1256 ; MasterEnvList += StrLen(MasterEnvList) + 1
1257 ){
1258 StrCpy(ItemTemp, L"%");
1259 StrCat(ItemTemp, MasterEnvList);
1260 StrCat(ItemTemp, L"%");
1261 ShellCopySearchAndReplace(NewCommandLine1, NewCommandLine2, NewSize, ItemTemp, EfiShellGetEnv(MasterEnvList), TRUE, FALSE);
1262 StrCpy(NewCommandLine1, NewCommandLine2);
1263 }
1264 if (CurrentScriptFile != NULL) {
1265 for (AliasListNode = (ALIAS_LIST*)GetFirstNode(&CurrentScriptFile->SubstList)
1266 ; !IsNull(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1267 ; AliasListNode = (ALIAS_LIST*)GetNextNode(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1268 ){
1269 ShellCopySearchAndReplace(NewCommandLine1, NewCommandLine2, NewSize, AliasListNode->Alias, AliasListNode->CommandString, TRUE, FALSE);
1270 StrCpy(NewCommandLine1, NewCommandLine2);
1271 }
1272
1273 //
1274 // Remove non-existant environment variables in scripts only
1275 //
1276 for (Temp = NewCommandLine1 ; Temp != NULL ; ) {
1277 Temp = StrStr(Temp, L"%");
1278 if (Temp == NULL) {
1279 break;
1280 }
1281 while (*(Temp - 1) == L'^') {
1282 Temp = StrStr(Temp + 1, L"%");
1283 if (Temp == NULL) {
1284 break;
1285 }
1286 }
1287 if (Temp == NULL) {
1288 break;
1289 }
1290
1291 Temp2 = StrStr(Temp + 1, L"%");
1292 if (Temp2 == NULL) {
1293 break;
1294 }
1295 while (*(Temp2 - 1) == L'^') {
1296 Temp2 = StrStr(Temp2 + 1, L"%");
1297 if (Temp2 == NULL) {
1298 break;
1299 }
1300 }
1301 if (Temp2 == NULL) {
1302 break;
1303 }
1304
1305 Temp2++;
1306 CopyMem(Temp, Temp2, StrSize(Temp2));
1307 }
1308
1309 }
1310
1311 //
1312 // Now cleanup any straggler intentionally ignored "%" characters
1313 //
1314 ShellCopySearchAndReplace(NewCommandLine1, NewCommandLine2, NewSize, L"^%", L"%", TRUE, FALSE);
1315 StrCpy(NewCommandLine1, NewCommandLine2);
1316
1317 FreePool(NewCommandLine2);
1318 FreePool(ItemTemp);
1319
1320 return (NewCommandLine1);
1321 }
1322
1323 /**
1324 Internal function to run a command line with pipe usage.
1325
1326 @param[in] CmdLine The pointer to the command line.
1327 @param[in] StdIn The pointer to the Standard input.
1328 @param[in] StdOut The pointer to the Standard output.
1329
1330 @retval EFI_SUCCESS The split command is executed successfully.
1331 @retval other Some error occurs when executing the split command.
1332 **/
1333 EFI_STATUS
1334 EFIAPI
1335 RunSplitCommand(
1336 IN CONST CHAR16 *CmdLine,
1337 IN SHELL_FILE_HANDLE *StdIn,
1338 IN SHELL_FILE_HANDLE *StdOut
1339 )
1340 {
1341 EFI_STATUS Status;
1342 CHAR16 *NextCommandLine;
1343 CHAR16 *OurCommandLine;
1344 UINTN Size1;
1345 UINTN Size2;
1346 SPLIT_LIST *Split;
1347 SHELL_FILE_HANDLE *TempFileHandle;
1348 BOOLEAN Unicode;
1349
1350 ASSERT(StdOut == NULL);
1351
1352 ASSERT(StrStr(CmdLine, L"|") != NULL);
1353
1354 Status = EFI_SUCCESS;
1355 NextCommandLine = NULL;
1356 OurCommandLine = NULL;
1357 Size1 = 0;
1358 Size2 = 0;
1359
1360 NextCommandLine = StrnCatGrow(&NextCommandLine, &Size1, StrStr(CmdLine, L"|")+1, 0);
1361 OurCommandLine = StrnCatGrow(&OurCommandLine , &Size2, CmdLine , StrStr(CmdLine, L"|") - CmdLine);
1362
1363 if (NextCommandLine == NULL || OurCommandLine == NULL) {
1364 SHELL_FREE_NON_NULL(OurCommandLine);
1365 SHELL_FREE_NON_NULL(NextCommandLine);
1366 return (EFI_OUT_OF_RESOURCES);
1367 } else if (StrStr(OurCommandLine, L"|") != NULL || Size1 == 0 || Size2 == 0) {
1368 SHELL_FREE_NON_NULL(OurCommandLine);
1369 SHELL_FREE_NON_NULL(NextCommandLine);
1370 return (EFI_INVALID_PARAMETER);
1371 } else if (NextCommandLine[0] != CHAR_NULL &&
1372 NextCommandLine[0] == L'a' &&
1373 NextCommandLine[1] == L' '
1374 ){
1375 CopyMem(NextCommandLine, NextCommandLine+1, StrSize(NextCommandLine) - sizeof(NextCommandLine[0]));
1376 Unicode = FALSE;
1377 } else {
1378 Unicode = TRUE;
1379 }
1380
1381
1382 //
1383 // make a SPLIT_LIST item and add to list
1384 //
1385 Split = AllocateZeroPool(sizeof(SPLIT_LIST));
1386 ASSERT(Split != NULL);
1387 Split->SplitStdIn = StdIn;
1388 Split->SplitStdOut = ConvertEfiFileProtocolToShellHandle(CreateFileInterfaceMem(Unicode), NULL);
1389 ASSERT(Split->SplitStdOut != NULL);
1390 InsertHeadList(&ShellInfoObject.SplitList.Link, &Split->Link);
1391
1392 Status = RunCommand(OurCommandLine);
1393
1394 //
1395 // move the output from the first to the in to the second.
1396 //
1397 TempFileHandle = Split->SplitStdOut;
1398 if (Split->SplitStdIn == StdIn) {
1399 Split->SplitStdOut = NULL;
1400 } else {
1401 Split->SplitStdOut = Split->SplitStdIn;
1402 }
1403 Split->SplitStdIn = TempFileHandle;
1404 ShellInfoObject.NewEfiShellProtocol->SetFilePosition(ConvertShellHandleToEfiFileProtocol(Split->SplitStdIn), 0);
1405
1406 if (!EFI_ERROR(Status)) {
1407 Status = RunCommand(NextCommandLine);
1408 }
1409
1410 //
1411 // remove the top level from the ScriptList
1412 //
1413 ASSERT((SPLIT_LIST*)GetFirstNode(&ShellInfoObject.SplitList.Link) == Split);
1414 RemoveEntryList(&Split->Link);
1415
1416 //
1417 // Note that the original StdIn is now the StdOut...
1418 //
1419 if (Split->SplitStdOut != NULL && Split->SplitStdOut != StdIn) {
1420 ShellInfoObject.NewEfiShellProtocol->CloseFile(ConvertShellHandleToEfiFileProtocol(Split->SplitStdOut));
1421 }
1422 if (Split->SplitStdIn != NULL) {
1423 ShellInfoObject.NewEfiShellProtocol->CloseFile(ConvertShellHandleToEfiFileProtocol(Split->SplitStdIn));
1424 }
1425
1426 FreePool(Split);
1427 FreePool(NextCommandLine);
1428 FreePool(OurCommandLine);
1429
1430 return (Status);
1431 }
1432
1433 /**
1434 Take the original command line, substitute any alias in the first group of space delimited characters, free
1435 the original string, return the modified copy
1436
1437 @param[in] CmdLine pointer to the command line to update
1438 @param[out]CmdName upon successful return the name of the command to be run
1439
1440 @retval EFI_SUCCESS the function was successful
1441 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
1442 **/
1443 EFI_STATUS
1444 EFIAPI
1445 ShellSubstituteAliases(
1446 IN CHAR16 **CmdLine
1447 )
1448 {
1449 CHAR16 *NewCmdLine;
1450 CHAR16 *CommandName;
1451 EFI_STATUS Status;
1452 UINTN PostAliasSize;
1453 ASSERT(CmdLine != NULL);
1454 ASSERT(*CmdLine!= NULL);
1455
1456
1457 CommandName = NULL;
1458 if (StrStr((*CmdLine), L" ") == NULL){
1459 StrnCatGrow(&CommandName, NULL, (*CmdLine), 0);
1460 } else {
1461 StrnCatGrow(&CommandName, NULL, (*CmdLine), StrStr((*CmdLine), L" ") - (*CmdLine));
1462 }
1463
1464 //
1465 // This cannot happen 'inline' since the CmdLine can need extra space.
1466 //
1467 NewCmdLine = NULL;
1468 if (!ShellCommandIsCommandOnList(CommandName)) {
1469 //
1470 // Convert via alias
1471 //
1472 Status = ShellConvertAlias(&CommandName);
1473 if (EFI_ERROR(Status)){
1474 return (Status);
1475 }
1476 PostAliasSize = 0;
1477 NewCmdLine = StrnCatGrow(&NewCmdLine, &PostAliasSize, CommandName, 0);
1478 if (NewCmdLine == NULL) {
1479 SHELL_FREE_NON_NULL(CommandName);
1480 SHELL_FREE_NON_NULL(*CmdLine);
1481 return (EFI_OUT_OF_RESOURCES);
1482 }
1483 NewCmdLine = StrnCatGrow(&NewCmdLine, &PostAliasSize, StrStr((*CmdLine), L" "), 0);
1484 if (NewCmdLine == NULL) {
1485 SHELL_FREE_NON_NULL(CommandName);
1486 SHELL_FREE_NON_NULL(*CmdLine);
1487 return (EFI_OUT_OF_RESOURCES);
1488 }
1489 } else {
1490 NewCmdLine = StrnCatGrow(&NewCmdLine, NULL, (*CmdLine), 0);
1491 }
1492
1493 SHELL_FREE_NON_NULL(*CmdLine);
1494 SHELL_FREE_NON_NULL(CommandName);
1495
1496 //
1497 // re-assign the passed in double pointer to point to our newly allocated buffer
1498 //
1499 *CmdLine = NewCmdLine;
1500
1501 return (EFI_SUCCESS);
1502 }
1503
1504 /**
1505 Function will process and run a command line.
1506
1507 This will determine if the command line represents an internal shell
1508 command or dispatch an external application.
1509
1510 @param[in] CmdLine The command line to parse.
1511
1512 @retval EFI_SUCCESS The command was completed.
1513 @retval EFI_ABORTED The command's operation was aborted.
1514 **/
1515 EFI_STATUS
1516 EFIAPI
1517 RunCommand(
1518 IN CONST CHAR16 *CmdLine
1519 )
1520 {
1521 EFI_STATUS Status;
1522 EFI_STATUS StatusCode;
1523 CHAR16 *CommandName;
1524 SHELL_STATUS ShellStatus;
1525 UINTN Argc;
1526 CHAR16 **Argv;
1527 BOOLEAN LastError;
1528 CHAR16 LeString[19];
1529 CHAR16 *PostVariableCmdLine;
1530 CHAR16 *CommandWithPath;
1531 CONST EFI_DEVICE_PATH_PROTOCOL *DevPath;
1532 CONST CHAR16 *TempLocation;
1533 CONST CHAR16 *TempLocation2;
1534 SHELL_FILE_HANDLE OriginalStdIn;
1535 SHELL_FILE_HANDLE OriginalStdOut;
1536 SHELL_FILE_HANDLE OriginalStdErr;
1537 SYSTEM_TABLE_INFO OriginalSystemTableInfo;
1538 UINTN Count;
1539 UINTN Count2;
1540 CHAR16 *CleanOriginal;
1541 SPLIT_LIST *Split;
1542
1543 ASSERT(CmdLine != NULL);
1544 if (StrLen(CmdLine) == 0) {
1545 return (EFI_SUCCESS);
1546 }
1547
1548 CommandName = NULL;
1549 PostVariableCmdLine = NULL;
1550 CommandWithPath = NULL;
1551 DevPath = NULL;
1552 Status = EFI_SUCCESS;
1553 CleanOriginal = NULL;
1554 Split = NULL;
1555
1556 CleanOriginal = StrnCatGrow(&CleanOriginal, NULL, CmdLine, 0);
1557 if (CleanOriginal == NULL) {
1558 return (EFI_OUT_OF_RESOURCES);
1559 }
1560
1561 TrimSpaces(&CleanOriginal);
1562
1563 //
1564 // Handle case that passed in command line is just 1 or more " " characters.
1565 //
1566 if (StrLen (CleanOriginal) == 0) {
1567 if (CleanOriginal != NULL) {
1568 FreePool(CleanOriginal);
1569 CleanOriginal = NULL;
1570 }
1571 return (EFI_SUCCESS);
1572 }
1573
1574 Status = ShellSubstituteAliases(&CleanOriginal);
1575 if (EFI_ERROR(Status)) {
1576 return (Status);
1577 }
1578
1579 PostVariableCmdLine = ShellConvertVariables(CleanOriginal);
1580
1581 if (PostVariableCmdLine == NULL) {
1582 return (EFI_OUT_OF_RESOURCES);
1583 }
1584
1585 TrimSpaces(&PostVariableCmdLine);
1586
1587 //
1588 // We dont do normal processing with a split command line (output from one command input to another)
1589 //
1590 if (ContainsSplit(PostVariableCmdLine)) {
1591 //
1592 // are we in an existing split???
1593 //
1594 if (!IsListEmpty(&ShellInfoObject.SplitList.Link)) {
1595 Split = (SPLIT_LIST*)GetFirstNode(&ShellInfoObject.SplitList.Link);
1596 }
1597
1598 if (Split == NULL) {
1599 Status = RunSplitCommand(PostVariableCmdLine, NULL, NULL);
1600 } else {
1601 Status = RunSplitCommand(PostVariableCmdLine, Split->SplitStdIn, Split->SplitStdOut);
1602 }
1603 if (EFI_ERROR(Status)) {
1604 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_INVALID_SPLIT), ShellInfoObject.HiiHandle, PostVariableCmdLine);
1605 }
1606 } else {
1607
1608 //
1609 // If this is a mapped drive change handle that...
1610 //
1611 if (PostVariableCmdLine[(StrLen(PostVariableCmdLine)-1)] == L':' && StrStr(PostVariableCmdLine, L" ") == NULL) {
1612 Status = ShellInfoObject.NewEfiShellProtocol->SetCurDir(NULL, PostVariableCmdLine);
1613 if (EFI_ERROR(Status)) {
1614 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_INVALID_MAPPING), ShellInfoObject.HiiHandle, PostVariableCmdLine);
1615 }
1616 FreePool(PostVariableCmdLine);
1617 return (Status);
1618 }
1619
1620 ///@todo update this section to divide into 3 ways - run internal command, run split (above), and run an external file...
1621 /// We waste a lot of time doing processing like StdIn,StdOut,Argv,Argc for things that are external files...
1622
1623
1624
1625 Status = UpdateStdInStdOutStdErr(ShellInfoObject.NewShellParametersProtocol, PostVariableCmdLine, &OriginalStdIn, &OriginalStdOut, &OriginalStdErr, &OriginalSystemTableInfo);
1626 if (EFI_ERROR(Status)) {
1627 if (Status == EFI_NOT_FOUND) {
1628 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_REDUNDA_REDIR), ShellInfoObject.HiiHandle);
1629 } else {
1630 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_INVALID_REDIR), ShellInfoObject.HiiHandle);
1631 }
1632 } else {
1633 TrimSpaces(&PostVariableCmdLine);
1634
1635 //
1636 // get the argc and argv updated for internal commands
1637 //
1638 Status = UpdateArgcArgv(ShellInfoObject.NewShellParametersProtocol, PostVariableCmdLine, &Argv, &Argc);
1639 ASSERT_EFI_ERROR(Status);
1640
1641 for (Count = 0 ; Count < ShellInfoObject.NewShellParametersProtocol->Argc ; Count++) {
1642 if (StrStr(ShellInfoObject.NewShellParametersProtocol->Argv[Count], L"-?") == ShellInfoObject.NewShellParametersProtocol->Argv[Count]
1643 || (ShellInfoObject.NewShellParametersProtocol->Argv[0][0] == L'?' && ShellInfoObject.NewShellParametersProtocol->Argv[0][1] == CHAR_NULL)
1644 ) {
1645 //
1646 // We need to redo the arguments since a parameter was -?
1647 // move them all down 1 to the end, then up one then replace the first with help
1648 //
1649 FreePool(ShellInfoObject.NewShellParametersProtocol->Argv[Count]);
1650 ShellInfoObject.NewShellParametersProtocol->Argv[Count] = NULL;
1651 for (Count2 = Count ; (Count2 + 1) < ShellInfoObject.NewShellParametersProtocol->Argc ; Count2++) {
1652 ShellInfoObject.NewShellParametersProtocol->Argv[Count2] = ShellInfoObject.NewShellParametersProtocol->Argv[Count2+1];
1653 }
1654 ShellInfoObject.NewShellParametersProtocol->Argv[Count2] = NULL;
1655 for (Count2 = ShellInfoObject.NewShellParametersProtocol->Argc -1 ; Count2 > 0 ; Count2--) {
1656 ShellInfoObject.NewShellParametersProtocol->Argv[Count2] = ShellInfoObject.NewShellParametersProtocol->Argv[Count2-1];
1657 }
1658 ShellInfoObject.NewShellParametersProtocol->Argv[0] = NULL;
1659 ShellInfoObject.NewShellParametersProtocol->Argv[0] = StrnCatGrow(&ShellInfoObject.NewShellParametersProtocol->Argv[0], NULL, L"help", 0);
1660 break;
1661 }
1662 }
1663
1664 //
1665 // command or file?
1666 //
1667 if (ShellCommandIsCommandOnList(ShellInfoObject.NewShellParametersProtocol->Argv[0])) {
1668 //
1669 // Run the command (which was converted if it was an alias)
1670 //
1671 if (!EFI_ERROR(Status)) {
1672 Status = ShellCommandRunCommandHandler(ShellInfoObject.NewShellParametersProtocol->Argv[0], &ShellStatus, &LastError);
1673 ASSERT_EFI_ERROR(Status);
1674
1675 if (sizeof(EFI_STATUS) == sizeof(UINT64)) {
1676 UnicodeSPrint(LeString, sizeof(LeString), L"0x%Lx", ShellStatus);
1677 } else {
1678 UnicodeSPrint(LeString, sizeof(LeString), L"0x%x", ShellStatus);
1679 }
1680 DEBUG_CODE(InternalEfiShellSetEnv(L"debuglasterror", LeString, TRUE););
1681 if (LastError) {
1682 InternalEfiShellSetEnv(L"lasterror", LeString, TRUE);
1683 }
1684 //
1685 // Pass thru the exitcode from the app.
1686 //
1687 if (ShellCommandGetExit()) {
1688 Status = ShellStatus;
1689 } else if (ShellStatus != 0 && IsScriptOnlyCommand(ShellInfoObject.NewShellParametersProtocol->Argv[0])) {
1690 Status = EFI_ABORTED;
1691 }
1692 }
1693 } else {
1694 //
1695 // run an external file (or script)
1696 //
1697 if (StrStr(ShellInfoObject.NewShellParametersProtocol->Argv[0], L":") != NULL) {
1698 ASSERT (CommandWithPath == NULL);
1699 if (ShellIsFile(ShellInfoObject.NewShellParametersProtocol->Argv[0]) == EFI_SUCCESS) {
1700 CommandWithPath = StrnCatGrow(&CommandWithPath, NULL, ShellInfoObject.NewShellParametersProtocol->Argv[0], 0);
1701 }
1702 }
1703 if (CommandWithPath == NULL) {
1704 CommandWithPath = ShellFindFilePathEx(ShellInfoObject.NewShellParametersProtocol->Argv[0], mExecutableExtensions);
1705 }
1706 if (CommandWithPath == NULL || ShellIsDirectory(CommandWithPath) == EFI_SUCCESS) {
1707 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_NOT_FOUND), ShellInfoObject.HiiHandle, ShellInfoObject.NewShellParametersProtocol->Argv[0]);
1708
1709 if (sizeof(EFI_STATUS) == sizeof(UINT64)) {
1710 UnicodeSPrint(LeString, sizeof(LeString), L"0x%Lx", EFI_NOT_FOUND);
1711 } else {
1712 UnicodeSPrint(LeString, sizeof(LeString), L"0x%x", EFI_NOT_FOUND);
1713 }
1714 DEBUG_CODE(InternalEfiShellSetEnv(L"debuglasterror", LeString, TRUE););
1715 InternalEfiShellSetEnv(L"lasterror", LeString, TRUE);
1716 } else {
1717 //
1718 // Check if it's a NSH (script) file.
1719 //
1720 TempLocation = CommandWithPath+StrLen(CommandWithPath)-4;
1721 TempLocation2 = mScriptExtension;
1722 if ((StrLen(CommandWithPath) > 4) && (StringNoCaseCompare((VOID*)(&TempLocation), (VOID*)(&TempLocation2)) == 0)) {
1723 Status = RunScriptFile (CommandWithPath);
1724 } else {
1725 DevPath = ShellInfoObject.NewEfiShellProtocol->GetDevicePathFromFilePath(CommandWithPath);
1726 ASSERT(DevPath != NULL);
1727 Status = InternalShellExecuteDevicePath(
1728 &gImageHandle,
1729 DevPath,
1730 PostVariableCmdLine,
1731 NULL,
1732 &StatusCode
1733 );
1734
1735 //
1736 // Update last error status.
1737 //
1738 if (sizeof(EFI_STATUS) == sizeof(UINT64)) {
1739 UnicodeSPrint(LeString, sizeof(LeString), L"0x%Lx", StatusCode);
1740 } else {
1741 UnicodeSPrint(LeString, sizeof(LeString), L"0x%x", StatusCode);
1742 }
1743 DEBUG_CODE(InternalEfiShellSetEnv(L"debuglasterror", LeString, TRUE););
1744 InternalEfiShellSetEnv(L"lasterror", LeString, TRUE);
1745 }
1746 }
1747 }
1748
1749 //
1750 // Print some error info.
1751 //
1752 if (EFI_ERROR(Status)) {
1753 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_ERROR), ShellInfoObject.HiiHandle, (VOID*)(Status));
1754 }
1755
1756 CommandName = StrnCatGrow(&CommandName, NULL, ShellInfoObject.NewShellParametersProtocol->Argv[0], 0);
1757
1758 RestoreArgcArgv(ShellInfoObject.NewShellParametersProtocol, &Argv, &Argc);
1759
1760 RestoreStdInStdOutStdErr(ShellInfoObject.NewShellParametersProtocol, &OriginalStdIn, &OriginalStdOut, &OriginalStdErr, &OriginalSystemTableInfo);
1761 }
1762 if (CommandName != NULL) {
1763 if (ShellCommandGetCurrentScriptFile() != NULL && !IsScriptOnlyCommand(CommandName)) {
1764 //
1765 // if this is NOT a scipt only command return success so the script won't quit.
1766 // prevent killing the script - this is the only place where we know the actual command name (after alias and variable replacement...)
1767 //
1768 Status = EFI_SUCCESS;
1769 }
1770 }
1771 }
1772
1773 SHELL_FREE_NON_NULL(CommandName);
1774 SHELL_FREE_NON_NULL(CommandWithPath);
1775 SHELL_FREE_NON_NULL(PostVariableCmdLine);
1776 SHELL_FREE_NON_NULL(CleanOriginal);
1777
1778 return (Status);
1779 }
1780
1781 STATIC CONST UINT16 InvalidChars[] = {L'*', L'?', L'<', L'>', L'\\', L'/', L'\"', 0x0001, 0x0002};
1782 /**
1783 Function determins if the CommandName COULD be a valid command. It does not determine whether
1784 this is a valid command. It only checks for invalid characters.
1785
1786 @param[in] CommandName The name to check
1787
1788 @retval TRUE CommandName could be a command name
1789 @retval FALSE CommandName could not be a valid command name
1790 **/
1791 BOOLEAN
1792 EFIAPI
1793 IsValidCommandName(
1794 IN CONST CHAR16 *CommandName
1795 )
1796 {
1797 UINTN Count;
1798 if (CommandName == NULL) {
1799 ASSERT(FALSE);
1800 return (FALSE);
1801 }
1802 for ( Count = 0
1803 ; Count < sizeof(InvalidChars) / sizeof(InvalidChars[0])
1804 ; Count++
1805 ){
1806 if (ScanMem16(CommandName, StrSize(CommandName), InvalidChars[Count]) != NULL) {
1807 return (FALSE);
1808 }
1809 }
1810 return (TRUE);
1811 }
1812
1813 /**
1814 Function to process a NSH script file via SHELL_FILE_HANDLE.
1815
1816 @param[in] Handle The handle to the already opened file.
1817 @param[in] Name The name of the script file.
1818
1819 @retval EFI_SUCCESS the script completed sucessfully
1820 **/
1821 EFI_STATUS
1822 EFIAPI
1823 RunScriptFileHandle (
1824 IN SHELL_FILE_HANDLE Handle,
1825 IN CONST CHAR16 *Name
1826 )
1827 {
1828 EFI_STATUS Status;
1829 SCRIPT_FILE *NewScriptFile;
1830 UINTN LoopVar;
1831 CHAR16 *CommandLine;
1832 CHAR16 *CommandLine2;
1833 CHAR16 *CommandLine3;
1834 SCRIPT_COMMAND_LIST *LastCommand;
1835 BOOLEAN Ascii;
1836 BOOLEAN PreScriptEchoState;
1837 BOOLEAN PreCommandEchoState;
1838 CONST CHAR16 *CurDir;
1839 UINTN LineCount;
1840 CHAR16 LeString[50];
1841
1842 ASSERT(!ShellCommandGetScriptExit());
1843
1844 PreScriptEchoState = ShellCommandGetEchoState();
1845
1846 NewScriptFile = (SCRIPT_FILE*)AllocateZeroPool(sizeof(SCRIPT_FILE));
1847 if (NewScriptFile == NULL) {
1848 return (EFI_OUT_OF_RESOURCES);
1849 }
1850
1851 //
1852 // Set up the name
1853 //
1854 ASSERT(NewScriptFile->ScriptName == NULL);
1855 NewScriptFile->ScriptName = StrnCatGrow(&NewScriptFile->ScriptName, NULL, Name, 0);
1856 if (NewScriptFile->ScriptName == NULL) {
1857 DeleteScriptFileStruct(NewScriptFile);
1858 return (EFI_OUT_OF_RESOURCES);
1859 }
1860
1861 //
1862 // Save the parameters (used to replace %0 to %9 later on)
1863 //
1864 NewScriptFile->Argc = ShellInfoObject.NewShellParametersProtocol->Argc;
1865 if (NewScriptFile->Argc != 0) {
1866 NewScriptFile->Argv = (CHAR16**)AllocateZeroPool(NewScriptFile->Argc * sizeof(CHAR16*));
1867 if (NewScriptFile->Argv == NULL) {
1868 DeleteScriptFileStruct(NewScriptFile);
1869 return (EFI_OUT_OF_RESOURCES);
1870 }
1871 for (LoopVar = 0 ; LoopVar < 10 && LoopVar < NewScriptFile->Argc; LoopVar++) {
1872 ASSERT(NewScriptFile->Argv[LoopVar] == NULL);
1873 NewScriptFile->Argv[LoopVar] = StrnCatGrow(&NewScriptFile->Argv[LoopVar], NULL, ShellInfoObject.NewShellParametersProtocol->Argv[LoopVar], 0);
1874 if (NewScriptFile->Argv[LoopVar] == NULL) {
1875 DeleteScriptFileStruct(NewScriptFile);
1876 return (EFI_OUT_OF_RESOURCES);
1877 }
1878 }
1879 } else {
1880 NewScriptFile->Argv = NULL;
1881 }
1882
1883 InitializeListHead(&NewScriptFile->CommandList);
1884 InitializeListHead(&NewScriptFile->SubstList);
1885
1886 //
1887 // Now build the list of all script commands.
1888 //
1889 LineCount = 0;
1890 while(!ShellFileHandleEof(Handle)) {
1891 CommandLine = ShellFileHandleReturnLine(Handle, &Ascii);
1892 LineCount++;
1893 if (CommandLine == NULL || StrLen(CommandLine) == 0) {
1894 continue;
1895 }
1896 NewScriptFile->CurrentCommand = AllocateZeroPool(sizeof(SCRIPT_COMMAND_LIST));
1897 if (NewScriptFile->CurrentCommand == NULL) {
1898 DeleteScriptFileStruct(NewScriptFile);
1899 return (EFI_OUT_OF_RESOURCES);
1900 }
1901
1902 NewScriptFile->CurrentCommand->Cl = CommandLine;
1903 NewScriptFile->CurrentCommand->Data = NULL;
1904 NewScriptFile->CurrentCommand->Line = LineCount;
1905
1906 InsertTailList(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link);
1907 }
1908
1909 //
1910 // Add this as the topmost script file
1911 //
1912 ShellCommandSetNewScript (NewScriptFile);
1913
1914 //
1915 // Now enumerate through the commands and run each one.
1916 //
1917 CommandLine = AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize));
1918 if (CommandLine == NULL) {
1919 DeleteScriptFileStruct(NewScriptFile);
1920 return (EFI_OUT_OF_RESOURCES);
1921 }
1922 CommandLine2 = AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize));
1923 if (CommandLine2 == NULL) {
1924 FreePool(CommandLine);
1925 DeleteScriptFileStruct(NewScriptFile);
1926 return (EFI_OUT_OF_RESOURCES);
1927 }
1928
1929 for ( NewScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)GetFirstNode(&NewScriptFile->CommandList)
1930 ; !IsNull(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link)
1931 ; // conditional increment in the body of the loop
1932 ){
1933 ASSERT(CommandLine2 != NULL);
1934 StrCpy(CommandLine2, NewScriptFile->CurrentCommand->Cl);
1935
1936 //
1937 // NULL out comments
1938 //
1939 for (CommandLine3 = CommandLine2 ; CommandLine3 != NULL && *CommandLine3 != CHAR_NULL ; CommandLine3++) {
1940 if (*CommandLine3 == L'^') {
1941 if (*(CommandLine3+1) == L'#' || *(CommandLine3+1) == L':') {
1942 CopyMem(CommandLine3, CommandLine3+1, StrSize(CommandLine3) - sizeof(CommandLine3[0]));
1943 }
1944 } else if (*CommandLine3 == L'#') {
1945 *CommandLine3 = CHAR_NULL;
1946 }
1947 }
1948
1949 if (CommandLine2 != NULL && StrLen(CommandLine2) >= 1) {
1950 //
1951 // Due to variability in starting the find and replace action we need to have both buffers the same.
1952 //
1953 StrCpy(CommandLine, CommandLine2);
1954
1955 //
1956 // Remove the %0 to %9 from the command line (if we have some arguments)
1957 //
1958 if (NewScriptFile->Argv != NULL) {
1959 switch (NewScriptFile->Argc) {
1960 default:
1961 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%9", NewScriptFile->Argv[9], FALSE, TRUE);
1962 ASSERT_EFI_ERROR(Status);
1963 case 9:
1964 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%8", NewScriptFile->Argv[8], FALSE, TRUE);
1965 ASSERT_EFI_ERROR(Status);
1966 case 8:
1967 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%7", NewScriptFile->Argv[7], FALSE, TRUE);
1968 ASSERT_EFI_ERROR(Status);
1969 case 7:
1970 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%6", NewScriptFile->Argv[6], FALSE, TRUE);
1971 ASSERT_EFI_ERROR(Status);
1972 case 6:
1973 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%5", NewScriptFile->Argv[5], FALSE, TRUE);
1974 ASSERT_EFI_ERROR(Status);
1975 case 5:
1976 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%4", NewScriptFile->Argv[4], FALSE, TRUE);
1977 ASSERT_EFI_ERROR(Status);
1978 case 4:
1979 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%3", NewScriptFile->Argv[3], FALSE, TRUE);
1980 ASSERT_EFI_ERROR(Status);
1981 case 3:
1982 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%2", NewScriptFile->Argv[2], FALSE, TRUE);
1983 ASSERT_EFI_ERROR(Status);
1984 case 2:
1985 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%1", NewScriptFile->Argv[1], FALSE, TRUE);
1986 ASSERT_EFI_ERROR(Status);
1987 case 1:
1988 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%0", NewScriptFile->Argv[0], FALSE, TRUE);
1989 ASSERT_EFI_ERROR(Status);
1990 break;
1991 case 0:
1992 break;
1993 }
1994 }
1995 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%1", L"\"\"", FALSE, FALSE);
1996 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%2", L"\"\"", FALSE, FALSE);
1997 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%3", L"\"\"", FALSE, FALSE);
1998 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%4", L"\"\"", FALSE, FALSE);
1999 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%5", L"\"\"", FALSE, FALSE);
2000 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%6", L"\"\"", FALSE, FALSE);
2001 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%7", L"\"\"", FALSE, FALSE);
2002 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%8", L"\"\"", FALSE, FALSE);
2003 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%9", L"\"\"", FALSE, FALSE);
2004
2005 StrCpy(CommandLine2, CommandLine);
2006
2007 LastCommand = NewScriptFile->CurrentCommand;
2008
2009 for (CommandLine3 = CommandLine2 ; CommandLine3[0] == L' ' ; CommandLine3++);
2010
2011 if (CommandLine3 != NULL && CommandLine3[0] == L':' ) {
2012 //
2013 // This line is a goto target / label
2014 //
2015 } else {
2016 if (CommandLine3 != NULL && StrLen(CommandLine3) > 0) {
2017 if (CommandLine3[0] == L'@') {
2018 //
2019 // We need to save the current echo state
2020 // and disable echo for just this command.
2021 //
2022 PreCommandEchoState = ShellCommandGetEchoState();
2023 ShellCommandSetEchoState(FALSE);
2024 Status = RunCommand(CommandLine3+1);
2025
2026 //
2027 // If command was "@echo -off" or "@echo -on" then don't restore echo state
2028 //
2029 if (StrCmp (L"@echo -off", CommandLine3) != 0 &&
2030 StrCmp (L"@echo -on", CommandLine3) != 0) {
2031 //
2032 // Now restore the pre-'@' echo state.
2033 //
2034 ShellCommandSetEchoState(PreCommandEchoState);
2035 }
2036 } else {
2037 if (ShellCommandGetEchoState()) {
2038 CurDir = ShellInfoObject.NewEfiShellProtocol->GetEnv(L"cwd");
2039 if (CurDir != NULL && StrLen(CurDir) > 1) {
2040 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_CURDIR), ShellInfoObject.HiiHandle, CurDir);
2041 } else {
2042 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_SHELL), ShellInfoObject.HiiHandle);
2043 }
2044 ShellPrintEx(-1, -1, L"%s\r\n", CommandLine2);
2045 }
2046 Status = RunCommand(CommandLine3);
2047 }
2048 }
2049
2050 if (ShellCommandGetScriptExit()) {
2051 //
2052 // ShellCommandGetExitCode() always returns a UINT64
2053 //
2054 UnicodeSPrint(LeString, sizeof(LeString), L"0x%Lx", ShellCommandGetExitCode());
2055 DEBUG_CODE(InternalEfiShellSetEnv(L"debuglasterror", LeString, TRUE););
2056 InternalEfiShellSetEnv(L"lasterror", LeString, TRUE);
2057
2058 ShellCommandRegisterExit(FALSE, 0);
2059 Status = EFI_SUCCESS;
2060 break;
2061 }
2062 if (ShellGetExecutionBreakFlag()) {
2063 break;
2064 }
2065 if (EFI_ERROR(Status)) {
2066 break;
2067 }
2068 if (ShellCommandGetExit()) {
2069 break;
2070 }
2071 }
2072 //
2073 // If that commend did not update the CurrentCommand then we need to advance it...
2074 //
2075 if (LastCommand == NewScriptFile->CurrentCommand) {
2076 NewScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)GetNextNode(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link);
2077 if (!IsNull(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link)) {
2078 NewScriptFile->CurrentCommand->Reset = TRUE;
2079 }
2080 }
2081 } else {
2082 NewScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)GetNextNode(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link);
2083 if (!IsNull(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link)) {
2084 NewScriptFile->CurrentCommand->Reset = TRUE;
2085 }
2086 }
2087 }
2088
2089
2090 FreePool(CommandLine);
2091 FreePool(CommandLine2);
2092 ShellCommandSetNewScript (NULL);
2093
2094 //
2095 // Only if this was the last script reset the state.
2096 //
2097 if (ShellCommandGetCurrentScriptFile()==NULL) {
2098 ShellCommandSetEchoState(PreScriptEchoState);
2099 }
2100 return (EFI_SUCCESS);
2101 }
2102
2103 /**
2104 Function to process a NSH script file.
2105
2106 @param[in] ScriptPath Pointer to the script file name (including file system path).
2107
2108 @retval EFI_SUCCESS the script completed sucessfully
2109 **/
2110 EFI_STATUS
2111 EFIAPI
2112 RunScriptFile (
2113 IN CONST CHAR16 *ScriptPath
2114 )
2115 {
2116 EFI_STATUS Status;
2117 SHELL_FILE_HANDLE FileHandle;
2118
2119 if (ShellIsFile(ScriptPath) != EFI_SUCCESS) {
2120 return (EFI_INVALID_PARAMETER);
2121 }
2122
2123 Status = ShellOpenFileByName(ScriptPath, &FileHandle, EFI_FILE_MODE_READ, 0);
2124 if (EFI_ERROR(Status)) {
2125 return (Status);
2126 }
2127
2128 Status = RunScriptFileHandle(FileHandle, ScriptPath);
2129
2130 ShellCloseFile(&FileHandle);
2131
2132 return (Status);
2133 }
EFI Development Kit II mirror for PVE