Added provider field and exception handling for incorrect BIN database.

Author: ip2location-com

IP2ProxyHTTPModule/IP2ProxyHTTPModule/IP2Proxy.vb

@@ -8,15 +8,13 @@
 ' URL          : http://www.ip2location.com
 ' Email        : sales@ip2location.com
 '
-' Copyright (c) 2002-2020 IP2Location.com
+' Copyright (c) 2002-2021 IP2Location.com
 '
 '---------------------------------------------------------------------------
 
-Imports System
 Imports System.IO
 Imports System.Text.RegularExpressions
 Imports System.Web
-Imports System.Xml
 Imports System.Xml.Serialization
 
 Public Class HTTPModule : Implements IHttpModule
@@ -28,29 +26,23 @@ Public Class HTTPModule : Implements IHttpModule
     Private baseDir As String = ""
     Public whitespace As Regex
     Public proxyDatabasePath As String = ""
-    Private version As String = "2.3" 'follow the IP2Proxy version
+    Private version As String = "3.1"
 
     Public Sub Dispose() Implements System.Web.IHttpModule.Dispose
         LogDebug.WriteLog("Exiting IP2Proxy HTTP Module")
-
-        If Not proxy Is Nothing Then
-            proxy = Nothing
-        End If
-
-        If Not config Is Nothing Then
-            config = Nothing
-        End If
+        proxy = Nothing
+        config = Nothing
     End Sub
 
     Public Sub Init(context As System.Web.HttpApplication) Implements System.Web.IHttpModule.Init
         Dim mydirectory As String = ""
 
         globalConfig = Environment.GetEnvironmentVariable("IP2ProxyHTTPModuleConfig")
