programs/dxdiag/output.c

   1 /*
   2  * DxDiag file information output
   3  *
   4  * Copyright 2011 Andrew Nguyen
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #define COBJMACROS
  22 #include <initguid.h>
  23 #include <windows.h>
  24 #include <msxml2.h>
  25 #include <assert.h>
  26 #include <stdio.h>
  27
  28 #include "wine/debug.h"
  29 #include "wine/unicode.h"
  30
  31 #include "dxdiag_private.h"
  32
  33 WINE_DEFAULT_DEBUG_CHANNEL(dxdiag);
  34
  35 static char output_buffer[1024];
  36 static const char crlf[2] = "\r\n";
  37
  38 static const WCHAR DxDiag[] = {'D','x','D','i','a','g',0};
  39
  40 static const WCHAR SystemInformation[] = {'S','y','s','t','e','m','I','n','f','o','r','m','a','t','i','o','n',0};
  41 static const WCHAR Time[] = {'T','i','m','e',0};
  42 static const WCHAR MachineName[] = {'M','a','c','h','i','n','e','N','a','m','e',0};
  43 static const WCHAR OperatingSystem[] = {'O','p','e','r','a','t','i','n','g','S','y','s','t','e','m',0};
  44 static const WCHAR Language[] = {'L','a','n','g','u','a','g','e',0};
  45 static const WCHAR SystemManufacturer[] = {'S','y','s','t','e','m','M','a','n','u','f','a','c','t','u','r','e','r',0};
  46 static const WCHAR SystemModel[] = {'S','y','s','t','e','m','M','o','d','e','l',0};
  47 static const WCHAR BIOS[] = {'B','I','O','S',0};
  48 static const WCHAR Processor[] = {'P','r','o','c','e','s','s','o','r',0};
  49 static const WCHAR Memory[] = {'M','e','m','o','r','y',0};
  50 static const WCHAR PageFile[] = {'P','a','g','e','F','i','l','e',0};
  51 static const WCHAR WindowsDir[] = {'W','i','n','d','o','w','s','D','i','r',0};
  52 static const WCHAR DirectXVersion[] = {'D','i','r','e','c','t','X','V','e','r','s','i','o','n',0};
  53 static const WCHAR DXSetupParameters[] = {'D','X','S','e','t','u','p','P','a','r','a','m','e','t','e','r','s',0};
  54 static const WCHAR DxDiagVersion[] = {'D','x','D','i','a','g','V','e','r','s','i','o','n',0};
  55 static const WCHAR DxDiagUnicode[] = {'D','x','D','i','a','g','U','n','i','c','o','d','e',0};
  56 static const WCHAR DxDiag64Bit[] = {'D','x','D','i','a','g','6','4','B','i','t',0};
  57
  58 struct text_information_field
  59 {
  60     const char *field_name;
  61     const WCHAR *value;
  62 };
  63
  64 struct xml_information_field
  65 {
  66     const WCHAR *tag_name;
  67     const WCHAR *value;
  68 };
  69
  70 static BOOL output_text_header(HANDLE hFile, const char *caption)
  71 {
  72     DWORD len = strlen(caption);
  73     DWORD total_len = 3 * (len + sizeof(crlf));
  74     char *ptr = output_buffer;
  75
  76     assert(total_len <= sizeof(output_buffer));
  77
  78     memset(ptr, '-', len);
  79     ptr += len;
  80
  81     memcpy(ptr, crlf, sizeof(crlf));
  82     ptr += sizeof(crlf);
  83
  84     memcpy(ptr, caption, len);
  85     ptr += len;
  86
  87     memcpy(ptr, crlf, sizeof(crlf));
  88     ptr += sizeof(crlf);
  89
  90     memset(ptr, '-', len);
  91     ptr += len;
  92
  93     memcpy(ptr, crlf, sizeof(crlf));
  94
  95     return WriteFile(hFile, output_buffer, total_len, NULL, NULL);
  96 }
  97
  98 static BOOL output_text_field(HANDLE hFile, const char *field_name, DWORD field_width, const WCHAR *value)
  99 {
 100     DWORD value_lenW = strlenW(value);
 101     DWORD value_lenA = WideCharToMultiByte(CP_ACP, 0, value, value_lenW, NULL, 0, NULL, NULL);
 102     DWORD total_len = field_width + sizeof(": ") - 1 + value_lenA + sizeof(crlf);
 103     char sprintf_fmt[1 + 10 + 3 + 1];
 104     char *ptr = output_buffer;
 105
 106     assert(total_len <= sizeof(output_buffer));
 107
 108     sprintf(sprintf_fmt, "%%%us: ", field_width);
 109     ptr += sprintf(ptr, sprintf_fmt, field_name);
 110
 111     ptr += WideCharToMultiByte(CP_ACP, 0, value, value_lenW, ptr, value_lenA, NULL, NULL);
 112     memcpy(ptr, crlf, sizeof(crlf));
 113
 114     return WriteFile(hFile, output_buffer, total_len, NULL, NULL);
 115 }
 116
 117 static BOOL output_crlf(HANDLE hFile)
 118 {
 119     return WriteFile(hFile, crlf, sizeof(crlf), NULL, NULL);
 120 }
 121
 122 static inline void fill_system_text_output_table(struct dxdiag_information *dxdiag_info, struct text_information_field *fields)
 123 {
 124     fields[0].field_name = "Time of this report";
 125     fields[0].value = dxdiag_info->system_info.szTimeEnglish;
 126     fields[1].field_name = "Machine name";
 127     fields[1].value = dxdiag_info->system_info.szMachineNameEnglish;
 128     fields[2].field_name = "Operating System";
 129     fields[2].value = dxdiag_info->system_info.szOSExLongEnglish;
 130     fields[3].field_name = "Language";
 131     fields[3].value = dxdiag_info->system_info.szLanguagesEnglish;
 132     fields[4].field_name = "System Manufacturer";
 133     fields[4].value = dxdiag_info->system_info.szSystemManufacturerEnglish;
 134     fields[5].field_name = "System Model";
 135     fields[5].value = dxdiag_info->system_info.szSystemModelEnglish;
 136     fields[6].field_name = "BIOS";
 137     fields[6].value = dxdiag_info->system_info.szBIOSEnglish;
 138     fields[7].field_name = "Processor";
 139     fields[7].value = dxdiag_info->system_info.szProcessorEnglish;
 140     fields[8].field_name = "Memory";
 141     fields[8].value = dxdiag_info->system_info.szPhysicalMemoryEnglish;
 142     fields[9].field_name = "Page File";
 143     fields[9].value = dxdiag_info->system_info.szPageFileEnglish;
 144     fields[10].field_name = "Windows Dir";
 145     fields[10].value = dxdiag_info->system_info.szWindowsDir;
 146     fields[11].field_name = "DirectX Version";
 147     fields[11].value = dxdiag_info->system_info.szDirectXVersionLongEnglish;
 148     fields[12].field_name = "DX Setup Parameters";
 149     fields[12].value = dxdiag_info->system_info.szSetupParamEnglish;
 150     fields[13].field_name = "DxDiag Version";
 151     fields[13].value = dxdiag_info->system_info.szDxDiagVersion;
 152 }
 153
 154 static BOOL output_text_information(struct dxdiag_information *dxdiag_info, const WCHAR *filename)
 155 {
 156     struct information_block
 157     {
 158         const char *caption;
 159         const size_t field_width;
 160         struct text_information_field fields[50];
 161     } output_table[] =
 162     {
 163         {"System Information", 19},
 164     };
 165
 166     HANDLE hFile;
 167     size_t i;
 168
 169     fill_system_text_output_table(dxdiag_info, output_table[0].fields);
 170
 171     hFile = CreateFileW(filename, GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE,
 172                         NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
 173     if (hFile == INVALID_HANDLE_VALUE)
 174     {
 175         WINE_ERR("File creation failed, last error %u\n", GetLastError());
 176         return FALSE;
 177     }
 178
 179     for (i = 0; i < sizeof(output_table)/sizeof(output_table[0]); i++)
 180     {
 181         const struct text_information_field *fields = output_table[i].fields;
 182         unsigned int j;
 183
 184         output_text_header(hFile, output_table[i].caption);
 185         for (j = 0; fields[j].field_name; j++)
 186             output_text_field(hFile, fields[j].field_name, output_table[i].field_width, fields[j].value);
 187         output_crlf(hFile);
 188     }
 189
 190     CloseHandle(hFile);
 191     return FALSE;
 192 }
 193
 194 static IXMLDOMElement *xml_create_element(IXMLDOMDocument *xmldoc, const WCHAR *name)
 195 {
 196     BSTR bstr = SysAllocString(name);
 197     IXMLDOMElement *ret;
 198     HRESULT hr;
 199
 200     if (!bstr)
 201         return NULL;
 202
 203     hr = IXMLDOMDocument_createElement(xmldoc, bstr, &ret);
 204     SysFreeString(bstr);
 205
 206     return SUCCEEDED(hr) ? ret : NULL;
 207 }
 208
 209 static HRESULT xml_put_element_text(IXMLDOMElement *element, const WCHAR *text)
 210 {
 211     BSTR bstr = SysAllocString(text);
 212     HRESULT hr;
 213
 214     if (!bstr)
 215         return E_OUTOFMEMORY;
 216
 217     hr = IXMLDOMElement_put_text(element, bstr);
 218     SysFreeString(bstr);
 219
 220     return hr;
 221 }
 222
 223 static HRESULT save_xml_document(IXMLDOMDocument *xmldoc, const WCHAR *filename)
 224 {
 225     BSTR bstr = SysAllocString(filename);
 226     VARIANT destVar;
 227     HRESULT hr;
 228
 229     if (!bstr)
 230         return E_OUTOFMEMORY;
 231
 232     V_VT(&destVar) = VT_BSTR;
 233     V_BSTR(&destVar) = bstr;
 234
 235     hr = IXMLDOMDocument_save(xmldoc, destVar);
 236     VariantClear(&destVar);
 237
 238     return hr;
 239 }
 240
 241 static inline void fill_system_xml_output_table(struct dxdiag_information *dxdiag_info, struct xml_information_field *fields)
 242 {
 243     static const WCHAR zeroW[] = {'0',0};
 244     static const WCHAR oneW[] = {'1',0};
 245
 246     fields[0].tag_name = Time;
 247     fields[0].value = dxdiag_info->system_info.szTimeEnglish;
 248     fields[1].tag_name = MachineName;
 249     fields[1].value = dxdiag_info->system_info.szMachineNameEnglish;
 250     fields[2].tag_name = OperatingSystem;
 251     fields[2].value = dxdiag_info->system_info.szOSExLongEnglish;
 252     fields[3].tag_name = Language;
 253     fields[3].value = dxdiag_info->system_info.szLanguagesEnglish;
 254     fields[4].tag_name = SystemManufacturer;
 255     fields[4].value = dxdiag_info->system_info.szSystemManufacturerEnglish;
 256     fields[5].tag_name = SystemModel;
 257     fields[5].value = dxdiag_info->system_info.szSystemModelEnglish;
 258     fields[6].tag_name = BIOS;
 259     fields[6].value = dxdiag_info->system_info.szBIOSEnglish;
 260     fields[7].tag_name = Processor;
 261     fields[7].value = dxdiag_info->system_info.szProcessorEnglish;
 262     fields[8].tag_name = Memory;
 263     fields[8].value = dxdiag_info->system_info.szPhysicalMemoryEnglish;
 264     fields[9].tag_name = PageFile;
 265     fields[9].value = dxdiag_info->system_info.szPageFileEnglish;
 266     fields[10].tag_name = WindowsDir;
 267     fields[10].value = dxdiag_info->system_info.szWindowsDir;
 268     fields[11].tag_name = DirectXVersion;
 269     fields[11].value = dxdiag_info->system_info.szDirectXVersionLongEnglish;
 270     fields[12].tag_name = DXSetupParameters;
 271     fields[12].value = dxdiag_info->system_info.szSetupParamEnglish;
 272     fields[13].tag_name = DxDiagVersion;
 273     fields[13].value = dxdiag_info->system_info.szDxDiagVersion;
 274     fields[14].tag_name = DxDiagUnicode;
 275     fields[14].value = oneW;
 276     fields[15].tag_name = DxDiag64Bit;
 277     fields[15].value = dxdiag_info->system_info.win64 ? oneW : zeroW;
 278 }
 279
 280 static BOOL output_xml_information(struct dxdiag_information *dxdiag_info, const WCHAR *filename)
 281 {
 282     struct information_block
 283     {
 284         const WCHAR *tag_name;
 285         struct xml_information_field fields[50];
 286     } output_table[] =
 287     {
 288         {SystemInformation},
 289     };
 290
 291     IXMLDOMDocument *xmldoc = NULL;
 292     IXMLDOMElement *dxdiag_element = NULL;
 293     HRESULT hr;
 294     size_t i;
 295
 296     fill_system_xml_output_table(dxdiag_info, output_table[0].fields);
 297
 298     hr = CoCreateInstance(&CLSID_DOMDocument, NULL, CLSCTX_INPROC_SERVER,
 299                           &IID_IXMLDOMDocument, (void **)&xmldoc);
 300     if (FAILED(hr))
 301     {
 302         WINE_ERR("IXMLDOMDocument instance creation failed with 0x%08x\n", hr);
 303         goto error;
 304     }
 305
 306     if (!(dxdiag_element = xml_create_element(xmldoc, DxDiag)))
 307         goto error;
 308
 309     hr = IXMLDOMDocument_appendChild(xmldoc, (IXMLDOMNode *)dxdiag_element, NULL);
 310     if (FAILED(hr))
 311         goto error;
 312
 313     for (i = 0; i < sizeof(output_table)/sizeof(output_table[0]); i++)
 314     {
 315         IXMLDOMElement *info_element = xml_create_element(xmldoc, output_table[i].tag_name);
 316         const struct xml_information_field *fields = output_table[i].fields;
 317         unsigned int j = 0;
 318
 319         if (!info_element)
 320             goto error;
 321
 322         hr = IXMLDOMElement_appendChild(dxdiag_element, (IXMLDOMNode *)info_element, NULL);
 323         if (FAILED(hr))
 324         {
 325             IXMLDOMElement_Release(info_element);
 326             goto error;
 327         }
 328
 329         for (j = 0; fields[j].tag_name; j++)
 330         {
 331             IXMLDOMElement *field_element = xml_create_element(xmldoc, fields[j].tag_name);
 332
 333             if (!field_element)
 334             {
 335                 IXMLDOMElement_Release(info_element);
 336                 goto error;
 337             }
 338
 339             hr = xml_put_element_text(field_element, fields[j].value);
 340             if (FAILED(hr))
 341             {
 342                 IXMLDOMElement_Release(field_element);
 343                 IXMLDOMElement_Release(info_element);
 344                 goto error;
 345             }
 346
 347             hr = IXMLDOMElement_appendChild(info_element, (IXMLDOMNode *)field_element, NULL);
 348             if (FAILED(hr))
 349             {
 350                 IXMLDOMElement_Release(field_element);
 351                 IXMLDOMElement_Release(info_element);
 352                 goto error;
 353             }
 354
 355             IXMLDOMElement_Release(field_element);
 356         }
 357
 358         IXMLDOMElement_Release(info_element);
 359     }
 360
 361     hr = save_xml_document(xmldoc, filename);
 362     if (FAILED(hr))
 363         goto error;
 364
 365     IXMLDOMElement_Release(dxdiag_element);
 366     IXMLDOMDocument_Release(xmldoc);
 367     return TRUE;
 368 error:
 369     if (dxdiag_element) IXMLDOMElement_Release(dxdiag_element);
 370     if (xmldoc) IXMLDOMDocument_Release(xmldoc);
 371     return FALSE;
 372 }
 373
 374 static struct output_backend
 375 {
 376     const WCHAR filename_ext[5];
 377     BOOL (*output_handler)(struct dxdiag_information *, const WCHAR *filename);
 378 } output_backends[] =
 379 {
 380     /* OUTPUT_TEXT */
 381     {
 382         {'.','t','x','t',0},
 383         output_text_information,
 384     },
 385     /* OUTPUT_XML */
 386     {
 387         {'.','x','m','l',0},
 388         output_xml_information,
 389     },
 390 };
 391
 392 const WCHAR *get_output_extension(enum output_type type)
 393 {
 394     assert(type > OUTPUT_NONE && type <= sizeof(output_backends)/sizeof(output_backends[0]));
 395
 396     return output_backends[type - 1].filename_ext;
 397 }
 398
 399 BOOL output_dxdiag_information(struct dxdiag_information *dxdiag_info, const WCHAR *filename, enum output_type type)
 400 {
 401     assert(type > OUTPUT_NONE && type <= sizeof(output_backends)/sizeof(output_backends[0]));
 402
 403     return output_backends[type - 1].output_handler(dxdiag_info, filename);
 404 }