// <copyright file = VersionInfo.cs" company = "Testing Mentor">
// Copyright © 2010 All Rights Reserved. Test developers can simply copy and
// paste the code into their code, but may not reproduce or publish the code
// snippets on any web site, online service, or distribute as source on any
// media without express written permission. </copyright>

namespace TestingMentor.Snippet.OperatingSystemVersionInfo
{
  using System;
  using System.Runtime.InteropServices;

  /// <summary>
  /// This class gets Windows operating system version information to better
  /// control flow of automated test case (uint)s based on platform profiles, or
  /// to provide information about the operating system a distributed test
  /// is executed on for troubleshooting purposes.
  /// </summary>
  public class WindowsVersionInfo
  {
    #region PUBLIC PROPERTIES
    /// <summary>
    /// Gets the operating system version information
    /// </summary>
    public string GetOSVersion
    {
      get { return this.GetOSVersionInfo(); }
    }

    /// <summary>
    /// Gets the Service Pack information
    /// </summary>
    public string GetServicePack
    {
      get { return this.GetServicePackInfo(); }
    }

    /// <summary>
    /// Gets the Product Type information
    /// </summary>
    public string GetProductType
    {
      get { return this.GetProductTypeInfo(); }
    }
    #endregion PUBLIC PROPERTIES

    #region PRIVATE METHODS
    /// <summary>
    /// This method gets the version of currently supported Windows operating
    /// systems based on the major and minor version numbers and other
    /// information in OSVERSIONINFOEX struct
    /// </summary>
    /// <returns>A string indicating the Windows OS; otherwise a string
    /// indicating the OS is unsupported.</returns>
    private string GetOSVersionInfo()
    {
      string version = "Unsupported Version";

      NativeMethods.OSVersionInfoEx osvi = new NativeMethods.OSVersionInfoEx();
      osvi.VersionInfoSize = 
        Marshal.SizeOf(typeof(NativeMethods.OSVersionInfoEx));
      NativeMethods.GetVersionEx(ref osvi);

      if (OsviConstant.SupportedPlatform == osvi.PlatformId &&
        osvi.MajorVersion > 4)
      {
        if (osvi.MajorVersion == (int)OsviConstant.MajorVersion.NT5 &&
          osvi.MinorVersion == (int)OsviConstant.MinorVersion.Windows2000)
        {
          version = "Windows 2000";
        }

        if (osvi.MajorVersion == (int)OsviConstant.MajorVersion.NT5 &&
          osvi.MinorVersion == (int)OsviConstant.MinorVersion.WindowsXP)
        {
          version = "Windows XP";
        }

        if (osvi.MajorVersion == (int)OsviConstant.MajorVersion.NT5 &&
          osvi.MinorVersion == (int)OsviConstant.MinorVersion.WindowsServer2003)
        {
          if (osvi.ProductType == (byte)OsviConstant.WorkStation)
          {
            version = "Windows XP Professional x64";
          }
          else
          {
            version = "Windows Server 2003";
            if (NativeMethods.GetSystemMetrics(OsviConstant.ServerR2) != 0)
            {
              version += " R2";
            }
          }
        }

        if (osvi.MajorVersion == (int)OsviConstant.MajorVersion.NT6 &&
          osvi.MinorVersion == (int)OsviConstant.MinorVersion.WindowsVista)
        {
          if (osvi.ProductType ==
            (byte)OsviConstant.WorkStation)
          {
            version = "Windows Vista";
          }
          else
          {
            version = "Windows Server 2008";
          }
        }

        if (osvi.MajorVersion == (int)OsviConstant.MajorVersion.NT6 &&
          osvi.MinorVersion == (int)OsviConstant.MinorVersion.Windows7)
        {
          if (osvi.ProductType == (byte)OsviConstant.WorkStation)
          {
            version = "Windows 7";
          }
          else
          {
            version = "Windows Server 2008 R2";
          }
        }
      }

      return version;
    }

