windows-server-2003/admin/pchealth/sysinfo/control/simplequery.cpp

//=============================================================================
// Contains the refresh function for a simple query function (a simple query
// is one which involves a single WMI class and little post processing).
//=============================================================================

#include "stdafx.h"
#include "category.h"
#include "dataset.h"
#include "wmiabstraction.h"
#include "resourcemap.h"

//-----------------------------------------------------------------------------
// These functions implement features found in the new versions of MFC (new
// than what we're currently building with).
//-----------------------------------------------------------------------------

void StringReplace(CString & str, LPCTSTR szLookFor, LPCTSTR szReplaceWith)
{
	CString strWorking(str);
	CString strReturn;
	CString strLookFor(szLookFor);
	CString strReplaceWith(szReplaceWith);

	int iLookFor = strLookFor.GetLength();
	int iNext;

	while (!strWorking.IsEmpty())
	{
		iNext = strWorking.Find(strLookFor);
		if (iNext == -1)
		{
			strReturn += strWorking;
			strWorking.Empty();
		}
		else
		{
			strReturn += strWorking.Left(iNext);
			strReturn += strReplaceWith;
			strWorking = strWorking.Right(strWorking.GetLength() - (iNext + iLookFor));
		}
	}

	str = strReturn;
}

//-----------------------------------------------------------------------------
// The CSimpleQuery class encapsulates the simple query data. An array of these
// is created containing an element for each category to use this refresh
// function.
//-----------------------------------------------------------------------------

class CSimpleQuery
{
public:
	CSimpleQuery(DWORD dwIndex, LPCTSTR szClass, LPCTSTR szProperties, UINT uiColumns, BOOL fShowResources = FALSE, BOOL fBlankDividers = FALSE) :
	  m_dwIndex(dwIndex),
	  m_strClass(szClass),
	  m_strProperties(szProperties),
	  m_uiColumns(uiColumns),
	  m_fBlankDividers(fBlankDividers),
	  m_fShowResources(fShowResources) {};
	~CSimpleQuery() {};

public:
	DWORD		m_dwIndex;			// the index of this particular query
	CString		m_strClass;			// name of WMI class to enumerate
	CString		m_strProperties;	// properties to enumerate (in order displayed, comma delimited)
	BOOL		m_fShowResources;	// show resources used (must be two column "item|value" format)
	UINT		m_uiColumns;		// resource ID for the string containing the data to go in columns
	BOOL		m_fBlankDividers;	// insert a blank line between each instance
};

// TBD - need to mark some items as advanced

