]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
update functionality on Bcfg command.
[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / Ls.c
CommitLineData
a405b86d 1/** @file\r
2 Main file for ls shell level 2 function.\r
3\r
4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "UefiShellLevel2CommandsLib.h"\r
16#include <Guid/FileSystemInfo.h>\r
17\r
18/**\r
19 print out the list of files and directories from the LS command\r
20\r
21 @param[in] Rec TRUE to automatically recurse into each found directory\r
22 FALSE to only list the specified directory.\r
23 @param[in] Attribs List of required Attribute for display.\r
24 If 0 then all non-system and non-hidden files will be printed.\r
25 @param[in] Sfo TRUE to use Standard Format Output, FALSE otherwise\r
26 @param[in] Path String with starting path.\r
27 @param[in] First TRUE for the original and FALSE for any recursion spawned instances.\r
28 @param[in] Count The count of bits enabled in Attribs.\r
29 @param[in] TimeZone The current time zone offset.\r
30\r
31 @retval SHELL_SUCCESS the printing was sucessful.\r
32**/\r
33SHELL_STATUS\r
34EFIAPI\r
35PrintLsOutput(\r
36 IN CONST BOOLEAN Rec,\r
37 IN CONST UINT64 Attribs,\r
38 IN CONST BOOLEAN Sfo,\r
39 IN CONST CHAR16 *Path,\r
40 IN CONST BOOLEAN First,\r
41 IN CONST UINTN Count,\r
42 IN CONST INT16 TimeZone\r
43 )\r
44{\r
45 EFI_STATUS Status;\r
46 EFI_SHELL_FILE_INFO *ListHead;\r
47 EFI_SHELL_FILE_INFO *Node;\r
48 SHELL_STATUS ShellStatus;\r
49 UINT64 FileCount;\r
50 UINT64 DirCount;\r
51 UINT64 FileSize;\r
52 CHAR16 *DirectoryName;\r
53 UINTN LongestPath;\r
54 EFI_FILE_SYSTEM_INFO *SysInfo;\r
55 UINTN SysInfoSize;\r
56 SHELL_FILE_HANDLE ShellFileHandle;\r
57 CHAR16 *CorrectedPath;\r
58 EFI_FILE_PROTOCOL *EfiFpHandle;\r
59\r
60 FileCount = 0;\r
61 DirCount = 0;\r
62 FileSize = 0;\r
63 ListHead = NULL;\r
64 ShellStatus = SHELL_SUCCESS;\r
65 LongestPath = 0;\r
66 CorrectedPath = NULL;\r
67\r
68 CorrectedPath = StrnCatGrow(&CorrectedPath, NULL, Path, 0);\r
69 ASSERT(CorrectedPath != NULL);\r
70 ShellCommandCleanPath(CorrectedPath);\r
71\r
72 Status = ShellOpenFileMetaArg((CHAR16*)CorrectedPath, EFI_FILE_MODE_READ, &ListHead);\r
73 if (EFI_ERROR(Status)) {\r
74 return (SHELL_DEVICE_ERROR);\r
75 }\r
76 if (ListHead == NULL || IsListEmpty(&ListHead->Link)) {\r
77 //\r
78 // On the first one only we expect to find something...\r
79 // do we find the . and .. directories otherwise?\r
80 //\r
81 if (First) {\r
82 return (SHELL_NOT_FOUND);\r
83 }\r
84 return (SHELL_SUCCESS);\r
85 }\r
86\r
87 if (Sfo && First) {\r
88 //\r
89 // Get the first valid handle (directories)\r
90 //\r
91 for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)\r
92 ; !IsNull(&ListHead->Link, &Node->Link) && Node->Handle == NULL\r
93 ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)\r
94 );\r
95\r
96 if (Node->Handle == NULL) {\r
97 DirectoryName = GetFullyQualifiedPath(((EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link))->FullName);\r
98\r
99 //\r
100 // We need to open something up to get system information\r
101 //\r
102 Status = gEfiShellProtocol->OpenFileByName(\r
103 DirectoryName,\r
104 &ShellFileHandle,\r
105 EFI_FILE_MODE_READ);\r
106\r
107 ASSERT_EFI_ERROR(Status);\r
108 FreePool(DirectoryName);\r
109\r
110 //\r
111 // Get the Volume Info from ShellFileHandle\r
112 //\r
113 SysInfo = NULL;\r
114 SysInfoSize = 0;\r
115 EfiFpHandle = ConvertShellHandleToEfiFileProtocol(ShellFileHandle);\r
116 Status = EfiFpHandle->GetInfo(\r
117 EfiFpHandle,\r
118 &gEfiFileSystemInfoGuid,\r
119 &SysInfoSize,\r
120 SysInfo);\r
121\r
122 if (Status == EFI_BUFFER_TOO_SMALL) {\r
123 SysInfo = AllocateZeroPool(SysInfoSize);\r
124 Status = EfiFpHandle->GetInfo(\r
125 EfiFpHandle,\r
126 &gEfiFileSystemInfoGuid,\r
127 &SysInfoSize,\r
128 SysInfo);\r
129 }\r
130\r
131 ASSERT_EFI_ERROR(Status);\r
132\r
133 gEfiShellProtocol->CloseFile(ShellFileHandle);\r
134 } else {\r
135 //\r
136 // Get the Volume Info from Node->Handle\r
137 //\r
138 SysInfo = NULL;\r
139 SysInfoSize = 0;\r
140 EfiFpHandle = ConvertShellHandleToEfiFileProtocol(Node->Handle);\r
141 Status = EfiFpHandle->GetInfo(\r
142 EfiFpHandle,\r
143 &gEfiFileSystemInfoGuid,\r
144 &SysInfoSize,\r
145 SysInfo);\r
146\r
147 if (Status == EFI_BUFFER_TOO_SMALL) {\r
148 SysInfo = AllocateZeroPool(SysInfoSize);\r
149 Status = EfiFpHandle->GetInfo(\r
150 EfiFpHandle,\r
151 &gEfiFileSystemInfoGuid,\r
152 &SysInfoSize,\r
153 SysInfo);\r
154 }\r
155\r
156 ASSERT_EFI_ERROR(Status);\r
157 }\r
158\r
159 ShellPrintHiiEx (\r
160 -1,\r
161 -1,\r
162 NULL,\r
163 STRING_TOKEN (STR_GEN_SFO_HEADER),\r
164 gShellLevel2HiiHandle,\r
165 L"ls");\r
166 //\r
167 // print VolumeInfo table\r
168 //\r
169 ASSERT(SysInfo != NULL);\r
170 ShellPrintHiiEx (\r
171 0,\r
172 gST->ConOut->Mode->CursorRow,\r
173 NULL,\r
174 STRING_TOKEN (STR_LS_SFO_VOLINFO),\r
175 gShellLevel2HiiHandle,\r
176 SysInfo->VolumeLabel,\r
177 SysInfo->VolumeSize,\r
178 SysInfo->ReadOnly?L"TRUE":L"FALSE",\r
179 SysInfo->FreeSpace,\r
180 SysInfo->BlockSize\r
181 );\r
182 if (SysInfo != NULL) {\r
183 FreePool(SysInfo);\r
184 }\r
185 }\r
186\r
187 if (!Sfo) {\r
188 //\r
189 // get directory name from path...\r
190 //\r
191 DirectoryName = GetFullyQualifiedPath(CorrectedPath);\r
192\r
193 //\r
194 // print header\r
195 //\r
196 ShellPrintHiiEx (\r
197 0,\r
198 gST->ConOut->Mode->CursorRow,\r
199 NULL,\r
200 STRING_TOKEN (STR_LS_HEADER_LINE1),\r
201 gShellLevel2HiiHandle,\r
202 DirectoryName\r
203 );\r
204 FreePool(DirectoryName);\r
205 }\r
206 for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)\r
207 ; !IsNull(&ListHead->Link, &Node->Link)\r
208 ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)\r
209 ){\r
210 ASSERT(Node != NULL);\r
211 if (LongestPath < StrSize(Node->FullName)) {\r
212 LongestPath = StrSize(Node->FullName);\r
213 }\r
214 ASSERT(Node->Info != NULL);\r
215 ASSERT((Node->Info->Attribute & EFI_FILE_VALID_ATTR) == Node->Info->Attribute);\r
216 if (Attribs == 0) {\r
217 //\r
218 // NOT system & NOT hidden\r
219 //\r
220 if ( (Node->Info->Attribute & EFI_FILE_SYSTEM)\r
221 || (Node->Info->Attribute & EFI_FILE_HIDDEN)\r
222 ){\r
223 continue;\r
224 }\r
225 } else if (Attribs != EFI_FILE_VALID_ATTR) {\r
226 if (Count == 1) {\r
227 //\r
228 // the bit must match\r
229 //\r
230 if ( (Node->Info->Attribute & Attribs) != Attribs) {\r
231 continue;\r
232 }\r
233 } else {\r
234 //\r
235 // exact match on all bits\r
236 //\r
237 if ( Node->Info->Attribute != Attribs) {\r
238 continue;\r
239 }\r
240 }\r
241 }\r
242\r
243 if (Sfo) {\r
244 //\r
245 // Print the FileInfo Table\r
246 //\r
247 ShellPrintHiiEx (\r
248 0,\r
249 gST->ConOut->Mode->CursorRow,\r
250 NULL,\r
251 STRING_TOKEN (STR_LS_SFO_FILEINFO),\r
252 gShellLevel2HiiHandle,\r
253 Node->FullName,\r
254 Node->Info->FileSize,\r
255 Node->Info->PhysicalSize,\r
256 (Node->Info->Attribute & EFI_FILE_ARCHIVE) != 0?L"a":L"",\r
257 (Node->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"d":L"",\r
258 (Node->Info->Attribute & EFI_FILE_HIDDEN) != 0?L"h":L"",\r
259 (Node->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L"r":L"",\r
260 (Node->Info->Attribute & EFI_FILE_SYSTEM) != 0?L"s":L"",\r
261 Node->Info->CreateTime.Hour,\r
262 Node->Info->CreateTime.Minute,\r
263 Node->Info->CreateTime.Second,\r
264 Node->Info->CreateTime.Day,\r
265 Node->Info->CreateTime.Month,\r
266 Node->Info->CreateTime.Year,\r
267 Node->Info->LastAccessTime.Hour,\r
268 Node->Info->LastAccessTime.Minute,\r
269 Node->Info->LastAccessTime.Second,\r
270 Node->Info->LastAccessTime.Day,\r
271 Node->Info->LastAccessTime.Month,\r
272 Node->Info->LastAccessTime.Year,\r
273 Node->Info->ModificationTime.Hour,\r
274 Node->Info->ModificationTime.Minute,\r
275 Node->Info->ModificationTime.Second,\r
276 Node->Info->ModificationTime.Day,\r
277 Node->Info->ModificationTime.Month,\r
278 Node->Info->ModificationTime.Year\r
279 );\r
280 } else {\r
281 //\r
282 // print this one out...\r
283 // first print the universal start, next print the type specific name format, last print the CRLF\r
284 //\r
285 ShellPrintHiiEx (\r
286 -1,\r
287 -1,\r
288 NULL,\r
289 STRING_TOKEN (STR_LS_LINE_START_ALL),\r
290 gShellLevel2HiiHandle,\r
291 &Node->Info->ModificationTime,\r
292 (Node->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"<DIR>":L"",\r
293 (Node->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L'r':L' ',\r
294 Node->Info->FileSize\r
295 );\r
296 if (Node->Info->Attribute & EFI_FILE_DIRECTORY) {\r
297 DirCount++;\r
298 ShellPrintHiiEx (\r
299 -1,\r
300 -1,\r
301 NULL,\r
302 STRING_TOKEN (STR_LS_LINE_END_DIR),\r
303 gShellLevel2HiiHandle,\r
304 Node->FileName\r
305 );\r
306 } else {\r
307 FileCount++;\r
308 FileSize += Node->Info->FileSize;\r
309 if ( (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".nsh", (CHAR16*)&(Node->FileName[StrLen (Node->FileName) - 4])) == 0)\r
310 || (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".efi", (CHAR16*)&(Node->FileName[StrLen (Node->FileName) - 4])) == 0)\r
311 ){\r
312 ShellPrintHiiEx (\r
313 -1,\r
314 -1,\r
315 NULL,\r
316 STRING_TOKEN (STR_LS_LINE_END_EXE),\r
317 gShellLevel2HiiHandle,\r
318 Node->FileName\r
319 );\r
320 } else {\r
321 ShellPrintHiiEx (\r
322 -1,\r
323 -1,\r
324 NULL,\r
325 STRING_TOKEN (STR_LS_LINE_END_FILE),\r
326 gShellLevel2HiiHandle,\r
327 Node->FileName\r
328 );\r
329 }\r
330 }\r
331 }\r
332 }\r
333\r
334 if (!Sfo) {\r
335 //\r
336 // print footer\r
337 //\r
338 ShellPrintHiiEx (\r
339 -1,\r
340 -1,\r
341 NULL,\r
342 STRING_TOKEN (STR_LS_FOOTER_LINE),\r
343 gShellLevel2HiiHandle,\r
344 FileCount,\r
345 FileSize,\r
346 DirCount\r
347 );\r
348 }\r
349\r
350 if (Rec){\r
351 DirectoryName = AllocatePool(LongestPath + 2*sizeof(CHAR16));\r
9ea69f8a 352 if (DirectoryName == NULL) {\r
353 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_MEM), gShellLevel2HiiHandle);\r
354 ShellStatus = SHELL_OUT_OF_RESOURCES;\r
355 } else {\r
356 for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)\r
357 ; !IsNull(&ListHead->Link, &Node->Link)\r
358 ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)\r
359 ){\r
360 //\r
361 // recurse on any directory except the traversing ones...\r
362 //\r
363 if (((Node->Info->Attribute & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY)\r
364 && StrCmp(Node->FileName, L".") != 0\r
365 && StrCmp(Node->FileName, L"..") != 0\r
366 ){\r
367 StrCpy(DirectoryName, Node->FullName);\r
368 StrCat(DirectoryName, L"\\*");\r
369 PrintLsOutput(\r
370 Rec,\r
371 Attribs,\r
372 Sfo,\r
373 DirectoryName,\r
374 FALSE,\r
375 Count,\r
376 TimeZone);\r
377 }\r
a405b86d 378 }\r
9ea69f8a 379 FreePool(DirectoryName);\r
a405b86d 380 }\r
a405b86d 381 }\r
382\r
383 FreePool(CorrectedPath);\r
384 ShellCloseFileMetaArg(&ListHead);\r
385 FreePool(ListHead);\r
386 return (ShellStatus);\r
387}\r
388\r
389STATIC CONST SHELL_PARAM_ITEM LsParamList[] = {\r
390 {L"-r", TypeFlag},\r
391 {L"-a", TypeStart},\r
392 {L"-sfo", TypeFlag},\r
393 {NULL, TypeMax}\r
394 };\r
395\r
396/**\r
397 Function for 'ls' command.\r
398\r
399 @param[in] ImageHandle Handle to the Image (NULL if Internal).\r
400 @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
401**/\r
402SHELL_STATUS\r
403EFIAPI\r
404ShellCommandRunLs (\r
405 IN EFI_HANDLE ImageHandle,\r
406 IN EFI_SYSTEM_TABLE *SystemTable\r
407 )\r
408{\r
409 EFI_STATUS Status;\r
410 LIST_ENTRY *Package;\r
411 CHAR16 *ProblemParam;\r
412 CONST CHAR16 *Attribs;\r
413 SHELL_STATUS ShellStatus;\r
414 UINT64 RequiredAttributes;\r
415 CONST CHAR16 *PathName;\r
416 CONST CHAR16 *CurDir;\r
417 UINTN Count;\r
418 CHAR16 *FullPath;\r
419 UINTN Size;\r
420 EFI_TIME theTime;\r
421 BOOLEAN SfoMode;\r
422\r
423 Size = 0;\r
424 FullPath = NULL;\r
425 ProblemParam = NULL;\r
426 Attribs = NULL;\r
427 ShellStatus = SHELL_SUCCESS;\r
428 RequiredAttributes = 0;\r
429 PathName = NULL;\r
430 CurDir = NULL;\r
431 Count = 0;\r
432\r
433 //\r
434 // initialize the shell lib (we must be in non-auto-init...)\r
435 //\r
436 Status = ShellInitialize();\r
437 ASSERT_EFI_ERROR(Status);\r
438\r
439 //\r
440 // Fix local copies of the protocol pointers\r
441 //\r
442 Status = CommandInit();\r
443 ASSERT_EFI_ERROR(Status);\r
444\r
445 //\r
446 // parse the command line\r
447 //\r
448 Status = ShellCommandLineParse (LsParamList, &Package, &ProblemParam, TRUE);\r
449 if (EFI_ERROR(Status)) {\r
450 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
451 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);\r
452 FreePool(ProblemParam);\r
453 ShellStatus = SHELL_INVALID_PARAMETER;\r
454 } else {\r
455 ASSERT(FALSE);\r
456 }\r
457 } else {\r
458 //\r
459 // check for "-?"\r
460 //\r
461 if (ShellCommandLineGetFlag(Package, L"-?")) {\r
462 ASSERT(FALSE);\r
463 }\r
464\r
465 if (ShellCommandLineGetCount(Package) > 2) {\r
466 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel2HiiHandle);\r
467 ShellStatus = SHELL_INVALID_PARAMETER;\r
468 } else {\r
469 //\r
470 // check for -a\r
471 //\r
472 if (ShellCommandLineGetFlag(Package, L"-a")) {\r
473 for ( Attribs = ShellCommandLineGetValue(Package, L"-a")\r
474 ; Attribs != NULL && *Attribs != CHAR_NULL && ShellStatus == SHELL_SUCCESS\r
475 ; Attribs++\r
476 ){\r
477 switch (*Attribs) {\r
478 case L'a':\r
479 case L'A':\r
480 RequiredAttributes |= EFI_FILE_ARCHIVE;\r
481 Count++;\r
482 continue;\r
483 case L's':\r
484 case L'S':\r
485 RequiredAttributes |= EFI_FILE_SYSTEM;\r
486 Count++;\r
487 continue;\r
488 case L'h':\r
489 case L'H':\r
490 RequiredAttributes |= EFI_FILE_HIDDEN;\r
491 Count++;\r
492 continue;\r
493 case L'r':\r
494 case L'R':\r
495 RequiredAttributes |= EFI_FILE_READ_ONLY;\r
496 Count++;\r
497 continue;\r
498 case L'd':\r
499 case L'D':\r
500 RequiredAttributes |= EFI_FILE_DIRECTORY;\r
501 Count++;\r
502 continue;\r
503 default:\r
504 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ATTRIBUTE), gShellLevel2HiiHandle, ShellCommandLineGetValue(Package, L"-a"));\r
505 ShellStatus = SHELL_INVALID_PARAMETER;\r
506 break;\r
507 } // switch\r
508 } // for loop\r
509 //\r
510 // if nothing is specified all are specified\r
511 //\r
512 if (RequiredAttributes == 0) {\r
513 RequiredAttributes = EFI_FILE_VALID_ATTR;\r
514 }\r
515 } // if -a present\r
516 if (ShellStatus == SHELL_SUCCESS) {\r
517 PathName = ShellCommandLineGetRawValue(Package, 1);\r
518 if (PathName == NULL) {\r
519 CurDir = gEfiShellProtocol->GetCurDir(NULL);\r
520 if (CurDir == NULL) {\r
521 ShellStatus = SHELL_NOT_FOUND;\r
522 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_CWD), gShellLevel2HiiHandle);\r
523 }\r
524 }\r
525 if (PathName != NULL) {\r
526 ASSERT((FullPath == NULL && Size == 0) || (FullPath != NULL));\r
527 StrnCatGrow(&FullPath, &Size, PathName, 0);\r
528 if (ShellIsDirectory(PathName) == EFI_SUCCESS) {\r
529 StrnCatGrow(&FullPath, &Size, L"\\*", 0);\r
530 }\r
531 } else {\r
532 ASSERT(FullPath == NULL);\r
533 StrnCatGrow(&FullPath, NULL, L"*", 0);\r
534 }\r
535 Status = gRT->GetTime(&theTime, NULL);\r
536 ASSERT_EFI_ERROR(Status);\r
537 SfoMode = ShellCommandLineGetFlag(Package, L"-sfo");\r
538 if (ShellStatus == SHELL_SUCCESS) {\r
539 ShellStatus = PrintLsOutput(\r
540 ShellCommandLineGetFlag(Package, L"-r"),\r
541 RequiredAttributes,\r
542 SfoMode,\r
543 FullPath,\r
544 TRUE,\r
545 Count,\r
546 (INT16)(theTime.TimeZone==2047?0:theTime.TimeZone)\r
547 );\r
548 if (ShellStatus == SHELL_NOT_FOUND) {\r
549 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_FILES), gShellLevel2HiiHandle);\r
550 } else if (ShellStatus == SHELL_INVALID_PARAMETER) {\r
551 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel2HiiHandle);\r
552 } else if (ShellStatus != SHELL_SUCCESS) {\r
553 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel2HiiHandle);\r
554 }\r
555 }\r
556 }\r
557 }\r
558 }\r
559\r
560 if (FullPath != NULL) {\r
561 FreePool(FullPath);\r
562 }\r
563 //\r
564 // free the command line package\r
565 //\r
566 ShellCommandLineFreeVarList (Package);\r
567\r
568 return (ShellStatus);\r
569}\r
EFI Development Kit II mirror for PVE