]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellLevel3CommandsLib/Touch.c
ShellPkg: Add checking for memory allocation and pointer returns from functions.
[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel3CommandsLib / Touch.c
CommitLineData
a405b86d 1/** @file\r
2 Main file for Touch shell level 3 function.\r
3\r
345cd235 4 Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved. <BR>\r
a405b86d 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 "UefiShellLevel3CommandsLib.h"\r
16\r
17#include <Library/ShellLib.h>\r
18\r
345cd235 19/**\r
20 Do the touch operation on a single handle.\r
21\r
22 @param[in] Handle The handle to update the date/time on.\r
23\r
24 @retval EFI_ACCESS_DENIED The file referenced by Handle is read only.\r
25 @retval EFI_SUCCESS The operation was successful.\r
26**/\r
a405b86d 27EFI_STATUS\r
28EFIAPI\r
29TouchFileByHandle (\r
30 IN EFI_HANDLE Handle\r
31 )\r
32{\r
33 EFI_STATUS Status;\r
34 EFI_FILE_INFO *FileInfo;\r
35\r
36 FileInfo = gEfiShellProtocol->GetFileInfo(Handle);\r
37 if ((FileInfo->Attribute & EFI_FILE_READ_ONLY) != 0){\r
38 return (EFI_ACCESS_DENIED);\r
39 }\r
40 Status = gRT->GetTime(&FileInfo->ModificationTime, NULL);\r
41 ASSERT_EFI_ERROR(Status);\r
42 CopyMem(&FileInfo->LastAccessTime, &FileInfo->ModificationTime, sizeof(EFI_TIME));\r
43\r
44 Status = gEfiShellProtocol->SetFileInfo(Handle, FileInfo);\r
45\r
46 FreePool(FileInfo);\r
47\r
48 return (Status);\r
49}\r
50\r
345cd235 51/**\r
52 Touch a given file and potantially recurse down if it was a directory.\r
53\r
54 @param[in] Name The name of this file.\r
55 @param[in] FS The name of the file system this file is on.\r
56 @param[in] Handle The handle of this file already opened.\r
57 @param[in] Rec TRUE to recurse if possible.\r
58\r
59 @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
60 @retval EFI_SUCCESS The operation was successful.\r
61**/\r
a405b86d 62EFI_STATUS\r
63EFIAPI\r
64DoTouchByHandle (\r
65 IN CONST CHAR16 *Name,\r
66 IN CHAR16 *FS,\r
67 IN SHELL_FILE_HANDLE Handle,\r
68 IN BOOLEAN Rec\r
69 )\r
70{\r
71 EFI_STATUS Status;\r
72 EFI_SHELL_FILE_INFO *FileList;\r
73 EFI_SHELL_FILE_INFO *Walker;\r
74 CHAR16 *TempSpot;\r
75\r
76 Status = EFI_SUCCESS;\r
77 FileList = NULL;\r
78 Walker = NULL;\r
79\r
80 if (FS == NULL) {\r
81 FS = StrnCatGrow(&FS, NULL, Name, 0);\r
532691c8 82 if (FS != NULL) {\r
83 TempSpot = StrStr(FS, L"\\");\r
84 if (TempSpot != NULL) {\r
85 *TempSpot = CHAR_NULL;\r
86 }\r
a405b86d 87 }\r
88 }\r
532691c8 89 if (FS == NULL) {\r
90 return (EFI_INVALID_PARAMETER);\r
91 }\r
a405b86d 92\r
93 //\r
94 // do it\r
95 //\r
96 Status = TouchFileByHandle(Handle);\r
97 if (EFI_ERROR(Status)) {\r
98 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NO_OPEN), gShellLevel3HiiHandle, Name, Status);\r
99 return (Status);\r
100 }\r
101\r
102 //\r
103 // if it's a directory recurse...\r
104 //\r
105 if (FileHandleIsDirectory(Handle) == EFI_SUCCESS && Rec) {\r
106 //\r
107 // get each file under this directory\r
108 //\r
109 if (EFI_ERROR(gEfiShellProtocol->FindFilesInDir(Handle, &FileList))) {\r
110 Status = EFI_INVALID_PARAMETER;\r
111 }\r
112\r
113 //\r
114 // recurse on each\r
115 //\r
116 for (Walker = (EFI_SHELL_FILE_INFO *)GetFirstNode(&FileList->Link)\r
117 ; FileList != NULL && !IsNull(&FileList->Link, &Walker->Link) && !EFI_ERROR(Status)\r
118 ; Walker = (EFI_SHELL_FILE_INFO *)GetNextNode(&FileList->Link, &Walker->Link)\r
119 ){\r
120 if ( (StrCmp(Walker->FileName, L".") != 0)\r
121 && (StrCmp(Walker->FileName, L"..") != 0)\r
122 ){\r
123 //\r
124 // Open the file since we need that handle.\r
125 //\r
126 Status = gEfiShellProtocol->OpenFileByName (Walker->FullName, &Walker->Handle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE);\r
127 if (EFI_ERROR(Status)) {\r
128 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NO_OPEN), gShellLevel3HiiHandle, Walker->FullName, Status);\r
129 Status = EFI_ACCESS_DENIED;\r
130 } else {\r
131 Status = DoTouchByHandle(Walker->FullName, FS, Walker->Handle, TRUE);\r
132 gEfiShellProtocol->CloseFile(Walker->Handle);\r
133 Walker->Handle = NULL;\r
134 }\r
135 }\r
136 }\r
137\r
138 //\r
139 // free stuff\r
140 //\r
141 if (FileList != NULL && EFI_ERROR(gEfiShellProtocol->FreeFileList(&FileList))) {\r
142 Status = EFI_INVALID_PARAMETER;\r
143 }\r
144 }\r
145\r
146 return (Status);\r
147}\r
148\r
149STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
150 {L"-r", TypeFlag},\r
151 {NULL, TypeMax}\r
152 };\r
153\r
154/**\r
155 Function for 'touch' command.\r
156\r
157 @param[in] ImageHandle Handle to the Image (NULL if Internal).\r
158 @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
159**/\r
160SHELL_STATUS\r
161EFIAPI\r
162ShellCommandRunTouch (\r
163 IN EFI_HANDLE ImageHandle,\r
164 IN EFI_SYSTEM_TABLE *SystemTable\r
165 )\r
166{\r
167 EFI_STATUS Status;\r
168 LIST_ENTRY *Package;\r
169 CHAR16 *ProblemParam;\r
170 CONST CHAR16 *Param;\r
171 SHELL_STATUS ShellStatus;\r
172 UINTN ParamCount;\r
173 EFI_SHELL_FILE_INFO *FileList;\r
174 EFI_SHELL_FILE_INFO *Node;\r
175\r
176 ProblemParam = NULL;\r
177 ShellStatus = SHELL_SUCCESS;\r
178 ParamCount = 0;\r
179 FileList = NULL;\r
180\r
181 //\r
182 // initialize the shell lib (we must be in non-auto-init...)\r
183 //\r
184 Status = ShellInitialize();\r
185 ASSERT_EFI_ERROR(Status);\r
186\r
187 Status = CommandInit();\r
188 ASSERT_EFI_ERROR(Status);\r
189\r
190 //\r
191 // parse the command line\r
192 //\r
193 Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
194 if (EFI_ERROR(Status)) {\r
195 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
196 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, ProblemParam);\r
197 FreePool(ProblemParam);\r
198 ShellStatus = SHELL_INVALID_PARAMETER;\r
199 } else {\r
200 ASSERT(FALSE);\r
201 }\r
202 } else {\r
203 //\r
204 // check for "-?"\r
205 //\r
206 if (ShellCommandLineGetFlag(Package, L"-?")) {\r
207 ASSERT(FALSE);\r
208 }\r
209 if (ShellCommandLineGetRawValue(Package, 1) == NULL) {\r
210 //\r
211 // we insufficient parameters\r
212 //\r
213 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel3HiiHandle);\r
214 ShellStatus = SHELL_INVALID_PARAMETER;\r
215 } else {\r
216 //\r
217 // get a list with each file specified by parameters\r
218 // if parameter is a directory then add all the files below it to the list\r
219 //\r
220 for ( ParamCount = 1, Param = ShellCommandLineGetRawValue(Package, ParamCount)\r
221 ; Param != NULL\r
222 ; ParamCount++, Param = ShellCommandLineGetRawValue(Package, ParamCount)\r
223 ){\r
224 Status = ShellOpenFileMetaArg((CHAR16*)Param, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE, &FileList);\r
225 if (EFI_ERROR(Status)) {\r
226 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, (CHAR16*)Param);\r
227 ShellStatus = SHELL_NOT_FOUND;\r
228 break;\r
229 }\r
230 //\r
231 // make sure we completed the param parsing sucessfully...\r
232 // Also make sure that any previous action was sucessful\r
233 //\r
234 if (ShellStatus == SHELL_SUCCESS) {\r
235 //\r
236 // check that we have at least 1 file\r
237 //\r
238 if (FileList == NULL || IsListEmpty(&FileList->Link)) {\r
239 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NF), gShellLevel3HiiHandle, Param);\r
240 continue;\r
241 } else {\r
242 //\r
243 // loop through the list and make sure we are not aborting...\r
244 //\r
245 for ( Node = (EFI_SHELL_FILE_INFO*)GetFirstNode(&FileList->Link)\r
246 ; !IsNull(&FileList->Link, &Node->Link) && !ShellGetExecutionBreakFlag()\r
247 ; Node = (EFI_SHELL_FILE_INFO*)GetNextNode(&FileList->Link, &Node->Link)\r
248 ){\r
249 //\r
250 // make sure the file opened ok\r
251 //\r
252 if (EFI_ERROR(Node->Status)){\r
253 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NO_OPEN), gShellLevel3HiiHandle, Node->FileName, Node->Status);\r
254 ShellStatus = SHELL_NOT_FOUND;\r
255 continue;\r
256 }\r
257\r
258 Status = DoTouchByHandle(Node->FullName, NULL, Node->Handle, ShellCommandLineGetFlag(Package, L"-r"));\r
259 if (EFI_ERROR(Status) && Status != EFI_ACCESS_DENIED) {\r
260 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_NO_OPEN), gShellLevel3HiiHandle, Node->FileName, Status);\r
261 ShellStatus = SHELL_NOT_FOUND;\r
262 }\r
263 }\r
264 }\r
265 }\r
266 //\r
267 // Free the fileList\r
268 //\r
269 if (FileList != NULL && !IsListEmpty(&FileList->Link)) {\r
270 Status = ShellCloseFileMetaArg(&FileList);\r
271 ASSERT_EFI_ERROR(Status);\r
272 }\r
273 FileList = NULL;\r
274 }\r
275 }\r
276\r
277 //\r
278 // free the command line package\r
279 //\r
280 ShellCommandLineFreeVarList (Package);\r
281 }\r
282\r
283 if (ShellGetExecutionBreakFlag()) {\r
284 return (SHELL_ABORTED);\r
285 }\r
286\r
287 return (ShellStatus);\r
288}\r
289\r