[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel3CommandsLib / Touch.c

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