CSimpleQuery aSimpleQueries[] = 
{
	CSimpleQuery(QUERY_CDROM, _T("Win32_CDRomDrive"), _T("Drive, Description, MediaLoaded, MediaType, Name, Manufacturer, Status, TransferRate, MSIAdvancedSCSITargetId, MSIAdvancedPNPDeviceID"), IDS_CDROMCOLUMNS, TRUE, TRUE),
	CSimpleQuery(QUERY_SERVICES, _T("Win32_Service"), _T("DisplayName, Name, State, StartMode, ServiceType, PathName, ErrorControl, StartName, TagId"), IDS_SERVICES1, FALSE),
	CSimpleQuery(QUERY_PROGRAMGROUP, _T("Win32_ProgramGroup"), _T("GroupName, Name, UserName"), IDS_PROGRAMGROUP1, FALSE),
	CSimpleQuery(QUERY_STARTUP, _T("Win32_StartupCommand"), _T("Caption, Command, User, Location"), IDS_STARTUP1, FALSE),
	CSimpleQuery(QUERY_KEYBOARD, _T("Win32_Keyboard"), _T("Description, Name, Layout, MSIAdvancedPNPDeviceID, NumberOfFunctionKeys"), IDS_KEYBOARD1, TRUE, TRUE),
	CSimpleQuery(QUERY_POINTDEV, _T("Win32_PointingDevice"), _T("HardwareType, NumberOfButtons, Status, MSIAdvancedPNPDeviceID, MSIAdvancedPowerManagementSupported, MSIAdvancedDoubleSpeedThreshold, MSIAdvancedHandedness"), IDS_POINTDEV1, TRUE, TRUE),
	CSimpleQuery(QUERY_MODEM, _T("Win32_POTSModem"), _T("Caption, Description, DeviceID, DeviceType, AttachedTo, AnswerMode, MSIAdvancedPNPDeviceID, MSIAdvancedProviderName, MSIAdvancedModemInfPath, MSIAdvancedModemInfSection, MSIAdvancedBlindOff, MSIAdvancedBlindOn, CompressionOff, CompressionOn, ErrorControlForced, ErrorControlOff, ErrorControlOn, MSIAdvancedFlowControlHard, MSIAdvancedFlowControlOff, MSIAdvancedFlowControlSoft, MSIAdvancedDCB, MSIAdvancedDefault, MSIAdvancedInactivityTimeout, MSIAdvancedModulationBell, MSIAdvancedModulationCCITT, MSIAdvancedPrefix, MSIAdvancedPulse, MSIAdvancedReset, MSIAdvancedResponsesKeyName, SpeakerModeDial, SpeakerModeOff, SpeakerModeOn, SpeakerModeSetup, SpeakerVolumeHigh, SpeakerVolumeLow, SpeakerVolumeMed, MSIAdvancedStringFormat, MSIAdvancedTerminator, MSIAdvancedTone"), IDS_MODEM1, TRUE, TRUE),
	CSimpleQuery(QUERY_NETPROT, _T("Win32_NetworkProtocol"), _T("Name, ConnectionlessService, GuaranteesDelivery, GuaranteesSequencing, MSIAdvancedMaximumAddressSize, MSIAdvancedMaximumMessageSize, MSIAdvancedMessageOriented, MSIAdvancedMinimumAddressSize, MSIAdvancedPseudoStreamOriented, MSIAdvancedSupportsBroadcasting, MSIAdvancedSupportsConnectData, MSIAdvancedSupportsDisconnectData, MSIAdvancedSupportsEncryption, MSIAdvancedSupportsExpeditedData, MSIAdvancedSupportsGracefulClosing, MSIAdvancedSupportsGuaranteedBandwidth, MSIAdvancedSupportsMulticasting"), IDS_NETPROT1, FALSE, TRUE),
	CSimpleQuery(QUERY_ENVVAR, _T("Win32_Environment"), _T("Name, VariableValue, UserName"), IDS_ENVVAR1, FALSE),
	CSimpleQuery(QUERY_SOUNDDEV, _T("Win32_SoundDevice"), _T("Caption, Manufacturer, Status, MSIAdvancedPNPDeviceID"), IDS_SOUNDDEV1, TRUE, TRUE),
	CSimpleQuery(QUERY_DISPLAY, _T("Win32_VideoController"), _T("Name, MSIAdvancedPNPDeviceID, VideoProcessor, AdapterCompatibility, MSIAdvancedDescription, MSIAdvancedAdapterRAM, MSIAdvancedInstalledDisplayDrivers, DriverVersion, MSIAdvancedInfFilename, MSIAdvancedInfSection, MSIAdvancedNumberOfColorPlanes, MSIAdvancedCurrentNumberOfColors, CurrentHorizontalResolution, CurrentVerticalResolution, CurrentRefreshRate, CurrentBitsPerPixel"), IDS_DISPLAY1, TRUE, TRUE),
	CSimpleQuery(QUERY_INFRARED, _T("Win32_InfraredDevice"), _T("Caption"), IDS_INFRARED1, TRUE, TRUE),
	CSimpleQuery(QUERY_PARALLEL, _T("Win32_ParallelPort"), _T("Name, MSIAdvancedPNPDeviceID"), IDS_PARALLEL1, TRUE, TRUE),
	CSimpleQuery(QUERY_PRINTER, _T("Win32_Printer"), _T("Name, DriverName, PortName, ServerName"), IDS_PRINTER1, FALSE),
	CSimpleQuery(QUERY_NETCONNECTION, _T("Win32_NetworkConnection"), _T("LocalName, RemoteName, ResourceType, ConnectionType, UserName"), IDS_NETCONNECTION1, FALSE),
	CSimpleQuery(QUERY_DRIVER, _T("Win32_SystemDriver"), _T("Name, Description, PathName, ServiceType, Started, StartMode, State, Status, ErrorControl, AcceptPause, AcceptStop"), IDS_DRIVER1, FALSE),
	CSimpleQuery(QUERY_SIGNEDDRIVER, _T("Win32_PnPSignedDriver"), _T("DeviceName, IsSigned, DeviceClass, DriverVersion, DriverDate, Manufacturer, InfName, DriverName, DeviceID"), IDS_SIGNEDDRIVER1, FALSE),
	CSimpleQuery(QUERY_IDE, _T("Win32_IDEController"), _T("Caption, Manufacturer, Status, PNPDeviceID"), IDS_IDE1, TRUE, TRUE),
	CSimpleQuery(QUERY_SCSI, _T("Win32_SCSIController"), _T("Caption, Manufacturer, Status, MSIAdvancedPNPDeviceID"), IDS_SCSI1, TRUE, TRUE),
	CSimpleQuery(QUERY_PRINTJOBS, _T("Win32_PrintJob"), _T("Document, Size, Owner, Notify, Status, TimeSubmitted, StartTime, UntilTime, ElapsedTime, PagesPrinted, JobId, Priority, Parameters, DriverName, PrintProcessor, HostPrintQueue, DataType, Name"), IDS_PRINTJOBS1, FALSE),
	CSimpleQuery(0, _T(""), _T(""), 0)
};