    /// <summary>
    /// This method gets the service pack information for the current operating
    /// system.
    /// </summary>
    /// <returns>A string indicating the Service Pack installed; otherwise an
    /// empty string</returns>
    private string GetServicePackInfo()
    {
      NativeMethods.OSVersionInfoEx versionInfo = new NativeMethods.OSVersionInfoEx();
      versionInfo.VersionInfoSize = Marshal.SizeOf(typeof(NativeMethods.OSVersionInfoEx));
      NativeMethods.GetVersionEx(ref versionInfo);
      return versionInfo.CSDVersion; 
    }

    /// <summary>
    /// This method gets the product type information for Windows Vista and
    /// newer releases of the Windows family of operating systems
    /// </summary>
    /// <returns>A string indicating the OS product type; otherwise an empty
    /// string.</returns>
    private string GetProductTypeInfo()
    {
      string product = String.Empty;

      NativeMethods.OSVersionInfoEx osvi = new NativeMethods.OSVersionInfoEx();
      osvi.VersionInfoSize =
        Marshal.SizeOf(typeof(NativeMethods.OSVersionInfoEx));
      NativeMethods.GetVersionEx(ref osvi);

      if (osvi.MajorVersion > 5)
      {
        uint productType = 0;

        NativeMethods.GetProductInfo(
          osvi.MajorVersion,
          osvi.MinorVersion,
          osvi.ServicePackMajor,
          osvi.ServicePackMinor,
          ref productType);

        switch (productType)
        {
          case (uint)OsviConstant.ProductInfo.Business:
            product = "Business Edition";
            break;
          case (uint)OsviConstant.ProductInfo.BusinessN:
            product = "Business N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.ClusterServer:
            product = "HPC Edition";
            break;
          case (uint)OsviConstant.ProductInfo.DatacenterServer:
            product = "Server Datacenter (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.DatacenterServerCore:
            product = "Server Datacenter (Core)";
            break;
          case (uint)OsviConstant.ProductInfo.DataCenterServerCoreV:
            product = "Server Datacenter without Hyper-V (Core)";
            break;
          case (uint)OsviConstant.ProductInfo.DataCenterServerV:
            product = "Server Datacenter without Hyper-V (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.Enterprise:
            product = "Enterprise Edition";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseE:
            product = "Enterprise E Edition";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseN:
            product = "Enterprise N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseServer:
            product = "Server Enterprise (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseServerCore:
            product = "Server Enterprise (Core)";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseServerCoreV:
            product = "Server Enterprise without Hyper-V (Core)";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseServerIA64:
            product = "Server Enterprise for Itanium-based Systems";
            break;
          case (uint)OsviConstant.ProductInfo.EnterpriseServerV:
            product = "Server Enterprise without Hyper-V (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.HomeBasic:
            product = "Home Basic Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HomeBasicE:
            product = "Home Basic E Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HomeBasicN:
            product = "Home Basic N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HomePremium:
            product = "Home Premium Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HomePremiumE:
            product = "Home Premium E Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HomePremiumN:
            product = "Home Premium N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HomeServer:
            product = "Home Server Edition";
            break;
          case (uint)OsviConstant.ProductInfo.HyperV:
            product = "Microsoft Hyper-V Server";
            break;
          case (uint)OsviConstant.ProductInfo.MediumBusinessServerManagement:
            product = "Windows Essential Business Server Management Server";
            break;
          case (uint)OsviConstant.ProductInfo.MediumBusinessServerMessaging:
            product = "Windows Essential Business Server Messaging Server";
            break;
          case (uint)OsviConstant.ProductInfo.MediumBusinessServerSecurity:
            product = "Windows Essential Business Server Security Server";
            break;
          case (uint)OsviConstant.ProductInfo.Professional:
            product = "Professional Edition";
            break;
          case (uint)OsviConstant.ProductInfo.ProfessionalE:
            product = "Professional E Edition";
            break;
          case (uint)OsviConstant.ProductInfo.ProfessionalN:
            product = "Professional N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.ServerForSmallBusiness:
            product = "Windows Server 2008 for Windows Essential Server Solutions";
            break;
          case (uint)OsviConstant.ProductInfo.ServerForSmallBusinessV:
            product = "Windows Server 2008 without Hyper-V for Windows Essential Server Solutions";
            break;
          case (uint)OsviConstant.ProductInfo.ServerFoundation:
            product = "Server Foundation";
            break;
          case (uint)OsviConstant.ProductInfo.SmallBusinessServer:
            product = "Windows Small Business Server";
            break;
          case (uint)OsviConstant.ProductInfo.SmallBusinessServerPremium:
            product = "Windows Small Busines Server Premium";
            break;
          case (uint)OsviConstant.ProductInfo.StandardServer:
            product = "Server Standard (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.StandardServerCore:
            product = "Server Standard (Core)";
            break;
          case (uint)OsviConstant.ProductInfo.StandardServerCoreV:
            product = "Server Standard without Hyper-V (Core)";
            break;
          case (uint)OsviConstant.ProductInfo.StandardServerV:
            product = "Server Standard without Hyper-V (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.Starter:
            product = "Starter Edition";
            break;
          case (uint)OsviConstant.ProductInfo.StarterE:
            product = "Starter E Edition";
            break;
          case (uint)OsviConstant.ProductInfo.StarterN:
            product = "Starter N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.StorageEnterpriseServer:
            product = "Storage Server Enterprise";
            break;
          case (uint)OsviConstant.ProductInfo.StorageExpressServer:
            product = "Storage Server Express";
            break;
          case (uint)OsviConstant.ProductInfo.StorageStandardServer:
            product = "Storage Server Standard";
            break;
          case (uint)OsviConstant.ProductInfo.StorageWorkgroupServer:
            product = "Storage Server Workgroup";
            break;
          case (uint)OsviConstant.ProductInfo.Ultimate:
            product = "Ultimate Edition";
            break;
          case (uint)OsviConstant.ProductInfo.UltimateE:
            product = "Ultimate E Edition";
            break;
          case (uint)OsviConstant.ProductInfo.UltimateN:
            product = "Ulitmate N Edition";
            break;
          case (uint)OsviConstant.ProductInfo.Undefined:
            product = "Unknown Product";
            break;
          case (uint)OsviConstant.ProductInfo.Unlicensed:
            product = "Unlicensed or Expired";
            break;
          case (uint)OsviConstant.ProductInfo.WebServer:
            product = "Web Server (Full)";
            break;
          case (uint)OsviConstant.ProductInfo.WebServerCore:
            product = "Web Server (Core)";
            break;
        }
      }

      return product;
    }

