]>
Commit | Line | Data |
---|---|---|
1 | #!/usr/bin/perl -w | |
2 | ############################################################################### | |
3 | # # | |
4 | # IPFire.org - A linux based firewall # | |
5 | # Copyright (C) 2007-2020 IPFire Team <info@ipfire.org> # | |
6 | # # | |
7 | # This program is free software: you can redistribute it and/or modify # | |
8 | # it under the terms of the GNU General Public License as published by # | |
9 | # the Free Software Foundation, either version 2 of the License, or # | |
10 | # (at your option) any later version. # | |
11 | # # | |
12 | # This program is distributed in the hope that it will be useful, # | |
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of # | |
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # | |
15 | # GNU General Public License for more details. # | |
16 | # # | |
17 | # You should have received a copy of the GNU General Public License # | |
18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. # | |
19 | # # | |
20 | ############################################################################### | |
21 | ||
22 | package Location::Functions; | |
23 | ||
24 | use Location; | |
25 | ||
26 | # Hash which contains country codes and their names which are special or not | |
27 | # part of ISO 3166-1. | |
28 | my %not_iso_3166_location = ( | |
29 | "A1" => "Anonymous Proxy", | |
30 | "A2" => "Satellite Provider", | |
31 | "A3" => "Worldwide Anycast Instance", | |
32 | ); | |
33 | ||
34 | # Hash which contains possible network flags and their mapped location codes. | |
35 | my %network_flags = ( | |
36 | "LOC_NETWORK_FLAG_ANONYMOUS_PROXY" => "A1", | |
37 | "LOC_NETWORK_FLAG_SATELLITE_PROVIDER" => "A2", | |
38 | "LOC_NETWORK_FLAG_ANYCAST" => "A3", | |
39 | ); | |
40 | ||
41 | # Array which contains special country codes. | |
42 | my @special_locations = ( "A1", "A2", "A3" ); | |
43 | ||
44 | # Directory where the libloc database and keyfile lives. | |
45 | our $location_dir = "/var/lib/location/"; | |
46 | ||
47 | # Libloc database file. | |
48 | our $database = "$location_dir/database.db"; | |
49 | ||
50 | # Libloc keyfile to verify the database. | |
51 | our $keyfile = "$location_dir/signing-key.pem"; | |
52 | ||
53 | # Directory which contains the exported databases. | |
54 | our $xt_geoip_db_directory = "/usr/share/xt_geoip/"; | |
55 | ||
56 | # Create libloc database handle. | |
57 | my $db_handle = &init(); | |
58 | ||
59 | # | |
60 | ## Tiny function to init the location database. | |
61 | # | |
62 | sub init () { | |
63 | # Init and open the database. | |
64 | my $db = &Location::init($database); | |
65 | ||
66 | # Return the database handle. | |
67 | return $db; | |
68 | } | |
69 | ||
70 | # | |
71 | ## Function to verify the integrity of the location database. | |
72 | # | |
73 | sub verify ($) { | |
74 | my ($db_handle) = @_; | |
75 | ||
76 | # Verify the integrity of the database. | |
77 | if(&Location::verify($db_handle, $keyfile)) { | |
78 | # Success, return "1". | |
79 | return 1; | |
80 | } | |
81 | ||
82 | # If we got here, return nothing. | |
83 | return; | |
84 | } | |
85 | ||
86 | # | |
87 | ## Function to get the country code of a given address. | |
88 | # | |
89 | sub lookup_country_code($$) { | |
90 | my ($address) = @_; | |
91 | ||
92 | # Lookup the given address. | |
93 | my $country_code = &Location::lookup_country_code($db_handle, $address); | |
94 | ||
95 | # Return the name of the country | |
96 | return $country_code; | |
97 | } | |
98 | ||
99 | # Function to get the flag icon for a specified country code. | |
100 | sub get_flag_icon($) { | |
101 | my ($input) = @_; | |
102 | ||
103 | # Webserver's root dir. (Required for generating full path) | |
104 | my $webroot = "/srv/web/ipfire/html"; | |
105 | ||
106 | # Directory which contains the flag icons. | |
107 | my $flagdir = "/images/flags"; | |
108 | ||
109 | # File extension of the country flags. | |
110 | my $ext = "png"; | |
111 | ||
112 | # Remove whitespaces. | |
113 | chomp($input); | |
114 | ||
115 | # Convert given country code to upper case. | |
116 | my $ccode = uc($input); | |
117 | ||
118 | # Generate filename, based on the contry code in lower case | |
119 | # and the defined file extension. | |
120 | my $file = join('.', $ccode,$ext); | |
121 | ||
122 | # Generate path inside webroot to the previously generated file. | |
123 | my $flag_icon = join('/', $flagdir,$file); | |
124 | ||
125 | # Generate absolute path to the icon file. | |
126 | my $absolute_path = join('', $webroot,$flag_icon); | |
127 | ||
128 | # Check if the a icon file exists. | |
129 | if (-e "$absolute_path") { | |
130 | # Return content of flag_icon. | |
131 | return $flag_icon; | |
132 | } else { | |
133 | # If no icon for the specified country exists, try to use | |
134 | # the icon for "unknown". | |
135 | my $ccode = "unknown"; | |
136 | ||
137 | # Redoing all the stuff from above for the "unknown" icon. | |
138 | my $file = join('.', $ccode, $ext); | |
139 | my $flag_icon = join('/', $flagdir, $file); | |
140 | my $absolute_path = join('', $webroot, $flag_icon); | |
141 | ||
142 | # Check if the icon is present. | |
143 | if (-e "$absolute_path") { | |
144 | # Return "unknown" icon. | |
145 | return $flag_icon; | |
146 | } | |
147 | } | |
148 | } | |
149 | ||
150 | # Function to get the county name by a given country code. | |
151 | sub get_full_country_name($) { | |
152 | my ($input) = @_; | |
153 | my $name; | |
154 | ||
155 | # Remove whitespaces. | |
156 | chomp($input); | |
157 | ||
158 | # Convert input into upper case format. | |
159 | my $code = uc($input); | |
160 | ||
161 | # Handle country codes which are special or not part of the list. | |
162 | if ($not_iso_3166_location{$code}) { | |
163 | # Grab location name from hash. | |
164 | $name = $not_iso_3166_location{$code}; | |
165 | } else { | |
166 | # Get the country name by using the location module. | |
167 | $name = &Location::get_country_name($db_handle, $code); | |
168 | } | |
169 | ||
170 | return $name; | |
171 | } | |
172 | ||
173 | # Function to get all available locations. | |
174 | sub get_locations() { | |
175 | my ($mode) = @_; | |
176 | ||
177 | # Set default mode to add_special_locations. | |
178 | $mode = $mode ? $mode : "add_special_locations"; | |
179 | ||
180 | # Get locations which are stored in the location database. | |
181 | my @locations = &Location::database_countries($db_handle); | |
182 | ||
183 | # Check if the special locations should be added. | |
184 | if ($mode ne "no_special_locations") { | |
185 | # Merge special locations array and the database locations array. | |
186 | @locations = (@special_locations, @locations); | |
187 | } | |
188 | ||
189 | # Sort locations array in alphabetical order. | |
190 | my @sorted_locations = sort(@locations); | |
191 | ||
192 | # Return the array. | |
193 | return @sorted_locations; | |
194 | } | |
195 | ||
196 | # Function to get the continent code of a given country code. | |
197 | sub get_continent_code($) { | |
198 | my ($country_code) = @_; | |
199 | ||
200 | # Use location module to grab the continent code. | |
201 | my $continent_code = &Location::get_continent_code($db_handle, $country_code); | |
202 | ||
203 | return $continent_code; | |
204 | } | |
205 | ||
206 | # Function to check if a given address has one ore more special flags. | |
207 | sub address_has_flags($) { | |
208 | my ($address) = @_; | |
209 | ||
210 | # Array to store the flags of the address. | |
211 | my @flags; | |
212 | ||
213 | # Loop through the hash of possible network flags. | |
214 | foreach my $flag (keys(%network_flags)) { | |
215 | # Check if the address has the current flag. | |
216 | if (&Location::lookup_network_has_flag($db_handle, $address, $flag)) { | |
217 | # The given address has the requested flag. | |
218 | # | |
219 | # Grab the mapped location code for this flag. | |
220 | $mapped_code = $network_flags{$flag}; | |
221 | ||
222 | # Add the mapped code to the array of flags. | |
223 | push(@flags, $mapped_code); | |
224 | } | |
225 | } | |
226 | ||
227 | # Sort the array of flags. | |
228 | @flags = sort(@flags); | |
229 | ||
230 | # Return the array of flags. | |
231 | return @flags; | |
232 | } | |
233 | ||
234 | # | |
235 | ## Function to get the Autonomous System Number of a given address. | |
236 | # | |
237 | sub lookup_asn($) { | |
238 | my ($address) = @_; | |
239 | ||
240 | # Lookup the given address. | |
241 | my $asn = &Location::lookup_asn($db_handle, $address); | |
242 | ||
243 | # Return the number of the Autonomous System | |
244 | return $asn; | |
245 | } | |
246 | ||
247 | # | |
248 | ## Function to get the name of an Autonomous System. | |
249 | # | |
250 | sub get_as_name($) { | |
251 | my ($asn) = @_; | |
252 | ||
253 | # Fetch the name of this AS... | |
254 | my $as_name = &Location::get_as_name($db_handle, $asn); | |
255 | ||
256 | # Return the name of the Autonomous System | |
257 | return $as_name; | |
258 | } | |
259 | ||
260 | # Custom END declaration which will be executed when perl | |
261 | # ends, to release the database handle to libloc. | |
262 | END { | |
263 | # Check if a database handle exists. | |
264 | if ($db_handle) { | |
265 | # Destroy libloc database handle. | |
266 | &Location::DESTROY($db_handle); | |
267 | } | |
268 | } | |
269 | ||
270 | 1; |