-        If Not globalConfig Is Nothing Then 'server level mode
+        If globalConfig IsNot Nothing Then 'server level mode
             LogDebug.WriteLog("Global config: " & globalConfig)
             mydirectory = globalConfig
             If Not mydirectory.EndsWith("\") Then
-                mydirectory = mydirectory & "\"
+                mydirectory &= "\"
             End If
         Else 'website level mode
             baseDir = AppDomain.CurrentDomain.BaseDirectory
@@ -61,12 +53,10 @@ Public Class HTTPModule : Implements IHttpModule
             LogDebug.WriteLog("Starting IP2Proxy HTTP Module " & version)
             whitespace = New Regex("\s")
 
-            'CreateConfig(mydirectory & configFile) ' for testing only
-
             config = ReadConfig(mydirectory & configFile)
 
             'Set BIN file path
-            If Not globalConfig Is Nothing Then
+            If globalConfig IsNot Nothing Then
                 proxyDatabasePath = config.Settings.BINFile 'global BIN is always full path 
             Else
                 proxyDatabasePath = baseDir & config.Settings.BINFile 'website BIN is always relative to website root folder
@@ -86,18 +76,15 @@ Public Class HTTPModule : Implements IHttpModule
         Dim app As HttpApplication = DirectCast(sender, HttpApplication)
         Dim request As HttpRequest = app.Context.Request
         Dim response As HttpResponse = app.Context.Response
-        Dim myIP As String = ""
         Dim myurl As String = request.Url.AbsoluteUri
 
+        Dim myIP As String
         If config.Settings.CustomIPServerVariable.Trim <> "" Then
             myIP = request.ServerVariables.Item(config.Settings.CustomIPServerVariable.Trim)
         Else
             myIP = request.UserHostAddress
         End If
 
-        ' debug only
-        'myIP = "8.8.8.8"
-
         ' output extra info so we know it is working
         LogDebug.WriteLog("Querying IP: " & myIP)
         result = proxy.GetAll(myIP)
@@ -117,44 +104,18 @@ Public Class HTTPModule : Implements IHttpModule
         request.ServerVariables.Item("HTTP_X_IP2PROXY_AS") = result.AS
         request.ServerVariables.Item("HTTP_X_IP2PROXY_LAST_SEEN") = result.Last_Seen
         request.ServerVariables.Item("HTTP_X_IP2PROXY_THREAT") = result.Threat
+        request.ServerVariables.Item("HTTP_X_IP2PROXY_PROVIDER") = result.Provider
     End Sub
 
-    ''USING THIS FOR TESTING AND GENERATING A CONFIG FILE TEMPLATE
-    'Private Sub CreateConfig(ByVal filename As String)
-    '    ' Create an instance of the XmlSerializer class; 
-    '    ' specify the type of object to serialize. 
-    '    Dim serializer As New XmlSerializer(GetType(IP2ProxyConfig))
-    '    Dim writer As New StreamWriter(filename)
-    '    Dim config As New IP2ProxyConfig()
-
-    '    Dim mydirectory As String = "bin\"
-    '    Dim mybin As String = mydirectory & "IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL.BIN"
-    '    Dim mycustomipservervariable As String = ""
-
-    '    'SETTINGS OBJECT
-    '    Dim mysettings As New Settings
-    '    mysettings.BINFile = mybin
-    '    mysettings.CustomIPServerVariable = mycustomipservervariable
-
-    '    'attach to config
-    '    config.Settings = mysettings
-
-    '    serializer.Serialize(writer, config)
-    '    writer.Close()
-    'End Sub
-
     Private Function ReadConfig(ByVal filename As String) As IP2ProxyConfig
         ' Create an instance of the XmlSerializer class; 
         ' specify the type of object to be deserialized. 
         Dim serializer As New XmlSerializer(GetType(IP2ProxyConfig))
         ' If the XML document has been altered with unknown 
         ' nodes or attributes, handle them with the 
         ' UnknownNode and UnknownAttribute events. 
-        AddHandler serializer.UnknownNode, AddressOf serializer_UnknownNode
-        AddHandler serializer.UnknownAttribute, AddressOf serializer_UnknownAttribute
-
-        ' A FileStream is needed to read the XML document. 
-        'Dim fs As FileStream = Nothing
+        AddHandler serializer.UnknownNode, AddressOf SerializerUnknownNode
+        AddHandler serializer.UnknownAttribute, AddressOf SerializerUnknownAttribute
 
         ' All these just to make sure XML is following our case sensitivity.
         Dim line As String
@@ -183,40 +144,34 @@ Public Class HTTPModule : Implements IHttpModule
                 line = Regex.Replace(line, elem, "$1" & elem2 & "$3", RegexOptions.IgnoreCase)
             Next
 
-            'fs = New FileStream(filename, FileMode.Open)
             ' Declare an object variable of the type to be deserialized. 
             Dim config As IP2ProxyConfig
+
             ' Use the Deserialize method to restore the object's state with 
             ' data from the XML document.
-            'config = CType(serializer.Deserialize(fs), IP2LocationConfig)
-
             sr2 = New StringReader(line)
 
             config = CType(serializer.Deserialize(sr2), IP2ProxyConfig)
 
             Return config
         Catch ex As Exception
-            'LogDebug.WriteLog(ex.Message & vbNewLine & ex.StackTrace)
             LogDebug.WriteLog(ex.Message)
             Throw 'special case so need to throw here to stop the main process
         Finally
-            'If Not fs Is Nothing Then
-            '    fs.Close()
-            'End If
-            If Not sr2 Is Nothing Then
+            If sr2 IsNot Nothing Then
                 sr2.Close()
             End If
         End Try
     End Function
 
-    Private Sub serializer_UnknownNode(sender As Object, e As XmlNodeEventArgs)
+    Private Sub SerializerUnknownNode(sender As Object, e As XmlNodeEventArgs)
         LogDebug.WriteLog("Unknown Node:" & e.Name & vbTab & e.Text)
-    End Sub 'serializer_UnknownNode
+    End Sub
 
 
-    Private Sub serializer_UnknownAttribute(sender As Object, e As XmlAttributeEventArgs)
-        Dim attr As System.Xml.XmlAttribute = e.Attr
+    Private Sub SerializerUnknownAttribute(sender As Object, e As XmlAttributeEventArgs)
+        Dim attr As Xml.XmlAttribute = e.Attr
         LogDebug.WriteLog("Unknown attribute " & attr.Name & "='" & attr.Value & "'")
-    End Sub 'serializer_UnknownAttribute
+    End Sub
 
 End Class

IP2ProxyHTTPModule/IP2ProxyHTTPModule/IP2ProxyHTTPModule.vb

@@ -3,14 +3,14 @@
 ' URL          : http://www.ip2location.com
 ' Email        : sales@ip2location.com
 '
-' Copyright (c) 2002-2020 IP2Location.com
+' Copyright (c) 2002-2021 IP2Location.com
 '---------------------------------------------------------------------------
 
 Imports System.IO
 
 Public Class LogDebug
     Public Shared Sub WriteLog(ByVal mymesg As String)
-        Dim myfilename As String = System.AppDomain.CurrentDomain.BaseDirectory & "ip2proxy_errLog.txt"
+        Dim myfilename As String = AppDomain.CurrentDomain.BaseDirectory & "ip2proxy_errLog.txt"
         Dim fs As FileStream = Nothing
         Dim objWriter As StreamWriter = Nothing
 
@@ -22,10 +22,10 @@ Public Class LogDebug
             Catch ex As Exception
                 'just fail silently
             Finally
-                If Not objWriter Is Nothing Then
+                If objWriter IsNot Nothing Then
                     objWriter.Close()
                 End If
-                If Not fs Is Nothing Then
+                If fs IsNot Nothing Then
                     fs.Close()
                 End If
             End Try

IP2ProxyHTTPModule/IP2ProxyHTTPModule/LogDebug.vb

@@ -12,7 +12,7 @@ Imports System.Runtime.InteropServices
 <Assembly: AssemblyDescription("")> 
 <Assembly: AssemblyCompany("IP2Location.com")> 
 <Assembly: AssemblyProduct("IP2ProxyHTTPModule")>
-<Assembly: AssemblyCopyright("Copyright ©  2020")>
+<Assembly: AssemblyCopyright("Copyright ©  2021")>
 <Assembly: AssemblyTrademark("")> 
 
 <Assembly: ComVisible(False)>
@@ -31,5 +31,5 @@ Imports System.Runtime.InteropServices
 ' by using the '*' as shown below:
 ' <Assembly: AssemblyVersion("1.0.*")> 
 
-<Assembly: AssemblyVersion("3.0.0.0")>
-<Assembly: AssemblyFileVersion("3.0.0.0")>
+<Assembly: AssemblyVersion("3.1.0.0")>
+<Assembly: AssemblyFileVersion("3.1.0.0")>

IP2ProxyHTTPModule/IP2ProxyHTTPModule/My Project/AssemblyInfo.vb

@@ -3,23 +3,22 @@
 ' URL          : http://www.ip2location.com
 ' Email        : sales@ip2location.com
 '
-' Copyright (c) 2002-2020 IP2Location.com
+' Copyright (c) 2002-2021 IP2Location.com
 '---------------------------------------------------------------------------
 
-Imports System.Xml
 Imports System.Xml.Serialization
 
-'NOTE: The XMLRootAttribute and XMLElement are for renaming the XML output tags.
+'NOTE: The XMLRoot and XMLElement are for renaming the XML output tags.
 
-<XmlRootAttribute("IP2Proxy_Configuration")> _
+<XmlRoot("IP2Proxy_Configuration")>
 Public Class IP2ProxyConfig
     Public Settings As Settings
 End Class
 
 Public Class Settings
-    <XmlElement("BIN_File")> _
+    <XmlElement("BIN_File")>
     Public BINFile As String
 
-    <XmlElement("Custom_IP_Server_Variable")> _
+    <XmlElement("Custom_IP_Server_Variable")>
     Public CustomIPServerVariable As String
 End Class

IP2ProxyHTTPModule/IP2ProxyHTTPModule/XML.vb

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 IP2Location.com
+Copyright (c) 2021 IP2Location.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

IP2ProxyHTTPModule/IP2ProxyHTTPModule/merged/IP2ProxyHTTPModule.dll

@@ -134,6 +134,7 @@ Below are the server variables set by the IP2Proxy HTTP Module. You can use any
 |HTTP_X_IP2PROXY_AS|Autonomous system name of the proxy.|
 |HTTP_X_IP2PROXY_LAST_SEEN|Number of days that the proxy was last seen.|
 |HTTP_X_IP2PROXY_THREAT|Threat type of the proxy.|
+|HTTP_X_IP2PROXY_PROVIDER|Provider of the proxy.|
 
 ___
 
@@ -157,6 +158,7 @@ Private Sub ShowServerVariable()
     Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_AS") & "<br>")
     Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_LAST_SEEN") & "<br>")
     Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_THREAT") & "<br>")
+    Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_PROVIDER") & "<br>")
 End Sub
 ```
 
@@ -179,6 +181,7 @@ private void ShowServerVariable()
    Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_AS") + "\n");
    Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_LAST_SEEN") + "\n");
    Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_THREAT") + "\n");
+   Response.Write(Request.ServerVariables("HTTP_X_IP2PROXY_PROVIDER") + "\n");
 }
 ```
 
@@ -204,6 +207,7 @@ private void ShowServerVariable()
     <%=Request.ServerVariables("HTTP_X_IP2PROXY_AS") & "<br>"%>
     <%=Request.ServerVariables("HTTP_X_IP2PROXY_LAST_SEEN") & "<br>"%>
     <%=Request.ServerVariables("HTTP_X_IP2PROXY_THREAT") & "<br>"%>
+    <%=Request.ServerVariables("HTTP_X_IP2PROXY_PROVIDER") & "<br>"%>
 </body>
 </html>
 ```
@@ -231,6 +235,7 @@ private void ShowServerVariable()
     echo $_SERVER['HTTP_X_IP2PROXY_AS'] . "<br>";
     echo $_SERVER['HTTP_X_IP2PROXY_LAST_SEEN'] . "<br>";
     echo $_SERVER['HTTP_X_IP2PROXY_THREAT'] . "<br>";
+    echo $_SERVER['HTTP_X_IP2PROXY_PROVIDER'] . "<br>";
 ?>
 </body>
 </html>