    #endregion PRIVATE METHODS
  }
 
// ****************************************************************************
// NEW CLASS - SHOULD BE PLACED IN SEPARATE FILE
// ****************************************************************************
  
  /// <summary>
  /// This class contains constant values for version information
  /// </summary>
  internal class OsviConstant
  {
    /// <summary>
    /// Constant value for supported platforms as indicated by PlatformID
    /// </summary>
    internal const int SupportedPlatform = 2;

    /// <summary>
    /// Constant value indicating R2 release of Windows Server used by 
    /// GetSystemMetrics function
    /// </summary>
    internal const int ServerR2 = 89;

    /// <summary>
    /// Constant value indicating the OS ProductType is a workstation
    /// </summary>
    internal const int WorkStation = 0x00000001;

    /// <summary>
    /// Prevents a default instance of the OsviConstant class from being
    /// created.
    /// </summary>
    private OsviConstant()
    {
    }

    /// <summary>
    /// Constant values for Windows kernel major versions
    /// </summary>
    internal enum MajorVersion
    {
      /// <summary>
      /// Major kernel versions pre-Vista
      /// </summary>
      NT5 = 5,

      /// <summary>
      /// Major kernel versions Vista and higher
      /// </summary>
      NT6 = 6
    }

    /// <summary>
    /// Constant values for Windows kernel minor versions
    /// </summary>
    internal enum MinorVersion
    {
      /// <summary>
      /// Minor kernel versions for Windows 2000
      /// </summary>
      Windows2000 = 0,

