Display more meaningful failure messages
[reactos.git] / reactos / apps / utils / net / ipconfig / ipconfig.c
1 /*
2 * ReactOS Win32 Applications
3 * Copyright (C) 2005 ReactOS Team
4 *
5 * COPYRIGHT: See COPYING in the top level directory
6 * PROJECT: ReactOS arp utility
7 * FILE: apps/utils/net/ipconfig/ipconfig.c
8 * PURPOSE:
9 * PROGRAMMERS: Ged Murphy (gedmurphy@gmail.com)
10 * REVISIONS:
11 * GM 14/09/05 Created
12 *
13 */
14 /*
15 * TODO:
16 * fix renew / release
17 * implement flushdns, registerdns, displaydns, showclassid, setclassid
18 * allow globbing on adapter names
19 */
20 #define WIN32_LEAN_AND_MEAN
21 #include <windows.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <time.h>
25 #include <tchar.h>
26 #include <string.h>
27 #include <ctype.h>
28 #include <winsock2.h>
29 #include <iphlpapi.h>
30
31 #define UNICODE
32 #define _UNICODE
33
34
35
36 LPCTSTR GetNodeTypeName(UINT NodeType)
37 {
38 switch (NodeType) {
39 case 1: return _T("Broadcast");
40 case 2: return _T("Peer To Peer");
41 case 4: return _T("Mixed");
42 case 8: return _T("Hybrid");
43 default : return _T("unknown");
44 }
45 }
46
47 LPCTSTR GetInterfaceTypeName(UINT InterfaceType)
48 {
49 switch (InterfaceType) {
50 case MIB_IF_TYPE_OTHER: return _T("Other Type Of Adapter");
51 case MIB_IF_TYPE_ETHERNET: return _T("Ethernet Adapter");
52 case MIB_IF_TYPE_TOKENRING: return _T("Token Ring Adapter");
53 case MIB_IF_TYPE_FDDI: return _T("FDDI Adapter");
54 case MIB_IF_TYPE_PPP: return _T("PPP Adapter");
55 case MIB_IF_TYPE_LOOPBACK: return _T("Loopback Adapter");
56 case MIB_IF_TYPE_SLIP: return _T("SLIP Adapter");
57 default: return _T("unknown");
58 }
59 }
60
61 /* print MAC address */
62 PTCHAR PrintMacAddr(PBYTE Mac)
63 {
64 static TCHAR MacAddr[20];
65
66 _stprintf(MacAddr, _T("%02x-%02x-%02x-%02x-%02x-%02x"),
67 Mac[0], Mac[1], Mac[2], Mac[3], Mac[4], Mac[5]);
68
69 return MacAddr;
70 }
71
72 DWORD DoFormatMessage(DWORD ErrorCode)
73 {
74 LPVOID lpMsgBuf;
75 DWORD RetVal;
76
77 if ((RetVal = FormatMessage(
78 FORMAT_MESSAGE_ALLOCATE_BUFFER |
79 FORMAT_MESSAGE_FROM_SYSTEM |
80 FORMAT_MESSAGE_IGNORE_INSERTS,
81 NULL,
82 ErrorCode,
83 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), /* Default language */
84 (LPTSTR) &lpMsgBuf,
85 0,
86 NULL ))) {
87 _tprintf(_T("%s"), (LPTSTR)lpMsgBuf);
88
89 LocalFree(lpMsgBuf);
90 /* return number of TCHAR's stored in output buffer
91 * excluding '\0' - as FormatMessage does*/
92 return RetVal;
93 }
94 else
95 return 0;
96 }
97
98 INT ShowInfo(BOOL bAll)
99 {
100 PIP_ADAPTER_INFO pAdapterInfo = NULL;
101 PIP_ADAPTER_INFO pAdapter = NULL;
102 ULONG adaptOutBufLen;
103
104 PFIXED_INFO pFixedInfo;
105 ULONG netOutBufLen;
106 PIP_ADDR_STRING pIPAddr = NULL;
107
108 DWORD ErrRet = 0;
109
110 /* assign memory for call to GetNetworkParams */
111 pFixedInfo = (FIXED_INFO *) GlobalAlloc( GPTR, sizeof( FIXED_INFO ) );
112 netOutBufLen = sizeof(FIXED_INFO);
113
114 /* assign memory for call to GetAdapterInfo */
115 pAdapterInfo = (IP_ADAPTER_INFO *) malloc( sizeof(IP_ADAPTER_INFO) );
116 adaptOutBufLen = sizeof(IP_ADAPTER_INFO);
117
118 /* set required buffer size */
119 if(GetNetworkParams(pFixedInfo, &netOutBufLen) == ERROR_BUFFER_OVERFLOW)
120 {
121 GlobalFree(pFixedInfo);
122 pFixedInfo = (FIXED_INFO *) GlobalAlloc(GPTR, netOutBufLen);
123 }
124
125 /* set required buffer size */
126 if (GetAdaptersInfo( pAdapterInfo, &adaptOutBufLen) == ERROR_BUFFER_OVERFLOW)
127 {
128 free(pAdapterInfo);
129 pAdapterInfo = (IP_ADAPTER_INFO *) malloc (adaptOutBufLen);
130 }
131
132 if ((ErrRet = GetAdaptersInfo(pAdapterInfo, &adaptOutBufLen)) != NO_ERROR)
133 {
134 _tprintf(_T("GetAdaptersInfo failed : "));
135 DoFormatMessage(ErrRet);
136 return EXIT_FAILURE;
137 }
138
139 if ((ErrRet = GetNetworkParams(pFixedInfo, &netOutBufLen)) != NO_ERROR)
140 {
141 _tprintf(_T("GetNetworkParams failed : "));
142 DoFormatMessage(ErrRet);
143 return EXIT_FAILURE;
144 }
145
146 pAdapter = pAdapterInfo;
147 //HKEY hKey;
148 //LPCTSTR lpSubKey = _T("SYSTEM\\ControlSet\\Control\\Network");
149
150 _tprintf(_T("\nReactOS IP Configuration\n\n"));
151
152 while (pAdapter)
153 {
154 if (bAll)
155 {
156 _tprintf(_T("\tHost Name . . . . . . . . . . . . : %s\n"), pFixedInfo->HostName);
157 _tprintf(_T("\tPrimary DNS Suffix. . . . . . . . : \n"));
158 _tprintf(_T("\tNode Type . . . . . . . . . . . . : %s\n"), GetNodeTypeName(pFixedInfo->NodeType));
159 if (pFixedInfo->EnableRouting)
160 _tprintf(_T("\tIP Routing Enabled. . . . . . . . : Yes\n"));
161 else
162 _tprintf(_T("\tIP Routing Enabled. . . . . . . . : No\n"));
163 if (pAdapter->HaveWins)
164 _tprintf(_T("\tWINS Proxy enabled. . . . . . . . : Yes\n"));
165 else
166 _tprintf(_T("\tWINS Proxy enabled. . . . . . . . : No\n"));
167 _tprintf(_T("\tDNS Suffix Search List. . . . . . : %s\n"), pFixedInfo->DomainName);
168 }
169
170 _tprintf(_T("\n%s ...... : \n\n"), GetInterfaceTypeName(pAdapter->Type));
171
172 /* check if the adapter is connected to the media */
173 if (_tcscmp(pAdapter->IpAddressList.IpAddress.String, "0.0.0.0") == 0)
174 {
175 _tprintf(_T("\tMedia State . . . . . . . . . . . : Media disconnected\n"));
176 pAdapter = pAdapter->Next;
177 continue;
178 }
179
180 _tprintf(_T("\tConnection-specific DNS Suffix. . : %s\n"), pFixedInfo->DomainName);
181
182 if (bAll)
183 {
184 _tprintf(_T("\tDescription . . . . . . . . . . . : %s\n"), pAdapter->Description);
185 _tprintf(_T("\tPhysical Address. . . . . . . . . : %s\n"), PrintMacAddr(pAdapter->Address));
186 if (pAdapter->DhcpEnabled)
187 _tprintf(_T("\tDHCP Enabled. . . . . . . . . . . : Yes\n"));
188 else
189 _tprintf(_T("\tDHCP Enabled. . . . . . . . . . . : No\n"));
190 _tprintf(_T("\tAutoconfiguration Enabled . . . . : \n"));
191 }
192
193 _tprintf(_T("\tIP Address. . . . . . . . . . . . : %s\n"), pAdapter->IpAddressList.IpAddress.String);
194 _tprintf(_T("\tSubnet Mask . . . . . . . . . . . : %s\n"), pAdapter->IpAddressList.IpMask.String);
195 _tprintf(_T("\tDefault Gateway . . . . . . . . . : %s\n"), pAdapter->GatewayList.IpAddress.String);
196
197 if (bAll)
198 {
199 if (pAdapter->DhcpEnabled)
200 _tprintf(_T("\tDHCP Server . . . . . . . . . . . : %s\n"), pAdapter->DhcpServer.IpAddress.String);
201
202 _tprintf(_T("\tDNS Servers . . . . . . . . . . . : "));
203 _tprintf(_T("%s\n"), pFixedInfo->DnsServerList.IpAddress.String);
204 pIPAddr = pFixedInfo -> DnsServerList.Next;
205 while (pIPAddr)
206 {
207 _tprintf(_T("\t\t\t\t\t %s\n"), pIPAddr ->IpAddress.String );
208 pIPAddr = pIPAddr ->Next;
209 }
210 if (pAdapter->HaveWins)
211 {
212 _tprintf(_T("\tPrimary WINS Server . . . . . . . : %s\n"), pAdapter->PrimaryWinsServer.IpAddress.String);
213 _tprintf(_T("\tSecondard WINS Server . . . . . . : %s\n"), pAdapter->SecondaryWinsServer.IpAddress.String);
214 }
215 if (pAdapter->DhcpEnabled)
216 {
217 _tprintf(_T("\tLease Obtained. . . . . . . . . . : %s"), _tasctime(localtime(&pAdapter->LeaseObtained)));
218 _tprintf(_T("\tLease Expires . . . . . . . . . . : %s"), _tasctime(localtime(&pAdapter->LeaseExpires)));
219 }
220 }
221 _tprintf(_T("\n"));
222
223 pAdapter = pAdapter->Next;
224
225 }
226
227 return 0;
228 }
229
230 INT Release(TCHAR Index)
231 {
232 IP_ADAPTER_INDEX_MAP AdapterInfo;
233 DWORD dwRetVal = 0;
234
235 /* if interface is not given, query GetInterfaceInfo */
236 if (Index == (TCHAR)NULL)
237 {
238 PIP_INTERFACE_INFO pInfo;
239 pInfo = (IP_INTERFACE_INFO *) malloc(sizeof(IP_INTERFACE_INFO));
240 ULONG ulOutBufLen = 0;
241
242 /* Make an initial call to GetInterfaceInfo to get
243 * the necessary size into the ulOutBufLen variable */
244 if ( GetInterfaceInfo(pInfo, &ulOutBufLen) == ERROR_INSUFFICIENT_BUFFER)
245 {
246 GlobalFree(pInfo);
247 pInfo = (IP_INTERFACE_INFO *) malloc (ulOutBufLen);
248 }
249
250 /* Make a second call to GetInterfaceInfo to get the actual data we want */
251 if ((dwRetVal = GetInterfaceInfo(pInfo, &ulOutBufLen)) == NO_ERROR )
252 {
253 AdapterInfo = pInfo->Adapter[0];
254 _tprintf(_T("name - %S\n"), pInfo->Adapter[0].Name);
255 }
256 else
257 {
258 _tprintf(_T("\nGetInterfaceInfo failed : "));
259 DoFormatMessage(dwRetVal);
260 }
261 }
262 else
263 {
264 ;
265 /* we need to be able to release connections by name with support for globbing
266 * i.e. ipconfig /release Eth* will release all cards starting with Eth...
267 * ipconfig /release *con* will release all cards with 'con' in their name
268 */
269 }
270
271
272 /* Call IpReleaseAddress to release the IP address on the specified adapter. */
273 if ((dwRetVal = IpReleaseAddress(&AdapterInfo)) != NO_ERROR)
274 {
275 _tprintf(_T("\nAn error occured while releasing interface %s : "), _T("*name*"));
276 DoFormatMessage(dwRetVal);
277 }
278 return 0;
279 }
280
281
282
283
284 INT Renew(TCHAR Index)
285 {
286 IP_ADAPTER_INDEX_MAP AdapterInfo;
287 DWORD dwRetVal = 0;
288
289 /* if interface is not given, query GetInterfaceInfo */
290 if (Index == (TCHAR)NULL)
291 {
292 PIP_INTERFACE_INFO pInfo;
293 pInfo = (IP_INTERFACE_INFO *) malloc(sizeof(IP_INTERFACE_INFO));
294 ULONG ulOutBufLen = 0;
295
296 /* Make an initial call to GetInterfaceInfo to get
297 * the necessary size into the ulOutBufLen variable */
298 if ( GetInterfaceInfo(pInfo, &ulOutBufLen) == ERROR_INSUFFICIENT_BUFFER)
299 {
300 GlobalFree(pInfo);
301 pInfo = (IP_INTERFACE_INFO *) malloc (ulOutBufLen);
302 }
303
304 /* Make a second call to GetInterfaceInfo to get the actual data we want */
305 if ((dwRetVal = GetInterfaceInfo(pInfo, &ulOutBufLen)) == NO_ERROR )
306 {
307 AdapterInfo = pInfo->Adapter[0];
308 _tprintf(_T("name - %S\n"), pInfo->Adapter[0].Name);
309 } else {
310 _tprintf(_T("\nGetInterfaceInfo failed : "));
311 DoFormatMessage(dwRetVal);
312 }
313 }
314 else
315 {
316 ;
317 /* we need to be able to renew connections by name with support for globbing
318 * i.e. ipconfig /renew Eth* will renew all cards starting with Eth...
319 * ipconfig /renew *con* will renew all cards with 'con' in their name
320 */
321 }
322
323
324 /* Call IpRenewAddress to renew the IP address on the specified adapter. */
325 if ((dwRetVal = IpRenewAddress(&AdapterInfo)) != NO_ERROR)
326 {
327 _tprintf(_T("\nAn error occured while renew interface %s : "), _T("*name*"));
328 DoFormatMessage(dwRetVal);
329 }
330 return 0;
331 }
332
333 /* temp func for testing purposes */
334 VOID Info()
335 {
336 // Declare and initialize variables
337 PIP_INTERFACE_INFO pInfo;
338 pInfo = (IP_INTERFACE_INFO *) malloc( sizeof(IP_INTERFACE_INFO) );
339 ULONG ulOutBufLen = sizeof(IP_INTERFACE_INFO);
340 DWORD dwRetVal = 0;
341
342
343 // Make an initial call to GetInterfaceInfo to get
344 // the necessary size in the ulOutBufLen variable
345 if ( GetInterfaceInfo(pInfo, &ulOutBufLen) == ERROR_INSUFFICIENT_BUFFER)
346 {
347 free(pInfo);
348 pInfo = (IP_INTERFACE_INFO *) malloc (ulOutBufLen);
349 }
350
351 // Make a second call to GetInterfaceInfo to get
352 // the actual data we need
353 if ((dwRetVal = GetInterfaceInfo(pInfo, &ulOutBufLen)) == NO_ERROR )
354 {
355 int i;
356 for (i=0; i<pInfo->NumAdapters; i++)
357 {
358 printf("\tAdapter Name: %S\n", pInfo->Adapter[i].Name);
359 printf("\tAdapter Index: %ld\n", pInfo->Adapter[i].Index);
360 printf("\tNum Adapters: %ld\n", pInfo->NumAdapters);
361 }
362 }
363 else
364 {
365 printf("GetInterfaceInfo failed.\n");
366 DoFormatMessage(dwRetVal);
367 }
368 }
369
370
371 VOID Usage(VOID)
372 {
373 _tprintf(_T("\nUSAGE:\n"
374 " ipconfig [/? | /all | /renew [adapter] | /release [adapter] |\n"
375 " /flushdns | /displaydns | /registerdns |\n"
376 " /showclassid adapter |\n"
377 " /setclassid adapter [classid] ]\n"
378 "\n"
379 "where\n"
380 " adapter Connection name\n"
381 " (wildcard characters * and ? allowed, see examples)\n"
382 "\n"
383 " Options:\n"
384 " /? Display this help message\n"
385 " /all Display full configuration information.\n"
386 " /release Release the IP address for the specified adapter.\n"
387 " /renew Renew the IP address for the specified adapter.\n"
388 " /flushdns Purges the DNS Resolver cache.\n"
389 " /registerdns Refreshes all DHCP leases and re-registers DNS names.\n"
390 " /displaydns Display the contents of the DNS Resolver Cache.\n"
391 " /showclassid Displays all the dhcp class IDs allowed for adapter.\n"
392 " /setclassid Modifies the dhcp class id.\n"
393 "\n"
394 "The default is to display only the IP address, subnet mask and\n"
395 "default gateway for each adapter bound to TCP/IP.\n"
396 "\n"
397 "For Release and Renew, if no adapter name is specified, then the IP address\n"
398 "leases for all adapters bound to TCP/IP will be released or renewed.\n"
399 "\n"
400 "For Setclassid, if no ClassId is specified, then the ClassId is removed.\n"
401 "\n"
402 "Examples:\n"
403 " > ipconfig ... Show information.\n"
404 " > ipconfig /all ... Show detailed information\n"
405 " > ipconfig /renew ... renew all adapters\n"
406 " > ipconfig /renew EL* ... renew any connection that has its\n"
407 " name starting with EL\n"
408 " > ipconfig /release *Con* ... release all matching connections,\n"
409 " eg. \"Local Area Connection 1\" or\n"
410 " \"Local Area Connection 2\"\n"));
411 }
412
413 int main(int argc, char *argv[])
414 {
415 BOOL DoUsage=FALSE;
416 BOOL DoAll=FALSE;
417 BOOL DoRelease=FALSE;
418 BOOL DoRenew=FALSE;
419 BOOL DoFlushdns=FALSE;
420 BOOL DoRegisterdns=FALSE;
421 BOOL DoDisplaydns=FALSE;
422 BOOL DoShowclassid=FALSE;
423 BOOL DoSetclassid=FALSE;
424
425 /* Parse command line for options we have been given. */
426 if ( (argc > 1)&&(argv[1][0]=='/') )
427 {
428 if( !_tcsicmp( &argv[1][1], _T("?") ))
429 {
430 DoUsage = TRUE;
431 }
432 else if( !_tcsnicmp( &argv[1][1], _T("ALL"), _tcslen(&argv[1][1]) ))
433 {
434 DoAll = TRUE;
435 }
436 else if( !_tcsnicmp( &argv[1][1], _T("RELEASE"), _tcslen(&argv[1][1]) ))
437 {
438 DoRelease = TRUE;
439 }
440 else if( ! _tcsnicmp( &argv[1][1], _T("RENEW"), _tcslen(&argv[1][1]) ))
441 {
442 DoRenew = TRUE;
443 }
444 else if( ! _tcsnicmp( &argv[1][1], _T("FLUSHDNS"), _tcslen(&argv[1][1]) ))
445 {
446 DoFlushdns = TRUE;
447 }
448 else if( ! _tcsnicmp( &argv[1][1], _T("FLUSHREGISTERDNS"), _tcslen(&argv[1][1]) ))
449 {
450 DoRegisterdns = TRUE;
451 }
452 else if( ! _tcsnicmp( &argv[1][1], _T("DISPLAYDNS"), _tcslen(&argv[1][1]) ))
453 {
454 DoDisplaydns = TRUE;
455 }
456 else if( ! _tcsnicmp( &argv[1][1], _T("SHOWCLASSID"), _tcslen(&argv[1][1]) ))
457 {
458 DoShowclassid = TRUE;
459 }
460 else if( ! _tcsnicmp( &argv[1][1], _T("SETCLASSID"), _tcslen(&argv[1][1]) ))
461 {
462 DoSetclassid = TRUE;
463 }
464 }
465
466 switch (argc)
467 {
468 case 1: /* Default behaviour if no options are given*/
469 ShowInfo(FALSE);
470 break;
471 case 2: /* Process all the options that take no paramiters */
472 if (DoUsage)
473 Usage();
474 else if (DoAll)
475 ShowInfo(TRUE);
476 else if (DoRelease)
477 Release((TCHAR)NULL);
478 else if (DoRenew)
479 Renew((TCHAR)NULL);
480 else if (DoFlushdns)
481 _tprintf(_T("\nSorry /flushdns is not implemented yet\n"));
482 else if (DoRegisterdns)
483 _tprintf(_T("\nSorry /registerdns is not implemented yet\n"));
484 else if (DoDisplaydns)
485 _tprintf(_T("\nSorry /displaydns is not implemented yet\n"));
486 else
487 Usage();
488 break;
489 case 3: /* Process all the options that can have 1 paramiters */
490 if (DoRelease)
491 _tprintf(_T("\nSorry /release [adapter] is not implemented yet\n"));
492 //Release(argv[2]);
493 else if (DoRenew)
494 _tprintf(_T("\nSorry /renew [adapter] is not implemented yet\n"));
495 else if (DoShowclassid)
496 _tprintf(_T("\nSorry /showclassid adapter is not implemented yet\n"));
497 else if (DoSetclassid)
498 _tprintf(_T("\nSorry /setclassid adapter is not implemented yet\n"));
499 else
500 Usage();
501 break;
502 case 4: /* Process all the options that can have 2 paramiters */
503 if (DoSetclassid)
504 _tprintf(_T("\nSorry /setclassid adapter [classid]is not implemented yet\n"));
505 else
506 Usage();
507 break;
508 default:
509 Usage();
510 }
511
512 return 0;
513 }