Добавлен код для работы с INI-файлами от Ludvik Jerabek

LVNC-RS/IniFile.vb

@@ -1,98 +1,395 @@
-Imports System.IO
+'Date: 08\23\2010 - Ludvik Jerabek - Initial Release
-Imports System.Runtime.InteropServices
+'Version: 1.0
-Imports System.Text
+'Comment: Allow INI manipulation in .NET
+'License: CPOL
+'
+'Revisions:
+'
+'08\23\2010 - Ludvik Jerabek - Initial Release
+'11\12\2010 - Ludvik Jerabek - Fixed section regex matching on key values with brackets
+'06\20\2015 - Ludvik Jerabek - Fixed key parsing regex to account for keys with spaces in names
+'
+'
+'**DISCLAIMER**
+'THIS MATERIAL IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+'EITHER EXPRESS OR IMPLIED, INCLUDING, BUT Not LIMITED TO, THE
+'IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+'PURPOSE, OR NON-INFRINGEMENT. SOME JURISDICTIONS DO NOT ALLOW THE
+'EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSION MAY NOT
+'APPLY TO YOU. IN NO EVENT WILL I BE LIABLE TO ANY PARTY FOR ANY
+'DIRECT, INDIRECT, SPECIAL OR OTHER CONSEQUENTIAL DAMAGES FOR ANY
+'USE OF THIS MATERIAL INCLUDING, WITHOUT LIMITATION, ANY LOST
+'PROFITS, BUSINESS INTERRUPTION, LOSS OF PROGRAMS OR OTHER DATA ON
+'YOUR INFORMATION HANDLING SYSTEM OR OTHERWISE, EVEN If WE ARE
+'EXPRESSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 
-Namespace Ini
+Imports System.IO
+Imports System.Text.RegularExpressions
+Imports System.Collections
+Imports System.Diagnostics
+
+' IniFile class used to read and write ini files by loading the file into memory
 Public Class IniFile
-#Region "DLL Import"
+    ' List of IniSection objects keeps track of all the sections in the INI file
-        ''' <summary>
+    Private m_sections As Hashtable
-        ''' Записывает ключ в заданный раздел INI-файла.
+
-        ''' </summary>
+    ' Public constructor
-        ''' <param name="section">Имя раздела.</param>
+    Public Sub New()
-        ''' <param name="key">Имя ключа.</param>
+        m_sections = New Hashtable(StringComparer.InvariantCultureIgnoreCase)
-        ''' <param name="value">Значение ключа.</param>
-        ''' <param name="filePath">Путь к INI-файлу.</param>
-        <DllImport("kernel32")>
-        Private Shared Function WritePrivateProfileString(ByVal section As String, ByVal key As String, ByVal value As String, ByVal filePath As String) As Long
-        End Function
-
-        ''' <summary>
-        ''' Считывает ключ заданного раздела INI-файла.
-        ''' </summary>
-        ''' <param name="section">Имя раздела.</param>
-        ''' <param name="key">Имя ключа.</param>
-        ''' <param name="[default]"></param>
-        ''' <param name="retVal"></param>
-        ''' <param name="size"></param>
-        ''' <param name="filePath">Путь к INI-файлу.</param>
-        ''' <remarks>С помощью конструктора записываем путь до файла и его имя. </remarks>
-        <DllImport("kernel32")>
-        Private Shared Function GetPrivateProfileString(ByVal section As String, ByVal key As String, ByVal [default] As String, ByVal retVal As StringBuilder, ByVal size As Integer, ByVal filePath As String) As Integer
-        End Function
-#End Region '/DLL Import
-
-#Region "Constructor"
-        ''' <summary>
-        ''' Имя файла.
-        ''' </summary>
-        Private IniPath As String
-
-        ''' <summary>
-        ''' Читаем ini-файл и возвращаем значение указного ключа из заданной секции. 
-        ''' </summary>
-        ''' <param name="iniPath"></param>
-        Public Sub New(ByVal iniPath As String)
-            Me.IniPath = New FileInfo(iniPath).FullName.ToString
     End Sub
