]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Application/Shell/Shell.c
a570b7b1254cc32eb2c67d407eb0fb2c06053505
[mirror_edk2.git] / ShellPkg / Application / Shell / Shell.c
1 /** @file
2 This is THE shell (application)
3
4 Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2013-2014, 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 and tabs at the end of the (*String).
95 //
96 while ((StrLen (*String) > 0) && (((*String)[StrLen((*String))-1] == L' ') || ((*String)[StrLen((*String))-1] == L'\t'))) {
97 (*String)[StrLen((*String))-1] = CHAR_NULL;
98 }
99
100 return (EFI_SUCCESS);
101 }
102
103 /**
104 Parse for the next instance of one string within another string. Can optionally make sure that
105 the string was not escaped (^ character) per the shell specification.
106
107 @param[in] SourceString The string to search within
108 @param[in] FindString The string to look for
109 @param[in] CheckForEscapeCharacter TRUE to skip escaped instances of FinfString, otherwise will return even escaped instances
110 **/
111 CHAR16*
112 EFIAPI
113 FindNextInstance(
114 IN CONST CHAR16 *SourceString,
115 IN CONST CHAR16 *FindString,
116 IN CONST BOOLEAN CheckForEscapeCharacter
117 )
118 {
119 CHAR16 *Temp;
120 if (SourceString == NULL) {
121 return (NULL);
122 }
123 Temp = StrStr(SourceString, FindString);
124
125 //
126 // If nothing found, or we dont care about escape characters
127 //
128 if (Temp == NULL || !CheckForEscapeCharacter) {
129 return (Temp);
130 }
131
132 //
133 // If we found an escaped character, try again on the remainder of the string
134 //
135 if ((Temp > (SourceString)) && *(Temp-1) == L'^') {
136 return FindNextInstance(Temp+1, FindString, CheckForEscapeCharacter);
137 }
138
139 //
140 // we found the right character
141 //
142 return (Temp);
143 }
144
145 /**
146 Check whether the string between a pair of % is a valid envifronment variable name.
147
148 @param[in] BeginPercent pointer to the first percent.
149 @param[in] EndPercent pointer to the last percent.
150
151 @retval TRUE is a valid environment variable name.
152 @retval FALSE is NOT a valid environment variable name.
153 **/
154 BOOLEAN
155 IsValidEnvironmentVariableName(
156 IN CONST CHAR16 *BeginPercent,
157 IN CONST CHAR16 *EndPercent
158 )
159 {
160 CONST CHAR16 *Walker;
161
162 Walker = NULL;
163
164 ASSERT (BeginPercent != NULL);
165 ASSERT (EndPercent != NULL);
166 ASSERT (BeginPercent < EndPercent);
167
168 if ((BeginPercent + 1) == EndPercent) {
169 return FALSE;
170 }
171
172 for (Walker = BeginPercent + 1; Walker < EndPercent; Walker++) {
173 if (
174 (*Walker >= L'0' && *Walker <= L'9') ||
175 (*Walker >= L'A' && *Walker <= L'Z') ||
176 (*Walker >= L'a' && *Walker <= L'z') ||
177 (*Walker == L'_')
178 ) {
179 if (Walker == BeginPercent + 1 && (*Walker >= L'0' && *Walker <= L'9')) {
180 return FALSE;
181 } else {
182 continue;
183 }
184 } else {
185 return FALSE;
186 }
187 }
188
189 return TRUE;
190 }
191
192 /**
193 Find a command line contains a split operation
194
195 @param[in] CmdLine The command line to parse.
196
197 @retval A pointer to the | character in CmdLine or NULL if not present.
198 **/
199 CONST CHAR16*
200 EFIAPI
201 FindSplit(
202 IN CONST CHAR16 *CmdLine
203 )
204 {
205 CONST CHAR16 *TempSpot;
206 TempSpot = NULL;
207 if (StrStr(CmdLine, L"|") != NULL) {
208 for (TempSpot = CmdLine ; TempSpot != NULL && *TempSpot != CHAR_NULL ; TempSpot++) {
209 if (*TempSpot == L'^' && *(TempSpot+1) == L'|') {
210 TempSpot++;
211 } else if (*TempSpot == L'|') {
212 break;
213 }
214 }
215 }
216 return (TempSpot);
217 }
218
219 /**
220 Determine if a command line contains a split operation
221
222 @param[in] CmdLine The command line to parse.
223
224 @retval TRUE CmdLine has a valid split.
225 @retval FALSE CmdLine does not have a valid split.
226 **/
227 BOOLEAN
228 EFIAPI
229 ContainsSplit(
230 IN CONST CHAR16 *CmdLine
231 )
232 {
233 CONST CHAR16 *TempSpot;
234 CONST CHAR16 *FirstQuote;
235 CONST CHAR16 *SecondQuote;
236
237 FirstQuote = FindNextInstance (CmdLine, L"\"", TRUE);
238 SecondQuote = NULL;
239 TempSpot = FindSplit(CmdLine);
240
241 if (FirstQuote == NULL ||
242 TempSpot == NULL ||
243 TempSpot == CHAR_NULL ||
244 FirstQuote > TempSpot
245 ) {
246 return (BOOLEAN) ((TempSpot != NULL) && (*TempSpot != CHAR_NULL));
247 }
248
249 while ((TempSpot != NULL) && (*TempSpot != CHAR_NULL)) {
250 if (FirstQuote == NULL || FirstQuote > TempSpot) {
251 break;
252 }
253 SecondQuote = FindNextInstance (FirstQuote + 1, L"\"", TRUE);
254 if (SecondQuote == NULL) {
255 break;
256 }
257 if (SecondQuote < TempSpot) {
258 FirstQuote = FindNextInstance (SecondQuote + 1, L"\"", TRUE);
259 continue;
260 } else {
261 FirstQuote = FindNextInstance (SecondQuote + 1, L"\"", TRUE);
262 TempSpot = FindSplit(TempSpot + 1);
263 continue;
264 }
265 }
266
267 return (BOOLEAN) ((TempSpot != NULL) && (*TempSpot != CHAR_NULL));
268 }
269
270 /**
271 Function to start monitoring for CTRL-S using SimpleTextInputEx. This
272 feature's enabled state was not known when the shell initially launched.
273
274 @retval EFI_SUCCESS The feature is enabled.
275 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
276 **/
277 EFI_STATUS
278 EFIAPI
279 InternalEfiShellStartCtrlSMonitor(
280 VOID
281 )
282 {
283 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *SimpleEx;
284 EFI_KEY_DATA KeyData;
285 EFI_STATUS Status;
286
287 Status = gBS->OpenProtocol(
288 gST->ConsoleInHandle,
289 &gEfiSimpleTextInputExProtocolGuid,
290 (VOID**)&SimpleEx,
291 gImageHandle,
292 NULL,
293 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
294 if (EFI_ERROR(Status)) {
295 ShellPrintHiiEx(
296 -1,
297 -1,
298 NULL,
299 STRING_TOKEN (STR_SHELL_NO_IN_EX),
300 ShellInfoObject.HiiHandle);
301 return (EFI_SUCCESS);
302 }
303
304 KeyData.KeyState.KeyToggleState = 0;
305 KeyData.Key.ScanCode = 0;
306 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;
307 KeyData.Key.UnicodeChar = L's';
308
309 Status = SimpleEx->RegisterKeyNotify(
310 SimpleEx,
311 &KeyData,
312 NotificationFunction,
313 &ShellInfoObject.CtrlSNotifyHandle1);
314
315 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;
316 if (!EFI_ERROR(Status)) {
317 Status = SimpleEx->RegisterKeyNotify(
318 SimpleEx,
319 &KeyData,
320 NotificationFunction,
321 &ShellInfoObject.CtrlSNotifyHandle2);
322 }
323 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;
324 KeyData.Key.UnicodeChar = 19;
325
326 if (!EFI_ERROR(Status)) {
327 Status = SimpleEx->RegisterKeyNotify(
328 SimpleEx,
329 &KeyData,
330 NotificationFunction,
331 &ShellInfoObject.CtrlSNotifyHandle3);
332 }
333 KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;
334 if (!EFI_ERROR(Status)) {
335 Status = SimpleEx->RegisterKeyNotify(
336 SimpleEx,
337 &KeyData,
338 NotificationFunction,
339 &ShellInfoObject.CtrlSNotifyHandle4);
340 }
341 return (Status);
342 }
343
344
345
346 /**
347 The entry point for the application.
348
349 @param[in] ImageHandle The firmware allocated handle for the EFI image.
350 @param[in] SystemTable A pointer to the EFI System Table.
351
352 @retval EFI_SUCCESS The entry point is executed successfully.
353 @retval other Some error occurs when executing this entry point.
354
355 **/
356 EFI_STATUS
357 EFIAPI
358 UefiMain (
359 IN EFI_HANDLE ImageHandle,
360 IN EFI_SYSTEM_TABLE *SystemTable
361 )
362 {
363 EFI_STATUS Status;
364 CHAR16 *TempString;
365 UINTN Size;
366 EFI_HANDLE ConInHandle;
367 EFI_SIMPLE_TEXT_INPUT_PROTOCOL *OldConIn;
368
369 if (PcdGet8(PcdShellSupportLevel) > 3) {
370 return (EFI_UNSUPPORTED);
371 }
372
373 //
374 // Clear the screen
375 //
376 Status = gST->ConOut->ClearScreen(gST->ConOut);
377 if (EFI_ERROR(Status)) {
378 return (Status);
379 }
380
381 //
382 // Populate the global structure from PCDs
383 //
384 ShellInfoObject.ImageDevPath = NULL;
385 ShellInfoObject.FileDevPath = NULL;
386 ShellInfoObject.PageBreakEnabled = PcdGetBool(PcdShellPageBreakDefault);
387 ShellInfoObject.ViewingSettings.InsertMode = PcdGetBool(PcdShellInsertModeDefault);
388 ShellInfoObject.LogScreenCount = PcdGet8 (PcdShellScreenLogCount );
389
390 //
391 // verify we dont allow for spec violation
392 //
393 ASSERT(ShellInfoObject.LogScreenCount >= 3);
394
395 //
396 // Initialize the LIST ENTRY objects...
397 //
398 InitializeListHead(&ShellInfoObject.BufferToFreeList.Link);
399 InitializeListHead(&ShellInfoObject.ViewingSettings.CommandHistory.Link);
400 InitializeListHead(&ShellInfoObject.SplitList.Link);
401
402 //
403 // Check PCDs for optional features that are not implemented yet.
404 //
405 if ( PcdGetBool(PcdShellSupportOldProtocols)
406 || !FeaturePcdGet(PcdShellRequireHiiPlatform)
407 || FeaturePcdGet(PcdShellSupportFrameworkHii)
408 ) {
409 return (EFI_UNSUPPORTED);
410 }
411
412 //
413 // turn off the watchdog timer
414 //
415 gBS->SetWatchdogTimer (0, 0, 0, NULL);
416
417 //
418 // install our console logger. This will keep a log of the output for back-browsing
419 //
420 Status = ConsoleLoggerInstall(ShellInfoObject.LogScreenCount, &ShellInfoObject.ConsoleInfo);
421 if (!EFI_ERROR(Status)) {
422 //
423 // Enable the cursor to be visible
424 //
425 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
426
427 //
428 // If supporting EFI 1.1 we need to install HII protocol
429 // only do this if PcdShellRequireHiiPlatform == FALSE
430 //
431 // remove EFI_UNSUPPORTED check above when complete.
432 ///@todo add support for Framework HII
433
434 //
435 // install our (solitary) HII package
436 //
437 ShellInfoObject.HiiHandle = HiiAddPackages (&gEfiCallerIdGuid, gImageHandle, ShellStrings, NULL);
438 if (ShellInfoObject.HiiHandle == NULL) {
439 if (PcdGetBool(PcdShellSupportFrameworkHii)) {
440 ///@todo Add our package into Framework HII
441 }
442 if (ShellInfoObject.HiiHandle == NULL) {
443 Status = EFI_NOT_STARTED;
444 goto FreeResources;
445 }
446 }
447
448 //
449 // create and install the EfiShellParametersProtocol
450 //
451 Status = CreatePopulateInstallShellParametersProtocol(&ShellInfoObject.NewShellParametersProtocol, &ShellInfoObject.RootShellInstance);
452 ASSERT_EFI_ERROR(Status);
453 ASSERT(ShellInfoObject.NewShellParametersProtocol != NULL);
454
455 //
456 // create and install the EfiShellProtocol
457 //
458 Status = CreatePopulateInstallShellProtocol(&ShellInfoObject.NewEfiShellProtocol);
459 ASSERT_EFI_ERROR(Status);
460 ASSERT(ShellInfoObject.NewEfiShellProtocol != NULL);
461
462 //
463 // Now initialize the shell library (it requires Shell Parameters protocol)
464 //
465 Status = ShellInitialize();
466 ASSERT_EFI_ERROR(Status);
467
468 Status = CommandInit();
469 ASSERT_EFI_ERROR(Status);
470
471 //
472 // Check the command line
473 //
474 Status = ProcessCommandLine ();
475 if (EFI_ERROR (Status)) {
476 goto FreeResources;
477 }
478
479 //
480 // If shell support level is >= 1 create the mappings and paths
481 //
482 if (PcdGet8(PcdShellSupportLevel) >= 1) {
483 Status = ShellCommandCreateInitialMappingsAndPaths();
484 }
485
486 //
487 // save the device path for the loaded image and the device path for the filepath (under loaded image)
488 // These are where to look for the startup.nsh file
489 //
490 Status = GetDevicePathsForImageAndFile(&ShellInfoObject.ImageDevPath, &ShellInfoObject.FileDevPath);
491 ASSERT_EFI_ERROR(Status);
492
493 //
494 // Display the version
495 //
496 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoVersion) {
497 ShellPrintHiiEx (
498 0,
499 gST->ConOut->Mode->CursorRow,
500 NULL,
501 STRING_TOKEN (STR_VER_OUTPUT_MAIN_SHELL),
502 ShellInfoObject.HiiHandle,
503 SupportLevel[PcdGet8(PcdShellSupportLevel)],
504 gEfiShellProtocol->MajorVersion,
505 gEfiShellProtocol->MinorVersion
506 );
507
508 ShellPrintHiiEx (
509 -1,
510 -1,
511 NULL,
512 STRING_TOKEN (STR_VER_OUTPUT_MAIN_SUPPLIER),
513 ShellInfoObject.HiiHandle,
514 (CHAR16 *) PcdGetPtr (PcdShellSupplier)
515 );
516
517 ShellPrintHiiEx (
518 -1,
519 -1,
520 NULL,
521 STRING_TOKEN (STR_VER_OUTPUT_MAIN_UEFI),
522 ShellInfoObject.HiiHandle,
523 (gST->Hdr.Revision&0xffff0000)>>16,
524 (gST->Hdr.Revision&0x0000ffff),
525 gST->FirmwareVendor,
526 gST->FirmwareRevision
527 );
528 }
529
530 //
531 // Display the mapping
532 //
533 if (PcdGet8(PcdShellSupportLevel) >= 2 && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoMap) {
534 Status = RunCommand(L"map");
535 ASSERT_EFI_ERROR(Status);
536 }
537
538 //
539 // init all the built in alias'
540 //
541 Status = SetBuiltInAlias();
542 ASSERT_EFI_ERROR(Status);
543
544 //
545 // Initialize environment variables
546 //
547 if (ShellCommandGetProfileList() != NULL) {
548 Status = InternalEfiShellSetEnv(L"profiles", ShellCommandGetProfileList(), TRUE);
549 ASSERT_EFI_ERROR(Status);
550 }
551
552 Size = 100;
553 TempString = AllocateZeroPool(Size);
554
555 UnicodeSPrint(TempString, Size, L"%d", PcdGet8(PcdShellSupportLevel));
556 Status = InternalEfiShellSetEnv(L"uefishellsupport", TempString, TRUE);
557 ASSERT_EFI_ERROR(Status);
558
559 UnicodeSPrint(TempString, Size, L"%d.%d", ShellInfoObject.NewEfiShellProtocol->MajorVersion, ShellInfoObject.NewEfiShellProtocol->MinorVersion);
560 Status = InternalEfiShellSetEnv(L"uefishellversion", TempString, TRUE);
561 ASSERT_EFI_ERROR(Status);
562
563 UnicodeSPrint(TempString, Size, L"%d.%d", (gST->Hdr.Revision & 0xFFFF0000) >> 16, gST->Hdr.Revision & 0x0000FFFF);
564 Status = InternalEfiShellSetEnv(L"uefiversion", TempString, TRUE);
565 ASSERT_EFI_ERROR(Status);
566
567 FreePool(TempString);
568
569 if (!EFI_ERROR(Status)) {
570 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt) {
571 //
572 // Set up the event for CTRL-C monitoring...
573 //
574 Status = InernalEfiShellStartMonitor();
575 }
576
577 if (!EFI_ERROR(Status) && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
578 //
579 // Set up the event for CTRL-S monitoring...
580 //
581 Status = InternalEfiShellStartCtrlSMonitor();
582 }
583
584 if (!EFI_ERROR(Status) && ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
585 //
586 // close off the gST->ConIn
587 //
588 OldConIn = gST->ConIn;
589 ConInHandle = gST->ConsoleInHandle;
590 gST->ConIn = CreateSimpleTextInOnFile((SHELL_FILE_HANDLE)&FileInterfaceNulFile, &gST->ConsoleInHandle);
591 } else {
592 OldConIn = NULL;
593 ConInHandle = NULL;
594 }
595
596 if (!EFI_ERROR(Status) && PcdGet8(PcdShellSupportLevel) >= 1) {
597 //
598 // process the startup script or launch the called app.
599 //
600 Status = DoStartupScript(ShellInfoObject.ImageDevPath, ShellInfoObject.FileDevPath);
601 }
602
603 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.Exit && !ShellCommandGetExit() && (PcdGet8(PcdShellSupportLevel) >= 3 || PcdGetBool(PcdShellForceConsole)) && !EFI_ERROR(Status) && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
604 //
605 // begin the UI waiting loop
606 //
607 do {
608 //
609 // clean out all the memory allocated for CONST <something> * return values
610 // between each shell prompt presentation
611 //
612 if (!IsListEmpty(&ShellInfoObject.BufferToFreeList.Link)){
613 FreeBufferList(&ShellInfoObject.BufferToFreeList);
614 }
615
616 //
617 // Reset page break back to default.
618 //
619 ShellInfoObject.PageBreakEnabled = PcdGetBool(PcdShellPageBreakDefault);
620 ASSERT (ShellInfoObject.ConsoleInfo != NULL);
621 ShellInfoObject.ConsoleInfo->Enabled = TRUE;
622 ShellInfoObject.ConsoleInfo->RowCounter = 0;
623
624 //
625 // Reset the CTRL-C event (yes we ignore the return values)
626 //
627 Status = gBS->CheckEvent (ShellInfoObject.NewEfiShellProtocol->ExecutionBreak);
628
629 //
630 // Display Prompt
631 //
632 Status = DoShellPrompt();
633 } while (!ShellCommandGetExit());
634 }
635 if (OldConIn != NULL && ConInHandle != NULL) {
636 CloseSimpleTextInOnFile (gST->ConIn);
637 gST->ConIn = OldConIn;
638 gST->ConsoleInHandle = ConInHandle;
639 }
640 }
641 }
642
643 FreeResources:
644 //
645 // uninstall protocols / free memory / etc...
646 //
647 if (ShellInfoObject.UserBreakTimer != NULL) {
648 gBS->CloseEvent(ShellInfoObject.UserBreakTimer);
649 DEBUG_CODE(ShellInfoObject.UserBreakTimer = NULL;);
650 }
651 if (ShellInfoObject.ImageDevPath != NULL) {
652 FreePool(ShellInfoObject.ImageDevPath);
653 DEBUG_CODE(ShellInfoObject.ImageDevPath = NULL;);
654 }
655 if (ShellInfoObject.FileDevPath != NULL) {
656 FreePool(ShellInfoObject.FileDevPath);
657 DEBUG_CODE(ShellInfoObject.FileDevPath = NULL;);
658 }
659 if (ShellInfoObject.NewShellParametersProtocol != NULL) {
660 CleanUpShellParametersProtocol(ShellInfoObject.NewShellParametersProtocol);
661 DEBUG_CODE(ShellInfoObject.NewShellParametersProtocol = NULL;);
662 }
663 if (ShellInfoObject.NewEfiShellProtocol != NULL){
664 if (ShellInfoObject.NewEfiShellProtocol->IsRootShell()){
665 InternalEfiShellSetEnv(L"cwd", NULL, TRUE);
666 }
667 CleanUpShellProtocol(ShellInfoObject.NewEfiShellProtocol);
668 DEBUG_CODE(ShellInfoObject.NewEfiShellProtocol = NULL;);
669 }
670
671 if (!IsListEmpty(&ShellInfoObject.BufferToFreeList.Link)){
672 FreeBufferList(&ShellInfoObject.BufferToFreeList);
673 }
674
675 if (!IsListEmpty(&ShellInfoObject.SplitList.Link)){
676 ASSERT(FALSE); ///@todo finish this de-allocation.
677 }
678
679 if (ShellInfoObject.ShellInitSettings.FileName != NULL) {
680 FreePool(ShellInfoObject.ShellInitSettings.FileName);
681 DEBUG_CODE(ShellInfoObject.ShellInitSettings.FileName = NULL;);
682 }
683
684 if (ShellInfoObject.ShellInitSettings.FileOptions != NULL) {
685 FreePool(ShellInfoObject.ShellInitSettings.FileOptions);
686 DEBUG_CODE(ShellInfoObject.ShellInitSettings.FileOptions = NULL;);
687 }
688
689 if (ShellInfoObject.HiiHandle != NULL) {
690 HiiRemovePackages(ShellInfoObject.HiiHandle);
691 DEBUG_CODE(ShellInfoObject.HiiHandle = NULL;);
692 }
693
694 if (!IsListEmpty(&ShellInfoObject.ViewingSettings.CommandHistory.Link)){
695 FreeBufferList(&ShellInfoObject.ViewingSettings.CommandHistory);
696 }
697
698 ASSERT(ShellInfoObject.ConsoleInfo != NULL);
699 if (ShellInfoObject.ConsoleInfo != NULL) {
700 ConsoleLoggerUninstall(ShellInfoObject.ConsoleInfo);
701 FreePool(ShellInfoObject.ConsoleInfo);
702 DEBUG_CODE(ShellInfoObject.ConsoleInfo = NULL;);
703 }
704
705 if (ShellCommandGetExit()) {
706 return ((EFI_STATUS)ShellCommandGetExitCode());
707 }
708 return (Status);
709 }
710
711 /**
712 Sets all the alias' that were registered with the ShellCommandLib library.
713
714 @retval EFI_SUCCESS all init commands were run sucessfully.
715 **/
716 EFI_STATUS
717 EFIAPI
718 SetBuiltInAlias(
719 )
720 {
721 EFI_STATUS Status;
722 CONST ALIAS_LIST *List;
723 ALIAS_LIST *Node;
724
725 //
726 // Get all the commands we want to run
727 //
728 List = ShellCommandGetInitAliasList();
729
730 //
731 // for each command in the List
732 //
733 for ( Node = (ALIAS_LIST*)GetFirstNode(&List->Link)
734 ; !IsNull (&List->Link, &Node->Link)
735 ; Node = (ALIAS_LIST *)GetNextNode(&List->Link, &Node->Link)
736 ){
737 //
738 // install the alias'
739 //
740 Status = InternalSetAlias(Node->CommandString, Node->Alias, TRUE);
741 ASSERT_EFI_ERROR(Status);
742 }
743 return (EFI_SUCCESS);
744 }
745
746 /**
747 Internal function to determine if 2 command names are really the same.
748
749 @param[in] Command1 The pointer to the first command name.
750 @param[in] Command2 The pointer to the second command name.
751
752 @retval TRUE The 2 command names are the same.
753 @retval FALSE The 2 command names are not the same.
754 **/
755 BOOLEAN
756 EFIAPI
757 IsCommand(
758 IN CONST CHAR16 *Command1,
759 IN CONST CHAR16 *Command2
760 )
761 {
762 if (StringNoCaseCompare(&Command1, &Command2) == 0) {
763 return (TRUE);
764 }
765 return (FALSE);
766 }
767
768 /**
769 Internal function to determine if a command is a script only command.
770
771 @param[in] CommandName The pointer to the command name.
772
773 @retval TRUE The command is a script only command.
774 @retval FALSE The command is not a script only command.
775 **/
776 BOOLEAN
777 EFIAPI
778 IsScriptOnlyCommand(
779 IN CONST CHAR16 *CommandName
780 )
781 {
782 if (IsCommand(CommandName, L"for")
783 ||IsCommand(CommandName, L"endfor")
784 ||IsCommand(CommandName, L"if")
785 ||IsCommand(CommandName, L"else")
786 ||IsCommand(CommandName, L"endif")
787 ||IsCommand(CommandName, L"goto")) {
788 return (TRUE);
789 }
790 return (FALSE);
791 }
792
793 /**
794 This function will populate the 2 device path protocol parameters based on the
795 global gImageHandle. The DevPath will point to the device path for the handle that has
796 loaded image protocol installed on it. The FilePath will point to the device path
797 for the file that was loaded.
798
799 @param[in, out] DevPath On a sucessful return the device path to the loaded image.
800 @param[in, out] FilePath On a sucessful return the device path to the file.
801
802 @retval EFI_SUCCESS The 2 device paths were sucessfully returned.
803 @retval other A error from gBS->HandleProtocol.
804
805 @sa HandleProtocol
806 **/
807 EFI_STATUS
808 EFIAPI
809 GetDevicePathsForImageAndFile (
810 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,
811 IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath
812 )
813 {
814 EFI_STATUS Status;
815 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
816 EFI_DEVICE_PATH_PROTOCOL *ImageDevicePath;
817
818 ASSERT(DevPath != NULL);
819 ASSERT(FilePath != NULL);
820
821 Status = gBS->OpenProtocol (
822 gImageHandle,
823 &gEfiLoadedImageProtocolGuid,
824 (VOID**)&LoadedImage,
825 gImageHandle,
826 NULL,
827 EFI_OPEN_PROTOCOL_GET_PROTOCOL
828 );
829 if (!EFI_ERROR (Status)) {
830 Status = gBS->OpenProtocol (
831 LoadedImage->DeviceHandle,
832 &gEfiDevicePathProtocolGuid,
833 (VOID**)&ImageDevicePath,
834 gImageHandle,
835 NULL,
836 EFI_OPEN_PROTOCOL_GET_PROTOCOL
837 );
838 if (!EFI_ERROR (Status)) {
839 *DevPath = DuplicateDevicePath (ImageDevicePath);
840 *FilePath = DuplicateDevicePath (LoadedImage->FilePath);
841 gBS->CloseProtocol(
842 LoadedImage->DeviceHandle,
843 &gEfiDevicePathProtocolGuid,
844 gImageHandle,
845 NULL);
846 }
847 gBS->CloseProtocol(
848 gImageHandle,
849 &gEfiLoadedImageProtocolGuid,
850 gImageHandle,
851 NULL);
852 }
853 return (Status);
854 }
855
856 /**
857 Process all Uefi Shell 2.0 command line options.
858
859 see Uefi Shell 2.0 section 3.2 for full details.
860
861 the command line must resemble the following:
862
863 shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
864
865 ShellOpt-options Options which control the initialization behavior of the shell.
866 These options are read from the EFI global variable "ShellOpt"
867 and are processed before options or file-name.
868
869 options Options which control the initialization behavior of the shell.
870
871 file-name The name of a UEFI shell application or script to be executed
872 after initialization is complete. By default, if file-name is
873 specified, then -nostartup is implied. Scripts are not supported
874 by level 0.
875
876 file-name-options The command-line options that are passed to file-name when it
877 is invoked.
878
879 This will initialize the ShellInfoObject.ShellInitSettings global variable.
880
881 @retval EFI_SUCCESS The variable is initialized.
882 **/
883 EFI_STATUS
884 EFIAPI
885 ProcessCommandLine(
886 VOID
887 )
888 {
889 UINTN Size;
890 UINTN LoopVar;
891 CHAR16 *CurrentArg;
892 CHAR16 *DelayValueStr;
893 UINT64 DelayValue;
894 EFI_STATUS Status;
895 EFI_UNICODE_COLLATION_PROTOCOL *UnicodeCollation;
896
897 // `file-name-options` will contain arguments to `file-name` that we don't
898 // know about. This would cause ShellCommandLineParse to error, so we parse
899 // arguments manually, ignoring those after the first thing that doesn't look
900 // like a shell option (which is assumed to be `file-name`).
901
902 Status = gBS->LocateProtocol (
903 &gEfiUnicodeCollationProtocolGuid,
904 NULL,
905 (VOID **) &UnicodeCollation
906 );
907 if (EFI_ERROR (Status)) {
908 return Status;
909 }
910
911 // Set default options
912 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup = FALSE;
913 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup = FALSE;
914 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleOut = FALSE;
915 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn = FALSE;
916 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt = FALSE;
917 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoMap = FALSE;
918 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoVersion = FALSE;
919 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Delay = FALSE;
920 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Exit = FALSE;
921 ShellInfoObject.ShellInitSettings.Delay = 5;
922
923 //
924 // Start LoopVar at 0 to parse only optional arguments at Argv[0]
925 // and parse other parameters from Argv[1]. This is for use case that
926 // UEFI Shell boot option is created, and OptionalData is provided
927 // that starts with shell command-line options.
928 //
929 for (LoopVar = 0 ; LoopVar < gEfiShellParametersProtocol->Argc ; LoopVar++) {
930 CurrentArg = gEfiShellParametersProtocol->Argv[LoopVar];
931 if (UnicodeCollation->StriColl (
932 UnicodeCollation,
933 L"-startup",
934 CurrentArg
935 ) == 0) {
936 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup = TRUE;
937 }
938 else if (UnicodeCollation->StriColl (
939 UnicodeCollation,
940 L"-nostartup",
941 CurrentArg
942 ) == 0) {
943 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup = TRUE;
944 }
945 else if (UnicodeCollation->StriColl (
946 UnicodeCollation,
947 L"-noconsoleout",
948 CurrentArg
949 ) == 0) {
950 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleOut = TRUE;
951 }
952 else if (UnicodeCollation->StriColl (
953 UnicodeCollation,
954 L"-noconsolein",
955 CurrentArg
956 ) == 0) {
957 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn = TRUE;
958 }
959 else if (UnicodeCollation->StriColl (
960 UnicodeCollation,
961 L"-nointerrupt",
962 CurrentArg
963 ) == 0) {
964 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt = TRUE;
965 }
966 else if (UnicodeCollation->StriColl (
967 UnicodeCollation,
968 L"-nomap",
969 CurrentArg
970 ) == 0) {
971 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoMap = TRUE;
972 }
973 else if (UnicodeCollation->StriColl (
974 UnicodeCollation,
975 L"-noversion",
976 CurrentArg
977 ) == 0) {
978 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoVersion = TRUE;
979 }
980 else if (UnicodeCollation->StriColl (
981 UnicodeCollation,
982 L"-delay",
983 CurrentArg
984 ) == 0) {
985 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Delay = TRUE;
986 // Check for optional delay value following "-delay"
987 DelayValueStr = gEfiShellParametersProtocol->Argv[LoopVar + 1];
988 if (DelayValueStr != NULL){
989 if (*DelayValueStr == L':') {
990 DelayValueStr++;
991 }
992 if (!EFI_ERROR(ShellConvertStringToUint64 (
993 DelayValueStr,
994 &DelayValue,
995 FALSE,
996 FALSE
997 ))) {
998 ShellInfoObject.ShellInitSettings.Delay = (UINTN)DelayValue;
999 LoopVar++;
1000 }
1001 }
1002 } else if (UnicodeCollation->StriColl (
1003 UnicodeCollation,
1004 L"-_exit",
1005 CurrentArg
1006 ) == 0) {
1007 ShellInfoObject.ShellInitSettings.BitUnion.Bits.Exit = TRUE;
1008 } else if (StrnCmp (L"-", CurrentArg, 1) == 0) {
1009 // Unrecognised option
1010 ShellPrintHiiEx(-1, -1, NULL,
1011 STRING_TOKEN (STR_GEN_PROBLEM),
1012 ShellInfoObject.HiiHandle,
1013 CurrentArg
1014 );
1015 return EFI_INVALID_PARAMETER;
1016 } else {
1017 //
1018 // First argument should be Shell.efi image name
1019 //
1020 if (LoopVar == 0) {
1021 continue;
1022 }
1023
1024 ShellInfoObject.ShellInitSettings.FileName = AllocateCopyPool(StrSize(CurrentArg), CurrentArg);
1025 if (ShellInfoObject.ShellInitSettings.FileName == NULL) {
1026 return (EFI_OUT_OF_RESOURCES);
1027 }
1028 //
1029 // We found `file-name`.
1030 //
1031 ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup = 1;
1032 LoopVar++;
1033
1034 // Add `file-name-options`
1035 for (Size = 0 ; LoopVar < gEfiShellParametersProtocol->Argc ; LoopVar++) {
1036 ASSERT((ShellInfoObject.ShellInitSettings.FileOptions == NULL && Size == 0) || (ShellInfoObject.ShellInitSettings.FileOptions != NULL));
1037 StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,
1038 &Size,
1039 L" ",
1040 0);
1041 if (ShellInfoObject.ShellInitSettings.FileOptions == NULL) {
1042 SHELL_FREE_NON_NULL(ShellInfoObject.ShellInitSettings.FileName);
1043 return (EFI_OUT_OF_RESOURCES);
1044 }
1045 StrnCatGrow(&ShellInfoObject.ShellInitSettings.FileOptions,
1046 &Size,
1047 gEfiShellParametersProtocol->Argv[LoopVar],
1048 0);
1049 if (ShellInfoObject.ShellInitSettings.FileOptions == NULL) {
1050 SHELL_FREE_NON_NULL(ShellInfoObject.ShellInitSettings.FileName);
1051 return (EFI_OUT_OF_RESOURCES);
1052 }
1053 }
1054 }
1055 }
1056
1057 // "-nointerrupt" overrides "-delay"
1058 if (ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoInterrupt) {
1059 ShellInfoObject.ShellInitSettings.Delay = 0;
1060 }
1061
1062 return EFI_SUCCESS;
1063 }
1064
1065 /**
1066 Handles all interaction with the default startup script.
1067
1068 this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
1069
1070 @param ImagePath the path to the image for shell. first place to look for the startup script
1071 @param FilePath the path to the file for shell. second place to look for the startup script.
1072
1073 @retval EFI_SUCCESS the variable is initialized.
1074 **/
1075 EFI_STATUS
1076 EFIAPI
1077 DoStartupScript(
1078 IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,
1079 IN EFI_DEVICE_PATH_PROTOCOL *FilePath
1080 )
1081 {
1082 EFI_STATUS Status;
1083 UINTN Delay;
1084 EFI_INPUT_KEY Key;
1085 SHELL_FILE_HANDLE FileHandle;
1086 EFI_DEVICE_PATH_PROTOCOL *NewPath;
1087 EFI_DEVICE_PATH_PROTOCOL *NamePath;
1088 CHAR16 *FileStringPath;
1089 CHAR16 *TempSpot;
1090 UINTN NewSize;
1091 CONST CHAR16 *MapName;
1092
1093 Key.UnicodeChar = CHAR_NULL;
1094 Key.ScanCode = 0;
1095 FileHandle = NULL;
1096
1097 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup && ShellInfoObject.ShellInitSettings.FileName != NULL) {
1098 //
1099 // launch something else instead
1100 //
1101 NewSize = StrSize(ShellInfoObject.ShellInitSettings.FileName);
1102 if (ShellInfoObject.ShellInitSettings.FileOptions != NULL) {
1103 NewSize += StrSize(ShellInfoObject.ShellInitSettings.FileOptions) + sizeof(CHAR16);
1104 }
1105 FileStringPath = AllocateZeroPool(NewSize);
1106 if (FileStringPath == NULL) {
1107 return (EFI_OUT_OF_RESOURCES);
1108 }
1109 StrnCpy(FileStringPath, ShellInfoObject.ShellInitSettings.FileName, NewSize/sizeof(CHAR16) -1);
1110 if (ShellInfoObject.ShellInitSettings.FileOptions != NULL) {
1111 StrnCat(FileStringPath, L" ", NewSize/sizeof(CHAR16) - StrLen(FileStringPath) -1);
1112 StrnCat(FileStringPath, ShellInfoObject.ShellInitSettings.FileOptions, NewSize/sizeof(CHAR16) - StrLen(FileStringPath) -1);
1113 }
1114 Status = RunCommand(FileStringPath);
1115 FreePool(FileStringPath);
1116 return (Status);
1117
1118 }
1119
1120 //
1121 // for shell level 0 we do no scripts
1122 // Without the Startup bit overriding we allow for nostartup to prevent scripts
1123 //
1124 if ( (PcdGet8(PcdShellSupportLevel) < 1)
1125 || (ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoStartup && !ShellInfoObject.ShellInitSettings.BitUnion.Bits.Startup)
1126 ){
1127 return (EFI_SUCCESS);
1128 }
1129
1130 gST->ConOut->EnableCursor(gST->ConOut, FALSE);
1131 //
1132 // print out our warning and see if they press a key
1133 //
1134 for ( Status = EFI_UNSUPPORTED, Delay = ShellInfoObject.ShellInitSettings.Delay
1135 ; Delay != 0 && EFI_ERROR(Status)
1136 ; Delay--
1137 ){
1138 ShellPrintHiiEx(0, gST->ConOut->Mode->CursorRow, NULL, STRING_TOKEN (STR_SHELL_STARTUP_QUESTION), ShellInfoObject.HiiHandle, Delay);
1139 gBS->Stall (1000000);
1140 if (!ShellInfoObject.ShellInitSettings.BitUnion.Bits.NoConsoleIn) {
1141 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
1142 }
1143 }
1144 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_CRLF), ShellInfoObject.HiiHandle);
1145 gST->ConOut->EnableCursor(gST->ConOut, TRUE);
1146
1147 //
1148 // ESC was pressed
1149 //
1150 if (Status == EFI_SUCCESS && Key.UnicodeChar == 0 && Key.ScanCode == SCAN_ESC) {
1151 return (EFI_SUCCESS);
1152 }
1153
1154 //
1155 // Try the first location (must be file system)
1156 //
1157 MapName = ShellInfoObject.NewEfiShellProtocol->GetMapFromDevicePath(&ImagePath);
1158 if (MapName != NULL) {
1159 FileStringPath = NULL;
1160 NewSize = 0;
1161 FileStringPath = StrnCatGrow(&FileStringPath, &NewSize, MapName, 0);
1162 if (FileStringPath == NULL) {
1163 Status = EFI_OUT_OF_RESOURCES;
1164 } else {
1165 TempSpot = StrStr(FileStringPath, L";");
1166 if (TempSpot != NULL) {
1167 *TempSpot = CHAR_NULL;
1168 }
1169 FileStringPath = StrnCatGrow(&FileStringPath, &NewSize, ((FILEPATH_DEVICE_PATH*)FilePath)->PathName, 0);
1170 PathRemoveLastItem(FileStringPath);
1171 FileStringPath = StrnCatGrow(&FileStringPath, &NewSize, mStartupScript, 0);
1172 Status = ShellInfoObject.NewEfiShellProtocol->OpenFileByName(FileStringPath, &FileHandle, EFI_FILE_MODE_READ);
1173 FreePool(FileStringPath);
1174 }
1175 }
1176 if (EFI_ERROR(Status)) {
1177 NamePath = FileDevicePath (NULL, mStartupScript);
1178 NewPath = AppendDevicePathNode (ImagePath, NamePath);
1179 FreePool(NamePath);
1180
1181 //
1182 // Try the location
1183 //
1184 Status = InternalOpenFileDevicePath(NewPath, &FileHandle, EFI_FILE_MODE_READ, 0);
1185 FreePool(NewPath);
1186 }
1187 //
1188 // If we got a file, run it
1189 //
1190 if (!EFI_ERROR(Status) && FileHandle != NULL) {
1191 Status = RunScriptFile (mStartupScript, FileHandle, L"", ShellInfoObject.NewShellParametersProtocol);
1192 ShellInfoObject.NewEfiShellProtocol->CloseFile(FileHandle);
1193 } else {
1194 FileStringPath = ShellFindFilePath(mStartupScript);
1195 if (FileStringPath == NULL) {
1196 //
1197 // we return success since we dont need to have a startup script
1198 //
1199 Status = EFI_SUCCESS;
1200 ASSERT(FileHandle == NULL);
1201 } else {
1202 Status = RunScriptFile(FileStringPath, NULL, L"", ShellInfoObject.NewShellParametersProtocol);
1203 FreePool(FileStringPath);
1204 }
1205 }
1206
1207
1208 return (Status);
1209 }
1210
1211 /**
1212 Function to perform the shell prompt looping. It will do a single prompt,
1213 dispatch the result, and then return. It is expected that the caller will
1214 call this function in a loop many times.
1215
1216 @retval EFI_SUCCESS
1217 @retval RETURN_ABORTED
1218 **/
1219 EFI_STATUS
1220 EFIAPI
1221 DoShellPrompt (
1222 VOID
1223 )
1224 {
1225 UINTN Column;
1226 UINTN Row;
1227 CHAR16 *CmdLine;
1228 CONST CHAR16 *CurDir;
1229 UINTN BufferSize;
1230 EFI_STATUS Status;
1231
1232 CurDir = NULL;
1233
1234 //
1235 // Get screen setting to decide size of the command line buffer
1236 //
1237 gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Column, &Row);
1238 BufferSize = Column * Row * sizeof (CHAR16);
1239 CmdLine = AllocateZeroPool (BufferSize);
1240 if (CmdLine == NULL) {
1241 return EFI_OUT_OF_RESOURCES;
1242 }
1243
1244 CurDir = ShellInfoObject.NewEfiShellProtocol->GetEnv(L"cwd");
1245
1246 //
1247 // Prompt for input
1248 //
1249 gST->ConOut->SetCursorPosition (gST->ConOut, 0, gST->ConOut->Mode->CursorRow);
1250
1251 if (CurDir != NULL && StrLen(CurDir) > 1) {
1252 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_CURDIR), ShellInfoObject.HiiHandle, CurDir);
1253 } else {
1254 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_SHELL), ShellInfoObject.HiiHandle);
1255 }
1256
1257 //
1258 // Read a line from the console
1259 //
1260 Status = ShellInfoObject.NewEfiShellProtocol->ReadFile(ShellInfoObject.NewShellParametersProtocol->StdIn, &BufferSize, CmdLine);
1261
1262 //
1263 // Null terminate the string and parse it
1264 //
1265 if (!EFI_ERROR (Status)) {
1266 CmdLine[BufferSize / sizeof (CHAR16)] = CHAR_NULL;
1267 Status = RunCommand(CmdLine);
1268 }
1269
1270 //
1271 // Done with this command
1272 //
1273 FreePool (CmdLine);
1274 return Status;
1275 }
1276
1277 /**
1278 Add a buffer to the Buffer To Free List for safely returning buffers to other
1279 places without risking letting them modify internal shell information.
1280
1281 @param Buffer Something to pass to FreePool when the shell is exiting.
1282 **/
1283 VOID*
1284 EFIAPI
1285 AddBufferToFreeList(
1286 VOID *Buffer
1287 )
1288 {
1289 BUFFER_LIST *BufferListEntry;
1290
1291 if (Buffer == NULL) {
1292 return (NULL);
1293 }
1294
1295 BufferListEntry = AllocateZeroPool(sizeof(BUFFER_LIST));
1296 ASSERT(BufferListEntry != NULL);
1297 BufferListEntry->Buffer = Buffer;
1298 InsertTailList(&ShellInfoObject.BufferToFreeList.Link, &BufferListEntry->Link);
1299 return (Buffer);
1300 }
1301
1302 /**
1303 Add a buffer to the Line History List
1304
1305 @param Buffer The line buffer to add.
1306 **/
1307 VOID
1308 EFIAPI
1309 AddLineToCommandHistory(
1310 IN CONST CHAR16 *Buffer
1311 )
1312 {
1313 BUFFER_LIST *Node;
1314
1315 Node = AllocateZeroPool(sizeof(BUFFER_LIST));
1316 ASSERT(Node != NULL);
1317 Node->Buffer = AllocateCopyPool(StrSize(Buffer), Buffer);
1318 ASSERT(Node->Buffer != NULL);
1319
1320 InsertTailList(&ShellInfoObject.ViewingSettings.CommandHistory.Link, &Node->Link);
1321 }
1322
1323 /**
1324 Checks if a string is an alias for another command. If yes, then it replaces the alias name
1325 with the correct command name.
1326
1327 @param[in, out] CommandString Upon entry the potential alias. Upon return the
1328 command name if it was an alias. If it was not
1329 an alias it will be unchanged. This function may
1330 change the buffer to fit the command name.
1331
1332 @retval EFI_SUCCESS The name was changed.
1333 @retval EFI_SUCCESS The name was not an alias.
1334 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1335 **/
1336 EFI_STATUS
1337 EFIAPI
1338 ShellConvertAlias(
1339 IN OUT CHAR16 **CommandString
1340 )
1341 {
1342 CONST CHAR16 *NewString;
1343
1344 NewString = ShellInfoObject.NewEfiShellProtocol->GetAlias(*CommandString, NULL);
1345 if (NewString == NULL) {
1346 return (EFI_SUCCESS);
1347 }
1348 FreePool(*CommandString);
1349 *CommandString = AllocateCopyPool(StrSize(NewString), NewString);
1350 if (*CommandString == NULL) {
1351 return (EFI_OUT_OF_RESOURCES);
1352 }
1353 return (EFI_SUCCESS);
1354 }
1355
1356 /**
1357 This function will eliminate unreplaced (and therefore non-found) environment variables.
1358
1359 @param[in,out] CmdLine The command line to update.
1360 **/
1361 EFI_STATUS
1362 EFIAPI
1363 StripUnreplacedEnvironmentVariables(
1364 IN OUT CHAR16 *CmdLine
1365 )
1366 {
1367 CHAR16 *FirstPercent;
1368 CHAR16 *FirstQuote;
1369 CHAR16 *SecondPercent;
1370 CHAR16 *SecondQuote;
1371 CHAR16 *CurrentLocator;
1372
1373 for (CurrentLocator = CmdLine ; CurrentLocator != NULL ; ) {
1374 FirstQuote = FindNextInstance(CurrentLocator, L"\"", TRUE);
1375 FirstPercent = FindNextInstance(CurrentLocator, L"%", TRUE);
1376 SecondPercent = FirstPercent!=NULL?FindNextInstance(FirstPercent+1, L"%", TRUE):NULL;
1377 if (FirstPercent == NULL || SecondPercent == NULL) {
1378 //
1379 // If we ever dont have 2 % we are done.
1380 //
1381 break;
1382 }
1383
1384 if (FirstQuote!= NULL && FirstQuote < FirstPercent) {
1385 SecondQuote = FindNextInstance(FirstQuote+1, L"\"", TRUE);
1386 //
1387 // Quote is first found
1388 //
1389
1390 if (SecondQuote < FirstPercent) {
1391 //
1392 // restart after the pair of "
1393 //
1394 CurrentLocator = SecondQuote + 1;
1395 } else /* FirstPercent < SecondQuote */{
1396 //
1397 // Restart on the first percent
1398 //
1399 CurrentLocator = FirstPercent;
1400 }
1401 continue;
1402 }
1403
1404 if (FirstQuote == NULL || SecondPercent < FirstQuote) {
1405 if (IsValidEnvironmentVariableName(FirstPercent, SecondPercent)) {
1406 //
1407 // We need to remove from FirstPercent to SecondPercent
1408 //
1409 CopyMem(FirstPercent, SecondPercent + 1, StrSize(SecondPercent + 1));
1410 //
1411 // dont need to update the locator. both % characters are gone.
1412 //
1413 } else {
1414 CurrentLocator = SecondPercent + 1;
1415 }
1416 continue;
1417 }
1418 CurrentLocator = FirstQuote;
1419 }
1420 return (EFI_SUCCESS);
1421 }
1422
1423 /**
1424 Function allocates a new command line and replaces all instances of environment
1425 variable names that are correctly preset to their values.
1426
1427 If the return value is not NULL the memory must be caller freed.
1428
1429 @param[in] OriginalCommandLine The original command line
1430
1431 @retval NULL An error ocurred.
1432 @return The new command line with no environment variables present.
1433 **/
1434 CHAR16*
1435 EFIAPI
1436 ShellConvertVariables (
1437 IN CONST CHAR16 *OriginalCommandLine
1438 )
1439 {
1440 CONST CHAR16 *MasterEnvList;
1441 UINTN NewSize;
1442 CHAR16 *NewCommandLine1;
1443 CHAR16 *NewCommandLine2;
1444 CHAR16 *Temp;
1445 UINTN ItemSize;
1446 CHAR16 *ItemTemp;
1447 SCRIPT_FILE *CurrentScriptFile;
1448 ALIAS_LIST *AliasListNode;
1449
1450 ASSERT(OriginalCommandLine != NULL);
1451
1452 ItemSize = 0;
1453 NewSize = StrSize(OriginalCommandLine);
1454 CurrentScriptFile = ShellCommandGetCurrentScriptFile();
1455 Temp = NULL;
1456
1457 ///@todo update this to handle the %0 - %9 for scripting only (borrow from line 1256 area) ? ? ?
1458
1459 //
1460 // calculate the size required for the post-conversion string...
1461 //
1462 if (CurrentScriptFile != NULL) {
1463 for (AliasListNode = (ALIAS_LIST*)GetFirstNode(&CurrentScriptFile->SubstList)
1464 ; !IsNull(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1465 ; AliasListNode = (ALIAS_LIST*)GetNextNode(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1466 ){
1467 for (Temp = StrStr(OriginalCommandLine, AliasListNode->Alias)
1468 ; Temp != NULL
1469 ; Temp = StrStr(Temp+1, AliasListNode->Alias)
1470 ){
1471 //
1472 // we need a preceeding and if there is space no ^ preceeding (if no space ignore)
1473 //
1474 if ((((Temp-OriginalCommandLine)>2) && *(Temp-2) != L'^') || ((Temp-OriginalCommandLine)<=2)) {
1475 NewSize += StrSize(AliasListNode->CommandString);
1476 }
1477 }
1478 }
1479 }
1480
1481 for (MasterEnvList = EfiShellGetEnv(NULL)
1482 ; MasterEnvList != NULL && *MasterEnvList != CHAR_NULL //&& *(MasterEnvList+1) != CHAR_NULL
1483 ; MasterEnvList += StrLen(MasterEnvList) + 1
1484 ){
1485 if (StrSize(MasterEnvList) > ItemSize) {
1486 ItemSize = StrSize(MasterEnvList);
1487 }
1488 for (Temp = StrStr(OriginalCommandLine, MasterEnvList)
1489 ; Temp != NULL
1490 ; Temp = StrStr(Temp+1, MasterEnvList)
1491 ){
1492 //
1493 // we need a preceeding and following % and if there is space no ^ preceeding (if no space ignore)
1494 //
1495 if (*(Temp-1) == L'%' && *(Temp+StrLen(MasterEnvList)) == L'%' &&
1496 ((((Temp-OriginalCommandLine)>2) && *(Temp-2) != L'^') || ((Temp-OriginalCommandLine)<=2))) {
1497 NewSize+=StrSize(EfiShellGetEnv(MasterEnvList));
1498 }
1499 }
1500 }
1501
1502 //
1503 // now do the replacements...
1504 //
1505 NewCommandLine1 = AllocateCopyPool(NewSize, OriginalCommandLine);
1506 NewCommandLine2 = AllocateZeroPool(NewSize);
1507 ItemTemp = AllocateZeroPool(ItemSize+(2*sizeof(CHAR16)));
1508 if (NewCommandLine1 == NULL || NewCommandLine2 == NULL || ItemTemp == NULL) {
1509 SHELL_FREE_NON_NULL(NewCommandLine1);
1510 SHELL_FREE_NON_NULL(NewCommandLine2);
1511 SHELL_FREE_NON_NULL(ItemTemp);
1512 return (NULL);
1513 }
1514 for (MasterEnvList = EfiShellGetEnv(NULL)
1515 ; MasterEnvList != NULL && *MasterEnvList != CHAR_NULL
1516 ; MasterEnvList += StrLen(MasterEnvList) + 1
1517 ){
1518 StrnCpy(ItemTemp, L"%", ((ItemSize+(2*sizeof(CHAR16)))/sizeof(CHAR16))-1);
1519 StrnCat(ItemTemp, MasterEnvList, ((ItemSize+(2*sizeof(CHAR16)))/sizeof(CHAR16))-1 - StrLen(ItemTemp));
1520 StrnCat(ItemTemp, L"%", ((ItemSize+(2*sizeof(CHAR16)))/sizeof(CHAR16))-1 - StrLen(ItemTemp));
1521 ShellCopySearchAndReplace(NewCommandLine1, NewCommandLine2, NewSize, ItemTemp, EfiShellGetEnv(MasterEnvList), TRUE, FALSE);
1522 StrnCpy(NewCommandLine1, NewCommandLine2, NewSize/sizeof(CHAR16)-1);
1523 }
1524 if (CurrentScriptFile != NULL) {
1525 for (AliasListNode = (ALIAS_LIST*)GetFirstNode(&CurrentScriptFile->SubstList)
1526 ; !IsNull(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1527 ; AliasListNode = (ALIAS_LIST*)GetNextNode(&CurrentScriptFile->SubstList, &AliasListNode->Link)
1528 ){
1529 ShellCopySearchAndReplace(NewCommandLine1, NewCommandLine2, NewSize, AliasListNode->Alias, AliasListNode->CommandString, TRUE, FALSE);
1530 StrnCpy(NewCommandLine1, NewCommandLine2, NewSize/sizeof(CHAR16)-1);
1531 }
1532 }
1533
1534 //
1535 // Remove non-existant environment variables
1536 //
1537 StripUnreplacedEnvironmentVariables(NewCommandLine1);
1538
1539 //
1540 // Now cleanup any straggler intentionally ignored "%" characters
1541 //
1542 ShellCopySearchAndReplace(NewCommandLine1, NewCommandLine2, NewSize, L"^%", L"%", TRUE, FALSE);
1543 StrnCpy(NewCommandLine1, NewCommandLine2, NewSize/sizeof(CHAR16)-1);
1544
1545 FreePool(NewCommandLine2);
1546 FreePool(ItemTemp);
1547
1548 return (NewCommandLine1);
1549 }
1550
1551 /**
1552 Internal function to run a command line with pipe usage.
1553
1554 @param[in] CmdLine The pointer to the command line.
1555 @param[in] StdIn The pointer to the Standard input.
1556 @param[in] StdOut The pointer to the Standard output.
1557
1558 @retval EFI_SUCCESS The split command is executed successfully.
1559 @retval other Some error occurs when executing the split command.
1560 **/
1561 EFI_STATUS
1562 EFIAPI
1563 RunSplitCommand(
1564 IN CONST CHAR16 *CmdLine,
1565 IN SHELL_FILE_HANDLE *StdIn,
1566 IN SHELL_FILE_HANDLE *StdOut
1567 )
1568 {
1569 EFI_STATUS Status;
1570 CHAR16 *NextCommandLine;
1571 CHAR16 *OurCommandLine;
1572 UINTN Size1;
1573 UINTN Size2;
1574 SPLIT_LIST *Split;
1575 SHELL_FILE_HANDLE *TempFileHandle;
1576 BOOLEAN Unicode;
1577
1578 ASSERT(StdOut == NULL);
1579
1580 ASSERT(StrStr(CmdLine, L"|") != NULL);
1581
1582 Status = EFI_SUCCESS;
1583 NextCommandLine = NULL;
1584 OurCommandLine = NULL;
1585 Size1 = 0;
1586 Size2 = 0;
1587
1588 NextCommandLine = StrnCatGrow(&NextCommandLine, &Size1, StrStr(CmdLine, L"|")+1, 0);
1589 OurCommandLine = StrnCatGrow(&OurCommandLine , &Size2, CmdLine , StrStr(CmdLine, L"|") - CmdLine);
1590
1591 if (NextCommandLine == NULL || OurCommandLine == NULL) {
1592 SHELL_FREE_NON_NULL(OurCommandLine);
1593 SHELL_FREE_NON_NULL(NextCommandLine);
1594 return (EFI_OUT_OF_RESOURCES);
1595 } else if (StrStr(OurCommandLine, L"|") != NULL || Size1 == 0 || Size2 == 0) {
1596 SHELL_FREE_NON_NULL(OurCommandLine);
1597 SHELL_FREE_NON_NULL(NextCommandLine);
1598 return (EFI_INVALID_PARAMETER);
1599 } else if (NextCommandLine[0] != CHAR_NULL &&
1600 NextCommandLine[0] == L'a' &&
1601 NextCommandLine[1] == L' '
1602 ){
1603 CopyMem(NextCommandLine, NextCommandLine+1, StrSize(NextCommandLine) - sizeof(NextCommandLine[0]));
1604 Unicode = FALSE;
1605 } else {
1606 Unicode = TRUE;
1607 }
1608
1609
1610 //
1611 // make a SPLIT_LIST item and add to list
1612 //
1613 Split = AllocateZeroPool(sizeof(SPLIT_LIST));
1614 ASSERT(Split != NULL);
1615 Split->SplitStdIn = StdIn;
1616 Split->SplitStdOut = ConvertEfiFileProtocolToShellHandle(CreateFileInterfaceMem(Unicode), NULL);
1617 ASSERT(Split->SplitStdOut != NULL);
1618 InsertHeadList(&ShellInfoObject.SplitList.Link, &Split->Link);
1619
1620 Status = RunCommand(OurCommandLine);
1621
1622 //
1623 // move the output from the first to the in to the second.
1624 //
1625 TempFileHandle = Split->SplitStdOut;
1626 if (Split->SplitStdIn == StdIn) {
1627 Split->SplitStdOut = NULL;
1628 } else {
1629 Split->SplitStdOut = Split->SplitStdIn;
1630 }
1631 Split->SplitStdIn = TempFileHandle;
1632 ShellInfoObject.NewEfiShellProtocol->SetFilePosition(ConvertShellHandleToEfiFileProtocol(Split->SplitStdIn), 0);
1633
1634 if (!EFI_ERROR(Status)) {
1635 Status = RunCommand(NextCommandLine);
1636 }
1637
1638 //
1639 // remove the top level from the ScriptList
1640 //
1641 ASSERT((SPLIT_LIST*)GetFirstNode(&ShellInfoObject.SplitList.Link) == Split);
1642 RemoveEntryList(&Split->Link);
1643
1644 //
1645 // Note that the original StdIn is now the StdOut...
1646 //
1647 if (Split->SplitStdOut != NULL && Split->SplitStdOut != StdIn) {
1648 ShellInfoObject.NewEfiShellProtocol->CloseFile(ConvertShellHandleToEfiFileProtocol(Split->SplitStdOut));
1649 }
1650 if (Split->SplitStdIn != NULL) {
1651 ShellInfoObject.NewEfiShellProtocol->CloseFile(ConvertShellHandleToEfiFileProtocol(Split->SplitStdIn));
1652 }
1653
1654 FreePool(Split);
1655 FreePool(NextCommandLine);
1656 FreePool(OurCommandLine);
1657
1658 return (Status);
1659 }
1660
1661 /**
1662 Take the original command line, substitute any variables, free
1663 the original string, return the modified copy.
1664
1665 @param[in] CmdLine pointer to the command line to update.
1666
1667 @retval EFI_SUCCESS the function was successful.
1668 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
1669 **/
1670 EFI_STATUS
1671 EFIAPI
1672 ShellSubstituteVariables(
1673 IN CHAR16 **CmdLine
1674 )
1675 {
1676 CHAR16 *NewCmdLine;
1677 NewCmdLine = ShellConvertVariables(*CmdLine);
1678 SHELL_FREE_NON_NULL(*CmdLine);
1679 if (NewCmdLine == NULL) {
1680 return (EFI_OUT_OF_RESOURCES);
1681 }
1682 *CmdLine = NewCmdLine;
1683 return (EFI_SUCCESS);
1684 }
1685
1686 /**
1687 Take the original command line, substitute any alias in the first group of space delimited characters, free
1688 the original string, return the modified copy.
1689
1690 @param[in] CmdLine pointer to the command line to update.
1691
1692 @retval EFI_SUCCESS the function was successful.
1693 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
1694 **/
1695 EFI_STATUS
1696 EFIAPI
1697 ShellSubstituteAliases(
1698 IN CHAR16 **CmdLine
1699 )
1700 {
1701 CHAR16 *NewCmdLine;
1702 CHAR16 *CommandName;
1703 EFI_STATUS Status;
1704 UINTN PostAliasSize;
1705 ASSERT(CmdLine != NULL);
1706 ASSERT(*CmdLine!= NULL);
1707
1708
1709 CommandName = NULL;
1710 if (StrStr((*CmdLine), L" ") == NULL){
1711 StrnCatGrow(&CommandName, NULL, (*CmdLine), 0);
1712 } else {
1713 StrnCatGrow(&CommandName, NULL, (*CmdLine), StrStr((*CmdLine), L" ") - (*CmdLine));
1714 }
1715
1716 //
1717 // This cannot happen 'inline' since the CmdLine can need extra space.
1718 //
1719 NewCmdLine = NULL;
1720 if (!ShellCommandIsCommandOnList(CommandName)) {
1721 //
1722 // Convert via alias
1723 //
1724 Status = ShellConvertAlias(&CommandName);
1725 if (EFI_ERROR(Status)){
1726 return (Status);
1727 }
1728 PostAliasSize = 0;
1729 NewCmdLine = StrnCatGrow(&NewCmdLine, &PostAliasSize, CommandName, 0);
1730 if (NewCmdLine == NULL) {
1731 SHELL_FREE_NON_NULL(CommandName);
1732 SHELL_FREE_NON_NULL(*CmdLine);
1733 return (EFI_OUT_OF_RESOURCES);
1734 }
1735 NewCmdLine = StrnCatGrow(&NewCmdLine, &PostAliasSize, StrStr((*CmdLine), L" "), 0);
1736 if (NewCmdLine == NULL) {
1737 SHELL_FREE_NON_NULL(CommandName);
1738 SHELL_FREE_NON_NULL(*CmdLine);
1739 return (EFI_OUT_OF_RESOURCES);
1740 }
1741 } else {
1742 NewCmdLine = StrnCatGrow(&NewCmdLine, NULL, (*CmdLine), 0);
1743 }
1744
1745 SHELL_FREE_NON_NULL(*CmdLine);
1746 SHELL_FREE_NON_NULL(CommandName);
1747
1748 //
1749 // re-assign the passed in double pointer to point to our newly allocated buffer
1750 //
1751 *CmdLine = NewCmdLine;
1752
1753 return (EFI_SUCCESS);
1754 }
1755
1756 /**
1757 Takes the Argv[0] part of the command line and determine the meaning of it.
1758
1759 @param[in] CmdName pointer to the command line to update.
1760
1761 @retval Internal_Command The name is an internal command.
1762 @retval File_Sys_Change the name is a file system change.
1763 @retval Script_File_Name the name is a NSH script file.
1764 @retval Unknown_Invalid the name is unknown.
1765 @retval Efi_Application the name is an application (.EFI).
1766 **/
1767 SHELL_OPERATION_TYPES
1768 EFIAPI
1769 GetOperationType(
1770 IN CONST CHAR16 *CmdName
1771 )
1772 {
1773 CHAR16* FileWithPath;
1774 CONST CHAR16* TempLocation;
1775 CONST CHAR16* TempLocation2;
1776
1777 FileWithPath = NULL;
1778 //
1779 // test for an internal command.
1780 //
1781 if (ShellCommandIsCommandOnList(CmdName)) {
1782 return (Internal_Command);
1783 }
1784
1785 //
1786 // Test for file system change request. anything ending with first : and cant have spaces.
1787 //
1788 if (CmdName[(StrLen(CmdName)-1)] == L':') {
1789 if ( StrStr(CmdName, L" ") != NULL
1790 || StrLen(StrStr(CmdName, L":")) > 1
1791 ) {
1792 return (Unknown_Invalid);
1793 }
1794 return (File_Sys_Change);
1795 }
1796
1797 //
1798 // Test for a file
1799 //
1800 if ((FileWithPath = ShellFindFilePathEx(CmdName, mExecutableExtensions)) != NULL) {
1801 //
1802 // See if that file has a script file extension
1803 //
1804 if (StrLen(FileWithPath) > 4) {
1805 TempLocation = FileWithPath+StrLen(FileWithPath)-4;
1806 TempLocation2 = mScriptExtension;
1807 if (StringNoCaseCompare((VOID*)(&TempLocation), (VOID*)(&TempLocation2)) == 0) {
1808 SHELL_FREE_NON_NULL(FileWithPath);
1809 return (Script_File_Name);
1810 }
1811 }
1812
1813 //
1814 // Was a file, but not a script. we treat this as an application.
1815 //
1816 SHELL_FREE_NON_NULL(FileWithPath);
1817 return (Efi_Application);
1818 }
1819
1820 SHELL_FREE_NON_NULL(FileWithPath);
1821 //
1822 // No clue what this is... return invalid flag...
1823 //
1824 return (Unknown_Invalid);
1825 }
1826
1827 /**
1828 Determine if the first item in a command line is valid.
1829
1830 @param[in] CmdLine The command line to parse.
1831
1832 @retval EFI_SUCCESS The item is valid.
1833 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1834 @retval EFI_NOT_FOUND The operation type is unknown or invalid.
1835 **/
1836 EFI_STATUS
1837 EFIAPI
1838 IsValidSplit(
1839 IN CONST CHAR16 *CmdLine
1840 )
1841 {
1842 CHAR16 *Temp;
1843 CHAR16 *FirstParameter;
1844 CHAR16 *TempWalker;
1845 EFI_STATUS Status;
1846
1847 Temp = NULL;
1848
1849 Temp = StrnCatGrow(&Temp, NULL, CmdLine, 0);
1850 if (Temp == NULL) {
1851 return (EFI_OUT_OF_RESOURCES);
1852 }
1853
1854 FirstParameter = StrStr(Temp, L"|");
1855 if (FirstParameter != NULL) {
1856 *FirstParameter = CHAR_NULL;
1857 }
1858
1859 FirstParameter = NULL;
1860
1861 //
1862 // Process the command line
1863 //
1864 Status = ProcessCommandLineToFinal(&Temp);
1865
1866 if (!EFI_ERROR(Status)) {
1867 FirstParameter = AllocateZeroPool(StrSize(CmdLine));
1868 if (FirstParameter == NULL) {
1869 SHELL_FREE_NON_NULL(Temp);
1870 return (EFI_OUT_OF_RESOURCES);
1871 }
1872 TempWalker = (CHAR16*)Temp;
1873 GetNextParameter(&TempWalker, &FirstParameter, StrSize(CmdLine));
1874
1875 if (GetOperationType(FirstParameter) == Unknown_Invalid) {
1876 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_NOT_FOUND), ShellInfoObject.HiiHandle, FirstParameter);
1877 SetLastError(SHELL_NOT_FOUND);
1878 Status = EFI_NOT_FOUND;
1879 }
1880 }
1881
1882 SHELL_FREE_NON_NULL(Temp);
1883 SHELL_FREE_NON_NULL(FirstParameter);
1884 return Status;
1885 }
1886
1887 /**
1888 Determine if a command line contains with a split contains only valid commands.
1889
1890 @param[in] CmdLine The command line to parse.
1891
1892 @retval EFI_SUCCESS CmdLine has only valid commands, application, or has no split.
1893 @retval EFI_ABORTED CmdLine has at least one invalid command or application.
1894 **/
1895 EFI_STATUS
1896 EFIAPI
1897 VerifySplit(
1898 IN CONST CHAR16 *CmdLine
1899 )
1900 {
1901 CONST CHAR16 *TempSpot;
1902 EFI_STATUS Status;
1903
1904 //
1905 // Verify up to the pipe or end character
1906 //
1907 Status = IsValidSplit(CmdLine);
1908 if (EFI_ERROR(Status)) {
1909 return (Status);
1910 }
1911
1912 //
1913 // If this was the only item, then get out
1914 //
1915 if (!ContainsSplit(CmdLine)) {
1916 return (EFI_SUCCESS);
1917 }
1918
1919 //
1920 // recurse to verify the next item
1921 //
1922 TempSpot = FindSplit(CmdLine)+1;
1923 return (VerifySplit(TempSpot));
1924 }
1925
1926 /**
1927 Process a split based operation.
1928
1929 @param[in] CmdLine pointer to the command line to process
1930
1931 @retval EFI_SUCCESS The operation was successful
1932 @return an error occured.
1933 **/
1934 EFI_STATUS
1935 EFIAPI
1936 ProcessNewSplitCommandLine(
1937 IN CONST CHAR16 *CmdLine
1938 )
1939 {
1940 SPLIT_LIST *Split;
1941 EFI_STATUS Status;
1942
1943 Status = VerifySplit(CmdLine);
1944 if (EFI_ERROR(Status)) {
1945 return (Status);
1946 }
1947
1948 Split = NULL;
1949
1950 //
1951 // are we in an existing split???
1952 //
1953 if (!IsListEmpty(&ShellInfoObject.SplitList.Link)) {
1954 Split = (SPLIT_LIST*)GetFirstNode(&ShellInfoObject.SplitList.Link);
1955 }
1956
1957 if (Split == NULL) {
1958 Status = RunSplitCommand(CmdLine, NULL, NULL);
1959 } else {
1960 Status = RunSplitCommand(CmdLine, Split->SplitStdIn, Split->SplitStdOut);
1961 }
1962 if (EFI_ERROR(Status)) {
1963 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_INVALID_SPLIT), ShellInfoObject.HiiHandle, CmdLine);
1964 }
1965 return (Status);
1966 }
1967
1968 /**
1969 Handle a request to change the current file system.
1970
1971 @param[in] CmdLine The passed in command line.
1972
1973 @retval EFI_SUCCESS The operation was successful.
1974 **/
1975 EFI_STATUS
1976 EFIAPI
1977 ChangeMappedDrive(
1978 IN CONST CHAR16 *CmdLine
1979 )
1980 {
1981 EFI_STATUS Status;
1982 Status = EFI_SUCCESS;
1983
1984 //
1985 // make sure we are the right operation
1986 //
1987 ASSERT(CmdLine[(StrLen(CmdLine)-1)] == L':' && StrStr(CmdLine, L" ") == NULL);
1988
1989 //
1990 // Call the protocol API to do the work
1991 //
1992 Status = ShellInfoObject.NewEfiShellProtocol->SetCurDir(NULL, CmdLine);
1993
1994 //
1995 // Report any errors
1996 //
1997 if (EFI_ERROR(Status)) {
1998 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_INVALID_MAPPING), ShellInfoObject.HiiHandle, CmdLine);
1999 }
2000
2001 return (Status);
2002 }
2003
2004 /**
2005 Reprocess the command line to direct all -? to the help command.
2006
2007 if found, will add "help" as argv[0], and move the rest later.
2008
2009 @param[in,out] CmdLine pointer to the command line to update
2010 **/
2011 EFI_STATUS
2012 EFIAPI
2013 DoHelpUpdate(
2014 IN OUT CHAR16 **CmdLine
2015 )
2016 {
2017 CHAR16 *CurrentParameter;
2018 CHAR16 *Walker;
2019 CHAR16 *LastWalker;
2020 CHAR16 *NewCommandLine;
2021 EFI_STATUS Status;
2022
2023 Status = EFI_SUCCESS;
2024
2025 CurrentParameter = AllocateZeroPool(StrSize(*CmdLine));
2026 if (CurrentParameter == NULL) {
2027 return (EFI_OUT_OF_RESOURCES);
2028 }
2029
2030 Walker = *CmdLine;
2031 while(Walker != NULL && *Walker != CHAR_NULL) {
2032 LastWalker = Walker;
2033 GetNextParameter(&Walker, &CurrentParameter, StrSize(*CmdLine));
2034 if (StrStr(CurrentParameter, L"-?") == CurrentParameter) {
2035 LastWalker[0] = L' ';
2036 LastWalker[1] = L' ';
2037 NewCommandLine = AllocateZeroPool(StrSize(L"help ") + StrSize(*CmdLine));
2038 if (NewCommandLine == NULL) {
2039 Status = EFI_OUT_OF_RESOURCES;
2040 break;
2041 }
2042
2043 //
2044 // We know the space is sufficient since we just calculated it.
2045 //
2046 StrnCpy(NewCommandLine, L"help ", 5);
2047 StrnCat(NewCommandLine, *CmdLine, StrLen(*CmdLine));
2048 SHELL_FREE_NON_NULL(*CmdLine);
2049 *CmdLine = NewCommandLine;
2050 break;
2051 }
2052 }
2053
2054 SHELL_FREE_NON_NULL(CurrentParameter);
2055
2056 return (Status);
2057 }
2058
2059 /**
2060 Function to update the shell variable "lasterror".
2061
2062 @param[in] ErrorCode the error code to put into lasterror.
2063 **/
2064 EFI_STATUS
2065 EFIAPI
2066 SetLastError(
2067 IN CONST SHELL_STATUS ErrorCode
2068 )
2069 {
2070 CHAR16 LeString[19];
2071 if (sizeof(EFI_STATUS) == sizeof(UINT64)) {
2072 UnicodeSPrint(LeString, sizeof(LeString), L"0x%Lx", ErrorCode);
2073 } else {
2074 UnicodeSPrint(LeString, sizeof(LeString), L"0x%x", ErrorCode);
2075 }
2076 DEBUG_CODE(InternalEfiShellSetEnv(L"debuglasterror", LeString, TRUE););
2077 InternalEfiShellSetEnv(L"lasterror", LeString, TRUE);
2078
2079 return (EFI_SUCCESS);
2080 }
2081
2082 /**
2083 Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec.
2084
2085 @param[in,out] CmdLine pointer to the command line to update
2086
2087 @retval EFI_SUCCESS The operation was successful
2088 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2089 @return some other error occured
2090 **/
2091 EFI_STATUS
2092 EFIAPI
2093 ProcessCommandLineToFinal(
2094 IN OUT CHAR16 **CmdLine
2095 )
2096 {
2097 EFI_STATUS Status;
2098 TrimSpaces(CmdLine);
2099
2100 Status = ShellSubstituteAliases(CmdLine);
2101 if (EFI_ERROR(Status)) {
2102 return (Status);
2103 }
2104
2105 TrimSpaces(CmdLine);
2106
2107 Status = ShellSubstituteVariables(CmdLine);
2108 if (EFI_ERROR(Status)) {
2109 return (Status);
2110 }
2111 ASSERT (*CmdLine != NULL);
2112
2113 TrimSpaces(CmdLine);
2114
2115 //
2116 // update for help parsing
2117 //
2118 if (StrStr(*CmdLine, L"?") != NULL) {
2119 //
2120 // This may do nothing if the ? does not indicate help.
2121 // Save all the details for in the API below.
2122 //
2123 Status = DoHelpUpdate(CmdLine);
2124 }
2125
2126 TrimSpaces(CmdLine);
2127
2128 return (EFI_SUCCESS);
2129 }
2130
2131 /**
2132 Run an internal shell command.
2133
2134 This API will upadate the shell's environment since these commands are libraries.
2135
2136 @param[in] CmdLine the command line to run.
2137 @param[in] FirstParameter the first parameter on the command line
2138 @param[in] ParamProtocol the shell parameters protocol pointer
2139
2140 @retval EFI_SUCCESS The command was completed.
2141 @retval EFI_ABORTED The command's operation was aborted.
2142 **/
2143 EFI_STATUS
2144 EFIAPI
2145 RunInternalCommand(
2146 IN CONST CHAR16 *CmdLine,
2147 IN CHAR16 *FirstParameter,
2148 IN EFI_SHELL_PARAMETERS_PROTOCOL *ParamProtocol
2149 )
2150 {
2151 EFI_STATUS Status;
2152 UINTN Argc;
2153 CHAR16 **Argv;
2154 SHELL_STATUS CommandReturnedStatus;
2155 BOOLEAN LastError;
2156 CHAR16 *Walker;
2157 CHAR16 *NewCmdLine;
2158
2159 NewCmdLine = AllocateCopyPool (StrSize (CmdLine), CmdLine);
2160 if (NewCmdLine == NULL) {
2161 return EFI_OUT_OF_RESOURCES;
2162 }
2163
2164 for (Walker = NewCmdLine; Walker != NULL && *Walker != CHAR_NULL ; Walker++) {
2165 if (*Walker == L'^' && *(Walker+1) == L'#') {
2166 CopyMem(Walker, Walker+1, StrSize(Walker) - sizeof(Walker[0]));
2167 }
2168 }
2169
2170 //
2171 // get the argc and argv updated for internal commands
2172 //
2173 Status = UpdateArgcArgv(ParamProtocol, NewCmdLine, &Argv, &Argc);
2174 if (!EFI_ERROR(Status)) {
2175 //
2176 // Run the internal command.
2177 //
2178 Status = ShellCommandRunCommandHandler(FirstParameter, &CommandReturnedStatus, &LastError);
2179
2180 if (!EFI_ERROR(Status)) {
2181 //
2182 // Update last error status.
2183 // some commands do not update last error.
2184 //
2185 if (LastError) {
2186 SetLastError(CommandReturnedStatus);
2187 }
2188
2189 //
2190 // Pass thru the exitcode from the app.
2191 //
2192 if (ShellCommandGetExit()) {
2193 //
2194 // An Exit was requested ("exit" command), pass its value up.
2195 //
2196 Status = CommandReturnedStatus;
2197 } else if (CommandReturnedStatus != SHELL_SUCCESS && IsScriptOnlyCommand(FirstParameter)) {
2198 //
2199 // Always abort when a script only command fails for any reason
2200 //
2201 Status = EFI_ABORTED;
2202 } else if (ShellCommandGetCurrentScriptFile() != NULL && CommandReturnedStatus == SHELL_ABORTED) {
2203 //
2204 // Abort when in a script and a command aborted
2205 //
2206 Status = EFI_ABORTED;
2207 }
2208 }
2209 }
2210
2211 //
2212 // This is guarenteed to be called after UpdateArgcArgv no matter what else happened.
2213 // This is safe even if the update API failed. In this case, it may be a no-op.
2214 //
2215 RestoreArgcArgv(ParamProtocol, &Argv, &Argc);
2216
2217 //
2218 // If a script is running and the command is not a scipt only command, then
2219 // change return value to success so the script won't halt (unless aborted).
2220 //
2221 // Script only commands have to be able halt the script since the script will
2222 // not operate if they are failing.
2223 //
2224 if ( ShellCommandGetCurrentScriptFile() != NULL
2225 && !IsScriptOnlyCommand(FirstParameter)
2226 && Status != EFI_ABORTED
2227 ) {
2228 Status = EFI_SUCCESS;
2229 }
2230
2231 FreePool (NewCmdLine);
2232 return (Status);
2233 }
2234
2235 /**
2236 Function to run the command or file.
2237
2238 @param[in] Type the type of operation being run.
2239 @param[in] CmdLine the command line to run.
2240 @param[in] FirstParameter the first parameter on the command line
2241 @param[in] ParamProtocol the shell parameters protocol pointer
2242
2243 @retval EFI_SUCCESS The command was completed.
2244 @retval EFI_ABORTED The command's operation was aborted.
2245 **/
2246 EFI_STATUS
2247 EFIAPI
2248 RunCommandOrFile(
2249 IN SHELL_OPERATION_TYPES Type,
2250 IN CONST CHAR16 *CmdLine,
2251 IN CHAR16 *FirstParameter,
2252 IN EFI_SHELL_PARAMETERS_PROTOCOL *ParamProtocol
2253 )
2254 {
2255 EFI_STATUS Status;
2256 EFI_STATUS StartStatus;
2257 CHAR16 *CommandWithPath;
2258 EFI_DEVICE_PATH_PROTOCOL *DevPath;
2259 SHELL_STATUS CalleeExitStatus;
2260
2261 Status = EFI_SUCCESS;
2262 CommandWithPath = NULL;
2263 DevPath = NULL;
2264 CalleeExitStatus = SHELL_INVALID_PARAMETER;
2265
2266 switch (Type) {
2267 case Internal_Command:
2268 Status = RunInternalCommand(CmdLine, FirstParameter, ParamProtocol);
2269 break;
2270 case Script_File_Name:
2271 case Efi_Application:
2272 //
2273 // Process a fully qualified path
2274 //
2275 if (StrStr(FirstParameter, L":") != NULL) {
2276 ASSERT (CommandWithPath == NULL);
2277 if (ShellIsFile(FirstParameter) == EFI_SUCCESS) {
2278 CommandWithPath = StrnCatGrow(&CommandWithPath, NULL, FirstParameter, 0);
2279 }
2280 }
2281
2282 //
2283 // Process a relative path and also check in the path environment variable
2284 //
2285 if (CommandWithPath == NULL) {
2286 CommandWithPath = ShellFindFilePathEx(FirstParameter, mExecutableExtensions);
2287 }
2288
2289 //
2290 // This should be impossible now.
2291 //
2292 ASSERT(CommandWithPath != NULL);
2293
2294 //
2295 // Make sure that path is not just a directory (or not found)
2296 //
2297 if (!EFI_ERROR(ShellIsDirectory(CommandWithPath))) {
2298 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_NOT_FOUND), ShellInfoObject.HiiHandle, FirstParameter);
2299 SetLastError(SHELL_NOT_FOUND);
2300 }
2301 switch (Type) {
2302 case Script_File_Name:
2303 Status = RunScriptFile (CommandWithPath, NULL, CmdLine, ParamProtocol);
2304 break;
2305 case Efi_Application:
2306 //
2307 // Get the device path of the application image
2308 //
2309 DevPath = ShellInfoObject.NewEfiShellProtocol->GetDevicePathFromFilePath(CommandWithPath);
2310 if (DevPath == NULL){
2311 Status = EFI_OUT_OF_RESOURCES;
2312 break;
2313 }
2314
2315 //
2316 // Execute the device path
2317 //
2318 Status = InternalShellExecuteDevicePath(
2319 &gImageHandle,
2320 DevPath,
2321 CmdLine,
2322 NULL,
2323 &StartStatus
2324 );
2325
2326 SHELL_FREE_NON_NULL(DevPath);
2327
2328 if(EFI_ERROR (Status)) {
2329 CalleeExitStatus = (SHELL_STATUS) (Status & (~MAX_BIT));
2330 } else {
2331 CalleeExitStatus = (SHELL_STATUS) StartStatus;
2332 }
2333
2334 //
2335 // Update last error status.
2336 //
2337 // Status is an EFI_STATUS. Clear top bit to convert to SHELL_STATUS
2338 SetLastError(CalleeExitStatus);
2339 break;
2340 default:
2341 //
2342 // Do nothing.
2343 //
2344 break;
2345 }
2346 break;
2347 default:
2348 //
2349 // Do nothing.
2350 //
2351 break;
2352 }
2353
2354 SHELL_FREE_NON_NULL(CommandWithPath);
2355
2356 return (Status);
2357 }
2358
2359 /**
2360 Function to setup StdIn, StdErr, StdOut, and then run the command or file.
2361
2362 @param[in] Type the type of operation being run.
2363 @param[in] CmdLine the command line to run.
2364 @param[in] FirstParameter the first parameter on the command line.
2365 @param[in] ParamProtocol the shell parameters protocol pointer
2366
2367 @retval EFI_SUCCESS The command was completed.
2368 @retval EFI_ABORTED The command's operation was aborted.
2369 **/
2370 EFI_STATUS
2371 EFIAPI
2372 SetupAndRunCommandOrFile(
2373 IN SHELL_OPERATION_TYPES Type,
2374 IN CHAR16 *CmdLine,
2375 IN CHAR16 *FirstParameter,
2376 IN EFI_SHELL_PARAMETERS_PROTOCOL *ParamProtocol
2377 )
2378 {
2379 EFI_STATUS Status;
2380 SHELL_FILE_HANDLE OriginalStdIn;
2381 SHELL_FILE_HANDLE OriginalStdOut;
2382 SHELL_FILE_HANDLE OriginalStdErr;
2383 SYSTEM_TABLE_INFO OriginalSystemTableInfo;
2384
2385 //
2386 // Update the StdIn, StdOut, and StdErr for redirection to environment variables, files, etc... unicode and ASCII
2387 //
2388 Status = UpdateStdInStdOutStdErr(ParamProtocol, CmdLine, &OriginalStdIn, &OriginalStdOut, &OriginalStdErr, &OriginalSystemTableInfo);
2389
2390 //
2391 // The StdIn, StdOut, and StdErr are set up.
2392 // Now run the command, script, or application
2393 //
2394 if (!EFI_ERROR(Status)) {
2395 TrimSpaces(&CmdLine);
2396 Status = RunCommandOrFile(Type, CmdLine, FirstParameter, ParamProtocol);
2397 }
2398
2399 //
2400 // Now print errors
2401 //
2402 if (EFI_ERROR(Status)) {
2403 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_ERROR), ShellInfoObject.HiiHandle, (VOID*)(Status));
2404 }
2405
2406 //
2407 // put back the original StdIn, StdOut, and StdErr
2408 //
2409 RestoreStdInStdOutStdErr(ParamProtocol, &OriginalStdIn, &OriginalStdOut, &OriginalStdErr, &OriginalSystemTableInfo);
2410
2411 return (Status);
2412 }
2413
2414 /**
2415 Function will process and run a command line.
2416
2417 This will determine if the command line represents an internal shell
2418 command or dispatch an external application.
2419
2420 @param[in] CmdLine The command line to parse.
2421
2422 @retval EFI_SUCCESS The command was completed.
2423 @retval EFI_ABORTED The command's operation was aborted.
2424 **/
2425 EFI_STATUS
2426 EFIAPI
2427 RunCommand(
2428 IN CONST CHAR16 *CmdLine
2429 )
2430 {
2431 EFI_STATUS Status;
2432 CHAR16 *CleanOriginal;
2433 CHAR16 *FirstParameter;
2434 CHAR16 *TempWalker;
2435 SHELL_OPERATION_TYPES Type;
2436
2437 ASSERT(CmdLine != NULL);
2438 if (StrLen(CmdLine) == 0) {
2439 return (EFI_SUCCESS);
2440 }
2441
2442 Status = EFI_SUCCESS;
2443 CleanOriginal = NULL;
2444
2445 CleanOriginal = StrnCatGrow(&CleanOriginal, NULL, CmdLine, 0);
2446 if (CleanOriginal == NULL) {
2447 return (EFI_OUT_OF_RESOURCES);
2448 }
2449
2450 TrimSpaces(&CleanOriginal);
2451
2452 //
2453 // NULL out comments (leveraged from RunScriptFileHandle() ).
2454 // The # character on a line is used to denote that all characters on the same line
2455 // and to the right of the # are to be ignored by the shell.
2456 // Afterward, again remove spaces, in case any were between the last command-parameter and '#'.
2457 //
2458 for (TempWalker = CleanOriginal; TempWalker != NULL && *TempWalker != CHAR_NULL; TempWalker++) {
2459 if (*TempWalker == L'^') {
2460 if (*(TempWalker + 1) == L'#') {
2461 TempWalker++;
2462 }
2463 } else if (*TempWalker == L'#') {
2464 *TempWalker = CHAR_NULL;
2465 }
2466 }
2467
2468 TrimSpaces(&CleanOriginal);
2469
2470 //
2471 // Handle case that passed in command line is just 1 or more " " characters.
2472 //
2473 if (StrLen (CleanOriginal) == 0) {
2474 SHELL_FREE_NON_NULL(CleanOriginal);
2475 return (EFI_SUCCESS);
2476 }
2477
2478 Status = ProcessCommandLineToFinal(&CleanOriginal);
2479 if (EFI_ERROR(Status)) {
2480 SHELL_FREE_NON_NULL(CleanOriginal);
2481 return (Status);
2482 }
2483
2484 //
2485 // We dont do normal processing with a split command line (output from one command input to another)
2486 //
2487 if (ContainsSplit(CleanOriginal)) {
2488 Status = ProcessNewSplitCommandLine(CleanOriginal);
2489 SHELL_FREE_NON_NULL(CleanOriginal);
2490 return (Status);
2491 }
2492
2493 //
2494 // We need the first parameter information so we can determine the operation type
2495 //
2496 FirstParameter = AllocateZeroPool(StrSize(CleanOriginal));
2497 if (FirstParameter == NULL) {
2498 SHELL_FREE_NON_NULL(CleanOriginal);
2499 return (EFI_OUT_OF_RESOURCES);
2500 }
2501 TempWalker = CleanOriginal;
2502 GetNextParameter(&TempWalker, &FirstParameter, StrSize(CleanOriginal));
2503
2504 //
2505 // Depending on the first parameter we change the behavior
2506 //
2507 switch (Type = GetOperationType(FirstParameter)) {
2508 case File_Sys_Change:
2509 Status = ChangeMappedDrive (FirstParameter);
2510 break;
2511 case Internal_Command:
2512 case Script_File_Name:
2513 case Efi_Application:
2514 Status = SetupAndRunCommandOrFile(Type, CleanOriginal, FirstParameter, ShellInfoObject.NewShellParametersProtocol);
2515 break;
2516 default:
2517 //
2518 // Whatever was typed, it was invalid.
2519 //
2520 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_NOT_FOUND), ShellInfoObject.HiiHandle, FirstParameter);
2521 SetLastError(SHELL_NOT_FOUND);
2522 break;
2523 }
2524
2525 SHELL_FREE_NON_NULL(CleanOriginal);
2526 SHELL_FREE_NON_NULL(FirstParameter);
2527
2528 return (Status);
2529 }
2530
2531 STATIC CONST UINT16 InvalidChars[] = {L'*', L'?', L'<', L'>', L'\\', L'/', L'\"', 0x0001, 0x0002};
2532 /**
2533 Function determins if the CommandName COULD be a valid command. It does not determine whether
2534 this is a valid command. It only checks for invalid characters.
2535
2536 @param[in] CommandName The name to check
2537
2538 @retval TRUE CommandName could be a command name
2539 @retval FALSE CommandName could not be a valid command name
2540 **/
2541 BOOLEAN
2542 EFIAPI
2543 IsValidCommandName(
2544 IN CONST CHAR16 *CommandName
2545 )
2546 {
2547 UINTN Count;
2548 if (CommandName == NULL) {
2549 ASSERT(FALSE);
2550 return (FALSE);
2551 }
2552 for ( Count = 0
2553 ; Count < sizeof(InvalidChars) / sizeof(InvalidChars[0])
2554 ; Count++
2555 ){
2556 if (ScanMem16(CommandName, StrSize(CommandName), InvalidChars[Count]) != NULL) {
2557 return (FALSE);
2558 }
2559 }
2560 return (TRUE);
2561 }
2562
2563 /**
2564 Function to process a NSH script file via SHELL_FILE_HANDLE.
2565
2566 @param[in] Handle The handle to the already opened file.
2567 @param[in] Name The name of the script file.
2568
2569 @retval EFI_SUCCESS the script completed sucessfully
2570 **/
2571 EFI_STATUS
2572 EFIAPI
2573 RunScriptFileHandle (
2574 IN SHELL_FILE_HANDLE Handle,
2575 IN CONST CHAR16 *Name
2576 )
2577 {
2578 EFI_STATUS Status;
2579 SCRIPT_FILE *NewScriptFile;
2580 UINTN LoopVar;
2581 CHAR16 *CommandLine;
2582 CHAR16 *CommandLine2;
2583 CHAR16 *CommandLine3;
2584 SCRIPT_COMMAND_LIST *LastCommand;
2585 BOOLEAN Ascii;
2586 BOOLEAN PreScriptEchoState;
2587 BOOLEAN PreCommandEchoState;
2588 CONST CHAR16 *CurDir;
2589 UINTN LineCount;
2590 CHAR16 LeString[50];
2591
2592 ASSERT(!ShellCommandGetScriptExit());
2593
2594 PreScriptEchoState = ShellCommandGetEchoState();
2595
2596 NewScriptFile = (SCRIPT_FILE*)AllocateZeroPool(sizeof(SCRIPT_FILE));
2597 if (NewScriptFile == NULL) {
2598 return (EFI_OUT_OF_RESOURCES);
2599 }
2600
2601 //
2602 // Set up the name
2603 //
2604 ASSERT(NewScriptFile->ScriptName == NULL);
2605 NewScriptFile->ScriptName = StrnCatGrow(&NewScriptFile->ScriptName, NULL, Name, 0);
2606 if (NewScriptFile->ScriptName == NULL) {
2607 DeleteScriptFileStruct(NewScriptFile);
2608 return (EFI_OUT_OF_RESOURCES);
2609 }
2610
2611 //
2612 // Save the parameters (used to replace %0 to %9 later on)
2613 //
2614 NewScriptFile->Argc = ShellInfoObject.NewShellParametersProtocol->Argc;
2615 if (NewScriptFile->Argc != 0) {
2616 NewScriptFile->Argv = (CHAR16**)AllocateZeroPool(NewScriptFile->Argc * sizeof(CHAR16*));
2617 if (NewScriptFile->Argv == NULL) {
2618 DeleteScriptFileStruct(NewScriptFile);
2619 return (EFI_OUT_OF_RESOURCES);
2620 }
2621 for (LoopVar = 0 ; LoopVar < 10 && LoopVar < NewScriptFile->Argc; LoopVar++) {
2622 ASSERT(NewScriptFile->Argv[LoopVar] == NULL);
2623 NewScriptFile->Argv[LoopVar] = StrnCatGrow(&NewScriptFile->Argv[LoopVar], NULL, ShellInfoObject.NewShellParametersProtocol->Argv[LoopVar], 0);
2624 if (NewScriptFile->Argv[LoopVar] == NULL) {
2625 DeleteScriptFileStruct(NewScriptFile);
2626 return (EFI_OUT_OF_RESOURCES);
2627 }
2628 }
2629 } else {
2630 NewScriptFile->Argv = NULL;
2631 }
2632
2633 InitializeListHead(&NewScriptFile->CommandList);
2634 InitializeListHead(&NewScriptFile->SubstList);
2635
2636 //
2637 // Now build the list of all script commands.
2638 //
2639 LineCount = 0;
2640 while(!ShellFileHandleEof(Handle)) {
2641 CommandLine = ShellFileHandleReturnLine(Handle, &Ascii);
2642 LineCount++;
2643 if (CommandLine == NULL || StrLen(CommandLine) == 0 || CommandLine[0] == '#') {
2644 SHELL_FREE_NON_NULL(CommandLine);
2645 continue;
2646 }
2647 NewScriptFile->CurrentCommand = AllocateZeroPool(sizeof(SCRIPT_COMMAND_LIST));
2648 if (NewScriptFile->CurrentCommand == NULL) {
2649 SHELL_FREE_NON_NULL(CommandLine);
2650 DeleteScriptFileStruct(NewScriptFile);
2651 return (EFI_OUT_OF_RESOURCES);
2652 }
2653
2654 NewScriptFile->CurrentCommand->Cl = CommandLine;
2655 NewScriptFile->CurrentCommand->Data = NULL;
2656 NewScriptFile->CurrentCommand->Line = LineCount;
2657
2658 InsertTailList(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link);
2659 }
2660
2661 //
2662 // Add this as the topmost script file
2663 //
2664 ShellCommandSetNewScript (NewScriptFile);
2665
2666 //
2667 // Now enumerate through the commands and run each one.
2668 //
2669 CommandLine = AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize));
2670 if (CommandLine == NULL) {
2671 DeleteScriptFileStruct(NewScriptFile);
2672 return (EFI_OUT_OF_RESOURCES);
2673 }
2674 CommandLine2 = AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize));
2675 if (CommandLine2 == NULL) {
2676 FreePool(CommandLine);
2677 DeleteScriptFileStruct(NewScriptFile);
2678 return (EFI_OUT_OF_RESOURCES);
2679 }
2680
2681 for ( NewScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)GetFirstNode(&NewScriptFile->CommandList)
2682 ; !IsNull(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link)
2683 ; // conditional increment in the body of the loop
2684 ){
2685 ASSERT(CommandLine2 != NULL);
2686 StrnCpy(CommandLine2, NewScriptFile->CurrentCommand->Cl, PcdGet16(PcdShellPrintBufferSize)/sizeof(CHAR16)-1);
2687
2688 //
2689 // NULL out comments
2690 //
2691 for (CommandLine3 = CommandLine2 ; CommandLine3 != NULL && *CommandLine3 != CHAR_NULL ; CommandLine3++) {
2692 if (*CommandLine3 == L'^') {
2693 if ( *(CommandLine3+1) == L':') {
2694 CopyMem(CommandLine3, CommandLine3+1, StrSize(CommandLine3) - sizeof(CommandLine3[0]));
2695 } else if (*(CommandLine3+1) == L'#') {
2696 CommandLine3++;
2697 }
2698 } else if (*CommandLine3 == L'#') {
2699 *CommandLine3 = CHAR_NULL;
2700 }
2701 }
2702
2703 if (CommandLine2 != NULL && StrLen(CommandLine2) >= 1) {
2704 //
2705 // Due to variability in starting the find and replace action we need to have both buffers the same.
2706 //
2707 StrnCpy(CommandLine, CommandLine2, PcdGet16(PcdShellPrintBufferSize)/sizeof(CHAR16)-1);
2708
2709 //
2710 // Remove the %0 to %9 from the command line (if we have some arguments)
2711 //
2712 if (NewScriptFile->Argv != NULL) {
2713 switch (NewScriptFile->Argc) {
2714 default:
2715 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%9", NewScriptFile->Argv[9], FALSE, FALSE);
2716 ASSERT_EFI_ERROR(Status);
2717 case 9:
2718 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%8", NewScriptFile->Argv[8], FALSE, FALSE);
2719 ASSERT_EFI_ERROR(Status);
2720 case 8:
2721 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%7", NewScriptFile->Argv[7], FALSE, FALSE);
2722 ASSERT_EFI_ERROR(Status);
2723 case 7:
2724 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%6", NewScriptFile->Argv[6], FALSE, FALSE);
2725 ASSERT_EFI_ERROR(Status);
2726 case 6:
2727 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%5", NewScriptFile->Argv[5], FALSE, FALSE);
2728 ASSERT_EFI_ERROR(Status);
2729 case 5:
2730 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%4", NewScriptFile->Argv[4], FALSE, FALSE);
2731 ASSERT_EFI_ERROR(Status);
2732 case 4:
2733 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%3", NewScriptFile->Argv[3], FALSE, FALSE);
2734 ASSERT_EFI_ERROR(Status);
2735 case 3:
2736 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%2", NewScriptFile->Argv[2], FALSE, FALSE);
2737 ASSERT_EFI_ERROR(Status);
2738 case 2:
2739 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%1", NewScriptFile->Argv[1], FALSE, FALSE);
2740 ASSERT_EFI_ERROR(Status);
2741 case 1:
2742 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%0", NewScriptFile->Argv[0], FALSE, FALSE);
2743 ASSERT_EFI_ERROR(Status);
2744 break;
2745 case 0:
2746 break;
2747 }
2748 }
2749 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%1", L"\"\"", FALSE, FALSE);
2750 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%2", L"\"\"", FALSE, FALSE);
2751 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%3", L"\"\"", FALSE, FALSE);
2752 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%4", L"\"\"", FALSE, FALSE);
2753 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%5", L"\"\"", FALSE, FALSE);
2754 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%6", L"\"\"", FALSE, FALSE);
2755 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%7", L"\"\"", FALSE, FALSE);
2756 Status = ShellCopySearchAndReplace(CommandLine, CommandLine2, PcdGet16 (PcdShellPrintBufferSize), L"%8", L"\"\"", FALSE, FALSE);
2757 Status = ShellCopySearchAndReplace(CommandLine2, CommandLine, PcdGet16 (PcdShellPrintBufferSize), L"%9", L"\"\"", FALSE, FALSE);
2758
2759 StrnCpy(CommandLine2, CommandLine, PcdGet16(PcdShellPrintBufferSize)/sizeof(CHAR16)-1);
2760
2761 LastCommand = NewScriptFile->CurrentCommand;
2762
2763 for (CommandLine3 = CommandLine2 ; CommandLine3[0] == L' ' ; CommandLine3++);
2764
2765 if (CommandLine3 != NULL && CommandLine3[0] == L':' ) {
2766 //
2767 // This line is a goto target / label
2768 //
2769 } else {
2770 if (CommandLine3 != NULL && StrLen(CommandLine3) > 0) {
2771 if (CommandLine3[0] == L'@') {
2772 //
2773 // We need to save the current echo state
2774 // and disable echo for just this command.
2775 //
2776 PreCommandEchoState = ShellCommandGetEchoState();
2777 ShellCommandSetEchoState(FALSE);
2778 Status = RunCommand(CommandLine3+1);
2779
2780 //
2781 // If command was "@echo -off" or "@echo -on" then don't restore echo state
2782 //
2783 if (StrCmp (L"@echo -off", CommandLine3) != 0 &&
2784 StrCmp (L"@echo -on", CommandLine3) != 0) {
2785 //
2786 // Now restore the pre-'@' echo state.
2787 //
2788 ShellCommandSetEchoState(PreCommandEchoState);
2789 }
2790 } else {
2791 if (ShellCommandGetEchoState()) {
2792 CurDir = ShellInfoObject.NewEfiShellProtocol->GetEnv(L"cwd");
2793 if (CurDir != NULL && StrLen(CurDir) > 1) {
2794 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_CURDIR), ShellInfoObject.HiiHandle, CurDir);
2795 } else {
2796 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_SHELL), ShellInfoObject.HiiHandle);
2797 }
2798 ShellPrintEx(-1, -1, L"%s\r\n", CommandLine2);
2799 }
2800 Status = RunCommand(CommandLine3);
2801 }
2802 }
2803
2804 if (ShellCommandGetScriptExit()) {
2805 //
2806 // ShellCommandGetExitCode() always returns a UINT64
2807 //
2808 UnicodeSPrint(LeString, sizeof(LeString), L"0x%Lx", ShellCommandGetExitCode());
2809 DEBUG_CODE(InternalEfiShellSetEnv(L"debuglasterror", LeString, TRUE););
2810 InternalEfiShellSetEnv(L"lasterror", LeString, TRUE);
2811
2812 ShellCommandRegisterExit(FALSE, 0);
2813 Status = EFI_SUCCESS;
2814 break;
2815 }
2816 if (ShellGetExecutionBreakFlag()) {
2817 break;
2818 }
2819 if (EFI_ERROR(Status)) {
2820 break;
2821 }
2822 if (ShellCommandGetExit()) {
2823 break;
2824 }
2825 }
2826 //
2827 // If that commend did not update the CurrentCommand then we need to advance it...
2828 //
2829 if (LastCommand == NewScriptFile->CurrentCommand) {
2830 NewScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)GetNextNode(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link);
2831 if (!IsNull(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link)) {
2832 NewScriptFile->CurrentCommand->Reset = TRUE;
2833 }
2834 }
2835 } else {
2836 NewScriptFile->CurrentCommand = (SCRIPT_COMMAND_LIST *)GetNextNode(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link);
2837 if (!IsNull(&NewScriptFile->CommandList, &NewScriptFile->CurrentCommand->Link)) {
2838 NewScriptFile->CurrentCommand->Reset = TRUE;
2839 }
2840 }
2841 }
2842
2843
2844 FreePool(CommandLine);
2845 FreePool(CommandLine2);
2846 ShellCommandSetNewScript (NULL);
2847
2848 //
2849 // Only if this was the last script reset the state.
2850 //
2851 if (ShellCommandGetCurrentScriptFile()==NULL) {
2852 ShellCommandSetEchoState(PreScriptEchoState);
2853 }
2854 return (EFI_SUCCESS);
2855 }
2856
2857 /**
2858 Function to process a NSH script file.
2859
2860 @param[in] ScriptPath Pointer to the script file name (including file system path).
2861 @param[in] Handle the handle of the script file already opened.
2862 @param[in] CmdLine the command line to run.
2863 @param[in] ParamProtocol the shell parameters protocol pointer
2864
2865 @retval EFI_SUCCESS the script completed sucessfully
2866 **/
2867 EFI_STATUS
2868 EFIAPI
2869 RunScriptFile (
2870 IN CONST CHAR16 *ScriptPath,
2871 IN SHELL_FILE_HANDLE Handle OPTIONAL,
2872 IN CONST CHAR16 *CmdLine,
2873 IN EFI_SHELL_PARAMETERS_PROTOCOL *ParamProtocol
2874 )
2875 {
2876 EFI_STATUS Status;
2877 SHELL_FILE_HANDLE FileHandle;
2878 UINTN Argc;
2879 CHAR16 **Argv;
2880
2881 if (ShellIsFile(ScriptPath) != EFI_SUCCESS) {
2882 return (EFI_INVALID_PARAMETER);
2883 }
2884
2885 //
2886 // get the argc and argv updated for scripts
2887 //
2888 Status = UpdateArgcArgv(ParamProtocol, CmdLine, &Argv, &Argc);
2889 if (!EFI_ERROR(Status)) {
2890
2891 if (Handle == NULL) {
2892 //
2893 // open the file
2894 //
2895 Status = ShellOpenFileByName(ScriptPath, &FileHandle, EFI_FILE_MODE_READ, 0);
2896 if (!EFI_ERROR(Status)) {
2897 //
2898 // run it
2899 //
2900 Status = RunScriptFileHandle(FileHandle, ScriptPath);
2901
2902 //
2903 // now close the file
2904 //
2905 ShellCloseFile(&FileHandle);
2906 }
2907 } else {
2908 Status = RunScriptFileHandle(Handle, ScriptPath);
2909 }
2910 }
2911
2912 //
2913 // This is guarenteed to be called after UpdateArgcArgv no matter what else happened.
2914 // This is safe even if the update API failed. In this case, it may be a no-op.
2915 //
2916 RestoreArgcArgv(ParamProtocol, &Argv, &Argc);
2917
2918 return (Status);
2919 }