      /// <summary>
      /// Minor kernel versions for Window XP
      /// </summary>
      WindowsXP = 1,

      /// <summary>
      /// Minor kernel versions for Windows Server 2003 
      /// </summary>
      WindowsServer2003 = 2,

      /// <summary>
      /// Minor kernel versions for Windows Vista
      /// </summary>
      WindowsVista = 0,

      /// <summary>
      /// Minor kernel versions for Windows 7
      /// </summary>
      Windows7 = 1
    }

    /// <summary>
    /// Constant values for Windows product type
    /// </summary>
    internal enum ProductInfo : uint
    {
      /// <summary>
      /// Business 
      /// </summary>
      Business = 0x00000006,
  
      /// <summary>
      /// Business N
      /// </summary>
      BusinessN = 0x00000010,

      /// <summary>
      /// HPC Edition 
      /// </summary>
      ClusterServer = 0x00000012,

      /// <summary>
      /// Server Datacenter (full installation)
      /// </summary>
      DatacenterServer = 0x00000008,

      /// <summary>
      /// Server Datacenter (core installation)
      /// </summary>
      DatacenterServerCore = 0x0000000C,

      /// <summary>
      /// Server Datacenter without Hyper-V (core installation)
      /// </summary>
      DataCenterServerCoreV = 0x00000027,

      /// <summary>
      /// Server Datacenter without Hyper-V (full installation)
      /// </summary>
      DataCenterServerV = 0x00000025,

      /// <summary>
      /// Enterprise 
      /// </summary>
      Enterprise = 0x00000004,

      /// <summary>
      /// Enterprise E
      /// </summary>
      EnterpriseE = 0x00000046,

      /// <summary>
      /// Enterprise N
      /// </summary>
      EnterpriseN = 0x0000001B,

      /// <summary>
      /// Server Enterprise (full installation)
      /// </summary>
      EnterpriseServer = 0x0000000A,

      /// <summary>
      /// Server Enterprise (core installation)
      /// </summary>
      EnterpriseServerCore = 0x0000000E,

      /// <summary>
      /// Server Enterprise without Hyper-V (core installation)
      /// </summary>
      EnterpriseServerCoreV = 0x00000029,

      /// <summary>
      /// Server Enterprise for Itanium-based Systems
      /// </summary>
      EnterpriseServerIA64 = 0x0000000F,

      /// <summary>
      /// Server Enterprise without Hyper-V (full installation)
      /// </summary>
      EnterpriseServerV = 0x00000026,

      /// <summary>
      /// Home Basic 
      /// </summary>
      HomeBasic = 0x00000002,
  
      /// <summary>
      /// Home Basic E
      /// </summary>
      HomeBasicE = 0x00000043,

      /// <summary>
      /// Home Basic N
      /// </summary>
      HomeBasicN = 0x00000005,

      /// <summary>
      /// Home Premium 
      /// </summary>
      HomePremium = 0x00000003,

      /// <summary>
      /// Home Premium E
      /// /// </summary>
      HomePremiumE = 0x00000044,

      /// <summary>
      /// Home Premium N
      /// </summary>
      HomePremiumN = 0x0000001A,

      /// <summary>
      /// Microsoft Hyper-V Server
      /// </summary>
      HyperV = 0x0000002A,

      /// <summary>
      /// Windows Essential Business Server Management Server
      /// </summary>
      MediumBusinessServerManagement = 0x0000001E,

      /// <summary>
      /// Windows Essential Business Server Security Server
      /// </summary>
      MediumBusinessServerSecurity = 0x0000001F,