-#End Region
+
-
+    ' Loads the Reads the data in the ini file into the IniFile object
-#Region "INI-file Methods"
+    Public Sub Load(ByVal sFileName As String, Optional ByVal bMerge As Boolean = False)
-        ''' <summary>
+        If Not bMerge Then
-        ''' Проверяет, что заданный ключ существует в INI-файле.
+            RemoveAllSections()
-        ''' </summary>
+        End If
-        ''' <param name="section">Имя раздела.</param>
+        '  Clear the object... 
-        ''' <param name="key">Имя ключа.</param>
+        Dim tempsection As IniSection = Nothing
-        Public Function KeyExists(ByVal section As String, ByVal key As String) As Boolean
+        Dim oReader As New StreamReader(sFileName)
-            Return (Me.ReadKey(section, key).Length > 0)
+        Dim regexcomment As New Regex("^([\s]*#.*)", (RegexOptions.Singleline Or RegexOptions.IgnoreCase))
-        End Function
+        Dim regexsection As New Regex("^[\s]*\[[\s]*([^\[\s].*[^\s\]])[\s]*\][\s]*$", (RegexOptions.Singleline Or RegexOptions.IgnoreCase))
-
+        Dim regexkey As New Regex("^\s*([^=]*[^\s=])\s*=(.*)", (RegexOptions.Singleline Or RegexOptions.IgnoreCase))
-        ''' <summary>
+        While Not oReader.EndOfStream
-        ''' Читает значение заданного ключа в заданном разделе INI-файла.
+            Dim line As String = oReader.ReadLine()
-        ''' </summary>
+            If line <> String.Empty Then
-        ''' <param name="section">Имя раздела.</param>
+                Dim m As Match = Nothing
-        ''' <param name="key">Имя ключа.</param>
+                If regexcomment.Match(line).Success Then
-        Public Function ReadKey(ByVal section As String, ByVal key As String) As String
+                    m = regexcomment.Match(line)
-            Dim retVal As New StringBuilder(&HFF)
+                    Trace.WriteLine(String.Format("Skipping Comment: {0}", m.Groups(0).Value))
-            IniFile.GetPrivateProfileString(section, key, "", retVal, &HFF, Me.IniPath)
+                ElseIf regexsection.Match(line).Success Then
-            Return retVal.ToString()
+                    m = regexsection.Match(line)
-        End Function
+                    Trace.WriteLine(String.Format("Adding section [{0}]", m.Groups(1).Value))
-
+                    tempsection = AddSection(m.Groups(1).Value)
-        ''' <summary>
+                ElseIf regexkey.Match(line).Success AndAlso tempsection IsNot Nothing Then
-        ''' Создаёт заданный ключ в заданном разделе. Если раздел не существует, он будет создан.
+                    m = regexkey.Match(line)
-        ''' </summary>
+                    Trace.WriteLine(String.Format("Adding Key [{0}]=[{1}]", m.Groups(1).Value, m.Groups(2).Value))
-        ''' <param name="section">Имя раздела.</param>
+                    tempsection.AddKey(m.Groups(1).Value).Value = m.Groups(2).Value
-        ''' <param name="key">Имя ключа.</param>
+                ElseIf tempsection IsNot Nothing Then
-        ''' <param name="value">Значение ключа. Если NULL, то ключ будет удалён. Если String.Empty, то присвоится пустое значение.</param>
+                    '  Handle Key without value
-        Public Sub WriteKey(ByVal section As String, ByVal key As String, ByVal value As String)
+                    Trace.WriteLine(String.Format("Adding Key [{0}]", line))
-            IniFile.WritePrivateProfileString(section, key, value, Me.IniPath)
+                    tempsection.AddKey(line)
+                Else
+                    '  This should not occur unless the tempsection is not created yet...
+                    Trace.WriteLine(String.Format("Skipping unknown type of data: {0}", line))
+                End If
+            End If
+        End While
+        oReader.Close()
     End Sub
 