//-----------------------------------------------------------------------------
// The refresh function which processes the simple query. The correct query
// is found in the query array. For each instance of the class, the column
// data will be inserted into the array of column values, and the format
// flags will be replaced with the actual data.
//-----------------------------------------------------------------------------

BOOL ProcessColumnString(CMSIValue * pValue, CWMIObject * pObject, CString * pstrProperties);
BOOL GetResourcesFromPNPID(CWMIHelper * pWMI, CResourceMap * pResourceMap, LPCTSTR szPNPID, CPtrList * aColValues);

HRESULT NetAdapter(CWMIHelper * pWMI, volatile BOOL * pfCancel, CPtrList * aColValues, int iColCount, CResourceMap * pResourceMap);
HRESULT SerialPort(CWMIHelper * pWMI, volatile BOOL * pfCancel, CPtrList * aColValues, int iColCount, CResourceMap * pResourceMap);

HRESULT SimpleQuery(CWMIHelper * pWMI, DWORD dwIndex, volatile BOOL * pfCancel, CPtrList * aColValues, int iColCount, void ** ppCache)
{
	HRESULT hr = S_OK;

	// Find the correct query.

	CSimpleQuery * pQuery = aSimpleQueries;
	while (pQuery->m_dwIndex && pQuery->m_dwIndex != dwIndex)
		pQuery++;

	if (pQuery->m_dwIndex != dwIndex && dwIndex != QUERY_NETADAPTER && dwIndex != QUERY_SERIALPORT)
	{
		ASSERT(0 && "bad dwIndex to SimpleQuery()");
		return E_FAIL;
	}

	// Make sure we have a resource map (or can create one).

	if (ppCache)
	{
		if (pWMI && *ppCache == NULL)
		{
			*ppCache = (void *) new CResourceMap;
			if (*ppCache)
			{
				hr = ((CResourceMap *) *ppCache)->Initialize(pWMI);
				if (FAILED(hr))
				{
					delete ((CResourceMap *) *ppCache);
					*ppCache = (void *) NULL;
				}
			}
		}
		else if (pWMI == NULL && *ppCache)
		{
			delete ((CResourceMap *) *ppCache);
			return S_OK;
		}
	}
	CResourceMap * pResourceMap = (CResourceMap *) *ppCache;

	// This is a nice way to cache to resource map for multiple functions, but it's
	// a monumental pain when we remote to a different machine:
	//
	// CResourceMap * pResourceMap = gResourceMap.GetResourceMap(pWMI);
	// if (pResourceMap == NULL)
	// 	return hr;

	// Check to see if this is one of the special case queries.

	if (dwIndex == QUERY_NETADAPTER)
		return NetAdapter(pWMI, pfCancel, aColValues, iColCount, pResourceMap);

	if (dwIndex == QUERY_SERIALPORT)
		return SerialPort(pWMI, pfCancel, aColValues, iColCount, pResourceMap);

	// Enumerate the requested class.

	CWMIObjectCollection * pCollection = NULL;
	hr = pWMI->Enumerate(pQuery->m_strClass, &pCollection, pQuery->m_strProperties);
	if (SUCCEEDED(hr))
	{
		CWMIObject * pObject = NULL;
		while (S_OK == pCollection->GetNext(&pObject))
		{
			CString strProperties = pQuery->m_strProperties;

			// If this is the second or later iteration, then we should add a blank
			// set of entries to the columns.

			if (pQuery->m_fBlankDividers)
				pWMI->AppendBlankLine(aColValues, iColCount);

			pWMI->AddObjectToOutput(aColValues, iColCount, pObject, strProperties, pQuery->m_uiColumns);

			// If so marked, we should see what resources (drivers, IRQs, etc.) are
			// associated with this object and add them to the list.

			if (pQuery->m_fShowResources)
			{
				ASSERT(iColCount == 2);
				CString strPNPID = pObject->GetString(_T("PNPDeviceID"));
				if (!strPNPID.IsEmpty())
					GetResourcesFromPNPID(pWMI, pResourceMap, strPNPID, aColValues);
			}
		}

		delete pObject;
		delete pCollection;
	}

	return hr;
}

