[NETSH] Implement the dump command

Author: EricKohl

base/applications/network/netsh/context.c

@@ -307,6 +307,96 @@ DeleteContext(
 }
 
 
+static
+int
+DumpCompare(
+    _In_ const void *p1,
+    _In_ const void *p2)
+{
+    return ((PCONTEXT_ENTRY)p1)->ulPriority - ((PCONTEXT_ENTRY)p2)->ulPriority;
+}
+
+
+static
+DWORD
+DumpContext(
+    _In_ PCONTEXT_ENTRY pContext,
+    _In_ LPCWSTR pwszMachine,
+    _In_ LPWSTR *ppwcArguments,
+    _In_ DWORD dwArgCount,
+    _In_ LPCVOID pvData)
+{
+    PCONTEXT_ENTRY pSubContext, *pSortArray = NULL;
+    DWORD dwCount, dwIndex;
+    DWORD dwError = ERROR_SUCCESS;
+
+    DPRINT("DumpContext()\n");
+
+    if (pContext->pfnDumpFn)
+    {
+        dwError = pContext->pfnDumpFn(pwszMachine,
+                                      ppwcArguments,
+                                      dwArgCount,
+                                      pvData);
+        if (dwError != ERROR_SUCCESS)
+        {
+            DPRINT1("Dump function failed (Error %lu)\n", dwError);
+            return dwError;
+        }
+    }
+
+    if (pContext->pSubContextHead == NULL)
+        return dwError;
+
+    /* Count the sub-contexts */
+    dwCount = 0;
+    pSubContext = pContext->pSubContextHead;
+    while (pSubContext)
+    {
+        dwCount++;
+        pSubContext = pSubContext->pNext;
+    }
+
+    /* Allocate the sort array */
+    pSortArray = HeapAlloc(GetProcessHeap(), 0, dwCount * sizeof(PCONTEXT_ENTRY));
+    if (pSortArray == NULL)
+        return ERROR_NOT_ENOUGH_MEMORY;
+
+    /* Fill the sort array */
+    dwIndex = 0;
+    pSubContext = pContext->pSubContextHead;
+    while (pSubContext)
+    {
+        pSortArray[dwIndex] = pSubContext;
+        dwIndex++;
+        pSubContext = pSubContext->pNext;
+    }
+
+    /* Sort the array */
+    qsort(pSortArray, dwCount, sizeof(PCONTEXT_ENTRY), DumpCompare);
+
+    /* Dump the sub-contexts */
+    for (dwIndex = 0; dwIndex < dwCount; dwIndex++)
+    {
+        dwError = DumpContext(pSortArray[dwIndex],
+                              pwszMachine,
+                              ppwcArguments,
+                              dwArgCount,
+                              pvData);
+        if (dwError != ERROR_SUCCESS)
+        {
+            DPRINT1("Dump function failed (Error %lu)\n", dwError);
+            break;
+        }
+    }
+
+    /* Free the sort array */
+    HeapFree(GetProcessHeap(), 0, pSortArray);
+
+    return dwError;
+}
+
+
 DWORD
 WINAPI
 UpCommand(
@@ -325,6 +415,27 @@ UpCommand(
 }
 
 
+DWORD
+WINAPI
+DumpCommand(
+    LPCWSTR pwszMachine,
+    LPWSTR *ppwcArguments,
+    DWORD dwCurrentIndex,
+    DWORD dwArgCount,
+    DWORD dwFlags,
+    LPCVOID pvData,
+    BOOL *pbDone)
+{
+    DPRINT("DumpCommand()\n");
+
+    return DumpContext(pCurrentContext,
+                       pwszMachine,
+                       ppwcArguments,
+                       dwArgCount,
+                       pvData);
+}
+
+
 DWORD
 WINAPI
 ExecCommand(
@@ -464,11 +575,12 @@ CreateRootContext(VOID)
     pRootContext->hModule = GetModuleHandle(NULL);
 
     AddContextCommand(pRootContext, L"..",    UpCommand,    IDS_HLP_UP,    IDS_HLP_UP_EX, 0);
-    AddContextCommand(pRootContext, L"?",     NULL,         IDS_HLP_HELP, IDS_HLP_HELP_EX, 0);
+    AddContextCommand(pRootContext, L"?",     NULL,         IDS_HLP_HELP,  IDS_HLP_HELP_EX, 0);
     AddContextCommand(pRootContext, L"bye",   ExitCommand,  IDS_HLP_EXIT,  IDS_HLP_EXIT_EX, 0);
+    AddContextCommand(pRootContext, L"dump",  DumpCommand,  IDS_HLP_DUMP,  IDS_HLP_DUMP_EX, 0);
     AddContextCommand(pRootContext, L"exec",  ExecCommand,  IDS_HLP_EXEC,  IDS_HLP_EXEC_EX, 0);
     AddContextCommand(pRootContext, L"exit",  ExitCommand,  IDS_HLP_EXIT,  IDS_HLP_EXIT_EX, 0);
-    AddContextCommand(pRootContext, L"help",  NULL,         IDS_HLP_HELP, IDS_HLP_HELP_EX, 0);
+    AddContextCommand(pRootContext, L"help",  NULL,         IDS_HLP_HELP,  IDS_HLP_HELP_EX, 0);
     AddContextCommand(pRootContext, L"popd",  PopdCommand,  IDS_HLP_POPD,  IDS_HLP_POPD_EX, 0);
     AddContextCommand(pRootContext, L"pushd", PushdCommand, IDS_HLP_PUSHD, IDS_HLP_PUSHD_EX, 0);
     AddContextCommand(pRootContext, L"quit",  ExitCommand,  IDS_HLP_EXIT,  IDS_HLP_EXIT_EX, 0);
@@ -582,6 +694,9 @@ RegisterContext(
     pContext = AddContext(pParentContext, pChildContext->pwszContext, (GUID*)&pChildContext->guidHelper);
     if (pContext != NULL)
     {
+        pContext->pfnDumpFn = pChildContext->pfnDumpFn;
+        pContext->ulPriority = (pChildContext->dwFlags & CMD_FLAG_PRIORITY) ? pChildContext->ulPriority : 100;
+
         if ((pHelper != NULL) && (pHelper->pDllEntry != NULL))
         {
             pContext->hModule = pHelper->pDllEntry->hModule;

base/applications/network/netsh/lang/en-US.rc

@@ -37,6 +37,9 @@ BEGIN
     IDS_HLP_PUSHD_EX       "Syntax: pushd\n\n        Stores the current context on the stack.\n\n"
     IDS_HLP_EXEC           "Runs a script file.\n"
     IDS_HLP_EXEC_EX        "Syntax: exec <ScriptFile>\n\n        Loads the script file and runs it.\n\n"
+    IDS_HLP_DUMP           "Displays a configuration script.\n"
+    IDS_HLP_DUMP_EX        "Syntax: dump\n\n        Creates a script that contains the current configuration. If saved to a\n\
+        file, the script can be used to altered configuration settings.\n\n"
 
     IDS_HLP_ADD_HELPER     "Installs a helper DLL.\n"
     IDS_HLP_ADD_HELPER_EX  "Syntax: add helper <dll file name>\n\n        Installs the specified helper DLL in netsh.\n\n"

base/applications/network/netsh/precomp.h

@@ -106,6 +106,8 @@ typedef struct _CONTEXT_ENTRY
     PWSTR pszContextName;
     GUID Guid;
     HMODULE hModule;
+    PNS_CONTEXT_DUMP_FN pfnDumpFn;
+    ULONG ulPriority;
 
     PCOMMAND_ENTRY pCommandListHead;
     PCOMMAND_ENTRY pCommandListTail;

base/applications/network/netsh/resource.h

@@ -33,6 +33,8 @@
 #define IDS_HLP_PUSHD_EX         309
 #define IDS_HLP_EXEC             310
 #define IDS_HLP_EXEC_EX          311
+#define IDS_HLP_DUMP             312
+#define IDS_HLP_DUMP_EX          313
 
 #define IDS_HLP_ADD_HELPER       320
 #define IDS_HLP_ADD_HELPER_EX    321