-        ''' <summary>
+    ' Used to save the data back to the file or your choice
-        ''' Удаляет заданный ключ из заданного раздела INI-файла.
+    Public Sub Save(ByVal sFileName As String)
-        ''' </summary>
+        Dim oWriter As New StreamWriter(sFileName, False)
-        ''' <param name="section">Имя раздела.</param>
+        For Each s As IniSection In Sections
-        ''' <param name="key">Имя ключа.</param>
+            Trace.WriteLine(String.Format("Writing Section: [{0}]", s.Name))
-        Public Sub DeleteKey(ByVal section As String, ByVal key As String)
+            oWriter.WriteLine(String.Format("[{0}]", s.Name))
-            Me.WriteKey(section, key, Nothing)
+            For Each k As IniSection.IniKey In s.Keys
+                If k.Value <> String.Empty Then
+                    Trace.WriteLine(String.Format("Writing Key: {0}={1}", k.Name, k.Value))
+                    oWriter.WriteLine(String.Format("{0}={1}", k.Name, k.Value))
+                Else
+                    Trace.WriteLine(String.Format("Writing Key: {0}", k.Name))
+                    oWriter.WriteLine(String.Format("{0}", k.Name))
+                End If
+            Next
+        Next
+        oWriter.Close()
     End Sub
 
-        ''' <summary>
+    ' Gets all the sections
-        ''' Удаляет заданный раздел INI-файла.
+    Public ReadOnly Property Sections() As System.Collections.ICollection
-        ''' </summary>
+        Get
-        ''' <param name="section">Имя раздела.</param>
+            Return m_sections.Values
-        Public Sub DeleteSection(ByVal section As String)
+        End Get
-            Me.WriteKey(section, Nothing, Nothing)
+    End Property
+
+    ' Adds a section to the IniFile object, returns a IniSection object to the new or existing object
+    Public Function AddSection(ByVal sSection As String) As IniSection
+        Dim s As IniSection = Nothing
+        sSection = sSection.Trim()
+        ' Trim spaces
+        If m_sections.ContainsKey(sSection) Then
+            s = DirectCast(m_sections(sSection), IniSection)
+        Else
+            s = New IniSection(Me, sSection)
+            m_sections(sSection) = s
+        End If
+        Return s
+    End Function
+
+    ' Removes a section by its name sSection, returns trus on success
+    Public Function RemoveSection(ByVal sSection As String) As Boolean
+        sSection = sSection.Trim()
+        Return RemoveSection(GetSection(sSection))
+    End Function
+
+    ' Removes section by object, returns trus on success
+    Public Function RemoveSection(ByVal Section As IniSection) As Boolean
+        If Section IsNot Nothing Then
+            Try
+                m_sections.Remove(Section.Name)
+                Return True
+            Catch ex As Exception
+                Trace.WriteLine(ex.Message)
+            End Try
+        End If
+        Return False
+    End Function
+
+    '  Removes all existing sections, returns trus on success
+    Public Function RemoveAllSections() As Boolean
+        m_sections.Clear()
+        Return (m_sections.Count = 0)
+    End Function
+
+    ' Returns an IniSection to the section by name, NULL if it was not found
+    Public Function GetSection(ByVal sSection As String) As IniSection
+        sSection = sSection.Trim()
+        ' Trim spaces
+        If m_sections.ContainsKey(sSection) Then
+            Return DirectCast(m_sections(sSection), IniSection)
+        End If
+        Return Nothing
+    End Function
+
+    '  Returns a KeyValue in a certain section
+    Public Function GetKeyValue(ByVal sSection As String, ByVal sKey As String) As String
+        Dim s As IniSection = GetSection(sSection)
+        If s IsNot Nothing Then
+            Dim k As IniSection.IniKey = s.GetKey(sKey)
+            If k IsNot Nothing Then
+                Return k.Value
+            End If
+        End If
+        Return String.Empty
+    End Function
+
+    ' Sets a KeyValuePair in a certain section
+    Public Function SetKeyValue(ByVal sSection As String, ByVal sKey As String, ByVal sValue As String) As Boolean
+        Dim s As IniSection = AddSection(sSection)
+        If s IsNot Nothing Then
+            Dim k As IniSection.IniKey = s.AddKey(sKey)
+            If k IsNot Nothing Then
+                k.Value = sValue
+                Return True
+            End If
+        End If
+        Return False
+    End Function
+
+    ' Renames an existing section returns true on success, false if the section didn't exist or there was another section with the same sNewSection
+    Public Function RenameSection(ByVal sSection As String, ByVal sNewSection As String) As Boolean
+        '  Note string trims are done in lower calls.
+        Dim bRval As Boolean = False
+        Dim s As IniSection = GetSection(sSection)
+        If s IsNot Nothing Then
+            bRval = s.SetName(sNewSection)
+        End If
+        Return bRval
+    End Function
+
+    ' Renames an existing key returns true on success, false if the key didn't exist or there was another section with the same sNewKey
+    Public Function RenameKey(ByVal sSection As String, ByVal sKey As String, ByVal sNewKey As String) As Boolean
+        '  Note string trims are done in lower calls.
+        Dim s As IniSection = GetSection(sSection)
+        If s IsNot Nothing Then
+            Dim k As IniSection.IniKey = s.GetKey(sKey)
+            If k IsNot Nothing Then
+                Return k.SetName(sNewKey)
+            End If
+        End If
+        Return False
+    End Function
+
+    ' Remove a key by section name and key name
+    Public Function RemoveKey(ByVal sSection As String, ByVal sKey As String) As Boolean
+        Dim s As IniSection = GetSection(sSection)
+        If s IsNot Nothing Then
+            Return s.RemoveKey(sKey)
+        End If
+        Return False
+    End Function
+
+    ' IniSection class 
+    Public Class IniSection
+        '  IniFile IniFile object instance
+        Private m_pIniFile As IniFile
+        '  Name of the section
+        Private m_sSection As String
+        '  List of IniKeys in the section
+        Private m_keys As Hashtable
+
+        ' Constuctor so objects are internally managed
+        Protected Friend Sub New(ByVal parent As IniFile, ByVal sSection As String)
+            m_pIniFile = parent
+            m_sSection = sSection
+            m_keys = New Hashtable(StringComparer.InvariantCultureIgnoreCase)
         End Sub
-#End Region
+
+        ' Returns all the keys in a section
+        Public ReadOnly Property Keys() As System.Collections.ICollection
+            Get
+                Return m_keys.Values
+            End Get
+        End Property
+
+        ' Returns the section name
+        Public ReadOnly Property Name() As String
+            Get
+                Return m_sSection
+            End Get
+        End Property
+
+        ' Adds a key to the IniSection object, returns a IniKey object to the new or existing object
+        Public Function AddKey(ByVal sKey As String) As IniKey
+            sKey = sKey.Trim()
+            Dim k As IniSection.IniKey = Nothing
+            If sKey.Length <> 0 Then
+                If m_keys.ContainsKey(sKey) Then
+                    k = DirectCast(m_keys(sKey), IniKey)
+                Else
+                    k = New IniSection.IniKey(Me, sKey)
+                    m_keys(sKey) = k
+                End If
+            End If
+            Return k
+        End Function
+
+        ' Removes a single key by string
+        Public Function RemoveKey(ByVal sKey As String) As Boolean
+            Return RemoveKey(GetKey(sKey))
+        End Function
+
+        ' Removes a single key by IniKey object
+        Public Function RemoveKey(ByVal Key As IniKey) As Boolean
+            If Key IsNot Nothing Then
+                Try
+                    m_keys.Remove(Key.Name)
+                    Return True
+                Catch ex As Exception
+                    Trace.WriteLine(ex.Message)
+                End Try
+            End If
+            Return False
+        End Function
+
+        ' Removes all the keys in the section
+        Public Function RemoveAllKeys() As Boolean
+            m_keys.Clear()
+            Return (m_keys.Count = 0)
+        End Function
+
+        ' Returns a IniKey object to the key by name, NULL if it was not found
+        Public Function GetKey(ByVal sKey As String) As IniKey
+            sKey = sKey.Trim()
+            If m_keys.ContainsKey(sKey) Then
+                Return DirectCast(m_keys(sKey), IniKey)
+            End If
+            Return Nothing
+        End Function
+
+        ' Sets the section name, returns true on success, fails if the section
+        ' name sSection already exists
+        Public Function SetName(ByVal sSection As String) As Boolean
+            sSection = sSection.Trim()
+            If sSection.Length <> 0 Then
+                ' Get existing section if it even exists...
+                Dim s As IniSection = m_pIniFile.GetSection(sSection)
+                If s IsNot Me AndAlso s IsNot Nothing Then
+                    Return False
+                End If
+                Try
+                    ' Remove the current section
+                    m_pIniFile.m_sections.Remove(m_sSection)
+                    ' Set the new section name to this object
+                    m_pIniFile.m_sections(sSection) = Me
+                    ' Set the new section name
+                    m_sSection = sSection
+                    Return True
+                Catch ex As Exception
+                    Trace.WriteLine(ex.Message)
+                End Try
+            End If
+            Return False
+        End Function
+
+        ' Returns the section name
+        Public Function GetName() As String
+            Return m_sSection
+        End Function
+
+        ' IniKey class
+        Public Class IniKey
+            '  Name of the Key
+            Private m_sKey As String
+            '  Value associated
+            Private m_sValue As String
+            '  Pointer to the parent CIniSection
+            Private m_section As IniSection
+
+            ' Constuctor so objects are internally managed
+            Protected Friend Sub New(ByVal parent As IniSection, ByVal sKey As String)
+                m_section = parent
+                m_sKey = sKey
+            End Sub
+
+            ' Returns the name of the Key
+            Public ReadOnly Property Name() As String
+                Get
+                    Return m_sKey
+                End Get
+            End Property
+
+            ' Sets or Gets the value of the key
+            Public Property Value() As String
+                Get
+                    Return m_sValue
+                End Get
+                Set(ByVal value As String)
+                    m_sValue = value
+                End Set
+            End Property
+
+            ' Sets the value of the key
+            Public Sub SetValue(ByVal sValue As String)
+                m_sValue = sValue
+            End Sub
+            ' Returns the value of the Key
+            Public Function GetValue() As String
+                Return m_sValue
+            End Function
+
+            ' Sets the key name
+            ' Returns true on success, fails if the section name sKey already exists
+            Public Function SetName(ByVal sKey As String) As Boolean
+                sKey = sKey.Trim()
+                If sKey.Length <> 0 Then
+                    Dim k As IniKey = m_section.GetKey(sKey)
+                    If k IsNot Me AndAlso k IsNot Nothing Then
+                        Return False
+                    End If
+                    Try
+                        ' Remove the current key
+                        m_section.m_keys.Remove(m_sKey)
+                        ' Set the new key name to this object
+                        m_section.m_keys(sKey) = Me
+                        ' Set the new key name
+                        m_sKey = sKey
+                        Return True
+                    Catch ex As Exception
+                        Trace.WriteLine(ex.Message)
+                    End Try
+                End If
+                Return False
+            End Function
+
+            ' Returns the name of the Key
+            Public Function GetName() As String
+                Return m_sKey
+            End Function
+        End Class
+        ' End of IniKey class
+    End Class
+    ' End of IniSection class
 End Class
-End Namespace
+' End of IniFile class

LVNC-RS/LVNC-RS.vbproj

@@ -91,7 +91,6 @@
     <Import Include="System.Xml.Linq" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="IniFile.vb" />
     <Compile Include="frmLVNC-RS-Main.vb">
       <SubType>Form</SubType>
     </Compile>
@@ -99,6 +98,7 @@
       <DependentUpon>frmLVNC-RS-Main.vb</DependentUpon>
       <SubType>Form</SubType>
     </Compile>
+    <Compile Include="iniFile.vb" />
     <Compile Include="My Project\AssemblyInfo.vb" />
     <Compile Include="My Project\Application.Designer.vb">
       <AutoGen>True</AutoGen>

LVNC-RS/Services.vb

@@ -1,13 +1,13 @@
 Module Services
     Private sRunTimeDir As String = getRunTimeDir() & "\LVNC-RS"
-    Private oConfigFile As New Ini.IniFile(sRunTimeDir & "\lvnc-rs.ini")
+    Private oConfigFile As New IniFile
 
     Public sSupportID As String = String.Empty
     Public sSupportPasswd As String = String.Empty
     Public byProxyStatus As Byte = 0
 
-    Public sProxyHost As String = oConfigFile.ReadKey("repeater", "host")
+    Public sProxyHost As String = String.Empty
-    Public sProxyPort As String = oConfigFile.ReadKey("repeater", "serverport")
+    Public sProxyPort As String = String.Empty
 
     Private aExecResources(,) As String = {
         {"lvnc_rs_ini", "\lvnc_rs.ini"},
@@ -73,6 +73,10 @@
                 End Using
             Next
         End With
+
+        oConfigFile.Load(sRunTimeDir & "\lvnc_rs.ini")
+        sProxyHost = oConfigFile.GetKeyValue("repeater", "host")
+        sProxyPort = oConfigFile.GetKeyValue("repeater", "serverport")
     End Sub
 
     Public Sub getSupportID()