//-----------------------------------------------------------------------------
// Given a resource map and a PNP ID string, this function will add all the
// resources used by that PNP device (IRQs, drivers, etc.) to a two column
// array of string lists.
//-----------------------------------------------------------------------------

BOOL GetResourcesFromPNPID(CWMIHelper * pWMI, CResourceMap * pResourceMap, LPCTSTR szPNPID, CPtrList * aColValues)
{
	CString		strPath, strResourcePath;
	CString		strPNPDeviceID(szPNPID);

	StringReplace(strPNPDeviceID, _T("\\"), _T("\\\\"));
	strPath.Format(_T("Win32_PnPEntity.DeviceID=\"%s\""), strPNPDeviceID);

	CStringList * pResourceList = pResourceMap->Lookup(strPath);
	if (pResourceList)
	{
		::AfxSetResourceHandle(_Module.GetResourceInstance());
		for (POSITION pos = pResourceList->GetHeadPosition(); pos != NULL;)
		{
			strResourcePath = pResourceList->GetNext(pos);
			CWMIObject * pResourceObject;
			if (SUCCEEDED(pWMI->GetObject(strResourcePath, &pResourceObject)))
			{
				CString strClass;
				if (SUCCEEDED(pResourceObject->GetValueString(_T("__CLASS"), &strClass)))
				{
					CString strItem;
					if (strClass == _T("Win32_IRQResource"))
						strItem.LoadString(IDS_IRQCHANNEL);
					else if (strClass == _T("Win32_PortResource"))
						strItem.LoadString(IDS_IOPORT);
					else if (strClass == _T("Win32_DMAChannel"))
						strItem.LoadString(IDS_DMACHANNEL);
					else if (strClass == _T("Win32_DeviceMemoryAddress"))
						strItem.LoadString(IDS_MEMORYADDRESS);
					else if (strClass == _T("CIM_DataFile"))
						strItem.LoadString(IDS_DRIVER);

					if (!strItem.IsEmpty())
					{
						CString strValue;
						if (SUCCEEDED(pResourceObject->GetValueString(_T("Caption"), &strValue)))
						{
							if (strClass == _T("CIM_DataFile"))
							{
								CString strVersion, strDate, strSize;

								pResourceObject->GetInterpretedValue(_T("FileSize"), _T("%z"), _T('z'), &strSize, NULL);
								pResourceObject->GetValueString(_T("Version"), &strVersion);
								pResourceObject->GetInterpretedValue(_T("CreationDate"), _T("%t"), _T('t'), &strDate, NULL);

								if (!strVersion.IsEmpty() || !strDate.IsEmpty() || !strSize.IsEmpty())
									strValue += CString(_T(" (")) + strVersion + CString(_T(", ")) + strSize + CString(_T(", ")) + strDate + CString(_T(")"));
							}

							pWMI->AppendCell(aColValues[0], strItem, 0);
							pWMI->AppendCell(aColValues[1], strValue, 0);
						}
					}
				}

				delete pResourceObject;
			} // if we could get the object
		} // for enumerating through the list
	} // if there is a list

	return TRUE;
}