      /// <summary>
      /// Windows Essential Business Server Messaging Server
      /// </summary>
      MediumBusinessServerMessaging = 0x00000020,

      /// <summary>
      /// Professional 
      /// </summary>
      Professional = 0x00000030,

      /// <summary>
      /// Professional E
      /// </summary>
      ProfessionalE = 0x00000045,

      /// <summary>
      /// Professional N
      /// </summary>
      ProfessionalN = 0x00000031,

      /// <summary>
      /// Windows Server 2008 for Windows Essential Server Solutions
      /// </summary>
      ServerForSmallBusiness = 0x00000018,

      /// <summary>
      /// Windows Server 2008 without Hyper-V for Windows Essential Server
      /// Solutions
      /// </summary>
      ServerForSmallBusinessV = 0x00000023,

      /// <summary>
      /// Server Foundation
      /// </summary>
      ServerFoundation = 0x00000021,

      /// <summary>
      /// Windows Small Business Server
      /// </summary>
      SmallBusinessServer = 0x00000009,

      /// <summary>
      /// Server Standard (full installation)
      /// </summary>
      StandardServer = 0x00000007,

      /// <summary>
      /// Server Standard (core installation)
      /// </summary>
      StandardServerCore = 0x0000000D,

      /// <summary>
      /// Server Standard without Hyper-V (core installation)
      /// </summary>
      StandardServerCoreV = 0x00000028,

      /// <summary>
      /// Server Standard without Hyper-V (full installation)
      /// </summary>
      StandardServerV = 0x00000024,

      /// <summary>
      /// Starter
      /// </summary>
      Starter = 0x0000000B,

      /// <summary>
      /// Starter E
      /// </summary>
      StarterE = 0x00000042,

      /// <summary>
      /// Starter N
      /// </summary>
      StarterN = 0x0000002F,

      /// <summary>
      /// Storage Server Enterprise
      /// </summary>
      StorageEnterpriseServer = 0x00000017,

      /// <summary>
      /// Storage Server Express
      /// </summary>
      StorageExpressServer = 0x00000014,

      /// <summary>
      /// Storage Server Standard
      /// </summary>
      StorageStandardServer = 0x00000015,

      /// <summary>
      /// Storage Server Workgroup
      /// </summary>
      StorageWorkgroupServer = 0x00000016,

      /// <summary>
      /// An unknown product
      /// </summary>
      Undefined = 0x00000000,

      /// <summary>
      /// Ultimate
      /// </summary>
      Ultimate = 0x00000001,

      /// <summary>
      /// Ultimate E
      /// </summary>
      UltimateE = 0x00000047,

      /// <summary>
      /// Ultimate N
      /// </summary>
      UltimateN = 0x0000001C,

      /// <summary>
      /// Web Server (full installation)
      /// </summary>
      WebServer = 0x00000011,

      /// <summary>
      /// Web Server (core installation)
      /// </summary>
      WebServerCore = 0x0000001D,

      /// <summary>
      /// Unlicensed or expired product
      /// </summary>
      Unlicensed = 0xABCDABCD,
      
      /// <summary>
      /// Home Server
      /// </summary>
      HomeServer = 0x00000013,

      /// <summary>
      /// Small Business Server Premium
      /// </summary>
      SmallBusinessServerPremium = 0x00000019,
    }
  }

// ****************************************************************************
// NEW CLASS - SHOULD BE PLACED IN SEPARATE FILE
// ****************************************************************************

  /// <summary>
  /// This class contains Win32 functions used to get OS Version Info
  /// </summary>
  internal class NativeMethods
  {
    /// <summary>
    /// Prevents a default instance of the NativeMethods class from being
    /// created.
    /// </summary>
    private NativeMethods()
    {
    }