//-----------------------------------------------------------------------------
// The specific query for the network adapter class.
//-----------------------------------------------------------------------------

HRESULT NetAdapter(CWMIHelper * pWMI, volatile BOOL * pfCancel, CPtrList * aColValues, int iColCount, CResourceMap * pResourceMap)
{
	HRESULT hr = S_OK;

	LPCTSTR	szNetworkAdapterProperties = _T("Caption, AdapterType, MSIAdvancedProductName, MSIAdvancedInstalled, MSIAdvancedPNPDeviceID, MSIAdvancedTimeOfLastReset, MSIAdvancedIndex");
	LPCTSTR	szNetworkAdapterConfigProperties = _T("ServiceName, IPAddress, IPSubnet, DefaultIPGateway, DHCPEnabled, MSIAdvancedDHCPServer, MSIAdvancedDHCPLeaseExpires, MSIAdvancedDHCPLeaseObtained, MACAddress, Index");

	CPtrList listNetAdapterConfig;

	CWMIObjectCollection * pCollection = NULL;
	hr = pWMI->Enumerate(_T("Win32_NetworkAdapter"), &pCollection, szNetworkAdapterProperties);
	if (SUCCEEDED(hr))
	{
		CWMIObject * pObject = NULL;
		while (S_OK == pCollection->GetNext(&pObject))
		{
			pWMI->AppendBlankLine(aColValues, iColCount);
			pWMI->AddObjectToOutput(aColValues, iColCount, pObject, szNetworkAdapterProperties, IDS_NETWORKADAPTER1);

			DWORD dwIndex;
			if (SUCCEEDED(pObject->GetValueDWORD(_T("Index"), &dwIndex)))
			{
				if (listNetAdapterConfig.IsEmpty())
				{
					// Enumerate the class and cache the objects.

					CWMIObjectCollection * pConfigCollection = NULL;
					if (SUCCEEDED(pWMI->Enumerate(_T("Win32_NetworkAdapterConfiguration"), &pConfigCollection, szNetworkAdapterConfigProperties)))
					{
						CWMIObject * pConfigObject = NULL;
						while (S_OK == pConfigCollection->GetNext(&pConfigObject))
						{
							DWORD dwConfigIndex;
							if (SUCCEEDED(pConfigObject->GetValueDWORD(_T("Index"), &dwConfigIndex)))
								if (dwConfigIndex == dwIndex)
									pWMI->AddObjectToOutput(aColValues, iColCount, pConfigObject, szNetworkAdapterConfigProperties, IDS_NETWORKADAPTER2);
							
							listNetAdapterConfig.AddTail((void *)pConfigObject);
							pConfigObject = NULL;
						}

						delete pConfigObject;
						delete pConfigCollection;
					}
				}
				else
				{
					// Look through the list of cached objects.

					for (POSITION pos = listNetAdapterConfig.GetHeadPosition(); pos != NULL;)
					{
						CWMIObject * pConfigObject = (CWMIObject *)listNetAdapterConfig.GetNext(pos);
						DWORD dwConfigIndex;
						if (pConfigObject && SUCCEEDED(pConfigObject->GetValueDWORD(_T("Index"), &dwConfigIndex)))
							if (dwConfigIndex == dwIndex)
								pWMI->AddObjectToOutput(aColValues, iColCount, pConfigObject, szNetworkAdapterConfigProperties, IDS_NETWORKADAPTER2);
					}
				}
			}

			CString strPNPID = pObject->GetString(_T("PNPDeviceID"));
			if (!strPNPID.IsEmpty())
				GetResourcesFromPNPID(pWMI, pResourceMap, strPNPID, aColValues);
		}
		delete pObject;
		delete pCollection;

		while (!listNetAdapterConfig.IsEmpty())
		{
			CWMIObject * pDeleteObject = (CWMIObject *)listNetAdapterConfig.RemoveHead();
			if (pDeleteObject)
				delete pDeleteObject;
		}
	}

	return hr;
}

//-----------------------------------------------------------------------------
// The specific query for the serial port class.
// 
// TBD - cache the config values to save re-enumerating.
//-----------------------------------------------------------------------------

HRESULT SerialPort(CWMIHelper * pWMI, volatile BOOL * pfCancel, CPtrList * aColValues, int iColCount, CResourceMap * pResourceMap)
{
	HRESULT hr = S_OK;

	LPCTSTR	szSerialPortProperties = _T("Name, Status, MSIAdvancedPNPDeviceID, MSIAdvancedMaximumInputBufferSize, MSIAdvancedMaximumOutputBufferSize, MSIAdvancedSettableBaudRate, MSIAdvancedSettableDataBits, MSIAdvancedSettableFlowControl, MSIAdvancedSettableParity, MSIAdvancedSettableParityCheck, MSIAdvancedSettableStopBits, MSIAdvancedSettableRLSD, MSIAdvancedSupportsRLSD, MSIAdvancedSupports16BitMode, MSIAdvancedSupportsSpecialCharacters, MSIAdvancedDeviceID");
	LPCTSTR	szSerialPortConfigProperties = _T("BaudRate, BitsPerByte, StopBits, Parity, IsBusy, MSIAdvancedAbortReadWriteOnError, MSIAdvancedBinaryModeEnabled, MSIAdvancedContinueXMitOnXOff, MSIAdvancedCTSOutflowControl, MSIAdvancedDiscardNULLBytes, MSIAdvancedDSROutflowControl, MSIAdvancedDSRSensitivity, MSIAdvancedDTRFlowControlType, MSIAdvancedEOFCharacter, MSIAdvancedErrorReplaceCharacter, MSIAdvancedErrorReplacementEnabled, MSIAdvancedEventCharacter, MSIAdvancedParityCheckEnabled, MSIAdvancedRTSFlowControlType, MSIAdvancedXOffCharacter, MSIAdvancedXOffXMitThreshold, MSIAdvancedXOnCharacter, MSIAdvancedXOnXMitThreshold, MSIAdvancedXOnXOffInFlowControl, MSIAdvancedXOnXOffOutFlowControl, Name");

	CWMIObjectCollection * pCollection = NULL;
	hr = pWMI->Enumerate(_T("Win32_SerialPort"), &pCollection, szSerialPortProperties);
	if (SUCCEEDED(hr))
	{
		CWMIObject * pObject = NULL;
		while (S_OK == pCollection->GetNext(&pObject))
		{
			pWMI->AppendBlankLine(aColValues, iColCount);
			pWMI->AddObjectToOutput(aColValues, iColCount, pObject, szSerialPortProperties, IDS_SERIALPORT1);

			CString strDeviceID;
			if (SUCCEEDED(pObject->GetValueString(_T("DeviceID"), &strDeviceID)))
			{
				CWMIObjectCollection * pConfigCollection = NULL;
				if (SUCCEEDED(pWMI->Enumerate(_T("Win32_SerialPortConfiguration"), &pConfigCollection, szSerialPortConfigProperties)))
				{
					CWMIObject * pConfigObject = NULL;
					while (S_OK == pConfigCollection->GetNext(&pConfigObject))
					{
						CString strConfigDeviceID;
						if (SUCCEEDED(pConfigObject->GetValueString(_T("Name"), &strConfigDeviceID)))
							if (strDeviceID.CompareNoCase(strConfigDeviceID) == 0)
								pWMI->AddObjectToOutput(aColValues, iColCount, pConfigObject, szSerialPortConfigProperties, IDS_SERIALPORT2);
					}
					delete pConfigObject;
					delete pConfigCollection;
				}
			}

			CString strPNPID = pObject->GetString(_T("PNPDeviceID"));
			if (!strPNPID.IsEmpty())
				GetResourcesFromPNPID(pWMI, pResourceMap, strPNPID, aColValues);
		}
		delete pObject;
		delete pCollection;
	}

	return hr;
}