    /// <summary>
    /// This method retrives information about the current operating system 
    /// </summary>
    /// <param name="osvi">Reference to the OSVersionInfoEx struct that 
    /// receives the operating system information</param>
    /// <returns>True if the function succeeds; otherwise false</returns>
    [DllImport("kernel32")]
    [return: MarshalAs(UnmanagedType.Bool)]
    internal static extern bool GetVersionEx(ref OSVersionInfoEx osvi);

    /// <summary>
    /// Retrieves the product type for the operating system on the local
    /// computer, and maps the type to the product types supported by the
    /// specified operating system.
    /// </summary>
    /// <param name="osMajorVersion">The major version number of the 
    /// operating system. The minimum value is 6.</param>
    /// <param name="osMinorVersion">The minor version number of the 
    /// operating system. The minimum value is 0.</param>
    /// <param name="spMajorVersion">The major version number of the
    /// operating system service pack. The minimum value is 0.</param>
    /// <param name="spMinorVersion">The minor version number of the 
    /// operating system service pack. The minimum value is 0.</param>
    /// <param name="type">The product type. This parameter cannot be NULL.
    /// If the specified operating system is less than the current operating
    /// system, this information is mapped to the types supported by the 
    /// specified operating system. If the specified operating system is
    /// greater than the highest supported operating system, this information
    /// is mapped to the types supported by the current operating system.If the
    /// product has not been activated and is no longer in the grace period,
    /// this parameter is set to PRODUCT_UNLICENSED (0xABCDABCD). Otherwise,
    /// this parameter can be one of the following values.</param>
    /// <returns>True if the function succeeds; otherwise false.</returns>
    [DllImport("kernel32.dll")]
    [return: MarshalAs(UnmanagedType.Bool)]
    internal static extern bool GetProductInfo(
      int osMajorVersion,
      int osMinorVersion,
      int spMajorVersion,
      int spMinorVersion,
      ref uint type);

    /// <summary>
    /// Retrieves the specified system metric or system configuration setting.
    /// </summary>
    /// <param name="index">The system metric or configuration setting to be
    /// retrieved.</param>
    /// <returns>A non-zero value if the function succeeds; otherwise 0.</returns>
    [DllImport("kernel32.dll")]
    internal static extern int GetSystemMetrics(
      int index);

    /// <summary>
    /// Contains operating system version information. The information includes
    /// major and minor version numbers, a build number, a platform identifier,
    /// and information about product suites and the latest Service Pack 
    /// installed on the system.
    /// </summary>
    [StructLayout(LayoutKind.Sequential)]
    internal struct OSVersionInfoEx
    {
      /// <summary>
      /// The size of this data structure, in bytes
      /// </summary>
      public int VersionInfoSize;

      /// <summary>
      /// The major version number of the operating system
      /// </summary>
      public int MajorVersion;

      /// <summary>
      /// The minor version number of the operating system
      /// </summary>
      public int MinorVersion;

      /// <summary>
      /// The build number of the operating system
      /// </summary>
      public int BuildNumber;

      /// <summary>
      /// The operating system platform. This member should be
      /// VER_PLATFORM_WIN32_NT (2).
      /// </summary>
      public int PlatformId;

      /// <summary>
      /// A null-terminated string that indicates the latest Service Pack
      /// installed on the system. If no Service Pack has been installed, the
      /// string is empty.
      /// </summary>
      [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
      public string CSDVersion;

      /// <summary>
      /// The major version number of the latest Service Pack installed on the
      /// system
      /// </summary>
      public Int16 ServicePackMajor;

      /// <summary>
      /// The minor version number of the latest Service Pack installed on the
      /// system
      /// </summary>
      public Int16 ServicePackMinor;

      /// <summary>
      /// A bit mask that identifies the product suites available on the system
      /// </summary>
      public Int16 SuiteMask;

      /// <summary>
      /// Any additional information about the system
      /// </summary>
      public byte ProductType;

      /// <summary>
      /// Reserved for future use
      /// </summary>
      public byte Reserved;
    }
  }
}